Use the application walkthrough for a first integration. The tables below list the current Swagger routes, inputs and success schemas. All application and bulk routes require bearer authentication.
Creation and updates
Save customer and application IDs from each response. Application creation returns a JSON GUID string; customer creation returns UserResponse. sendLink is optional and defaults to false. Enabling it or calling send-application-link requests a customer notification.
Supply either businessZip or extraInformation.zipcode, never both in one create request. Additional information values are strings, including years. The combined customer-and-application route is deprecated; new integrations should use the separate steps or the appropriate applicant variant.
The combined applicant route also requires extraInformation.ssn. Validate the complete identity data against the selected request model. Do not reuse a minimal customer-and-application payload for applicant variants.
Application process and update routes that use GET perform work; use status reads for polling. application-offer accepts an optional force query parameter; leave it at its default unless your integration needs that behavior.
Banking and documents
Banking data uses a JSON BankingDataRequest, with optional bankName in the query. Supply bank accounts and meaningful transaction history. Bank statement files use a JSON base64 string plus fileName in the query; see uploads.
Bulk operations
Bulk routes take a top-level JSON array. Their validators differ from individual-create validators: bulk customer names are capped at 30 characters; bulk applications require a business name of at most 30 characters and non-empty extra information. Do not assume atomicity or retry an entire batch after an uncertain result.
Endpoint reference
Success types below come from Swagger. “Not specified” means no body schema is declared; it does not guarantee an empty body. The current bank-statement upload and cancellation handlers return true on success.
| Method | Route | Inputs | Swagger success |
|---|---|---|---|
POST | /api/Application/create-customer-and-application (deprecated) | query: sendLink; body: body — ApplicationAndCustomerRequest (required) | 200: ApplicationCustomerResponse |
POST | /api/Application/send-application-link | query: applicationId | 200: Not specified |
POST | /api/Application/create-customer-and-application-and-applicant | query: sendLink; body: body — ApplicationAndCustomerAndApplicantRequest (required) | 200: ApplicationCustomerResponse |
POST | /api/Application/create-customer | body: body — UserRequest (required) | 200: UserResponse |
POST | /api/Application/create-application | query: sendLink; body: body — ApplicationRequest (required) | 200: string (uuid) |
POST | /api/Application/create-application-and-applicant | query: sendLink; body: body — ApplicationAndApplicantRequest (required) | 200: string (uuid) |
POST | /api/Application/quick-test/{applicationId} | path: applicationId (required); body: body — BankingDataRequest | 200: boolean |
POST | /api/Application/add-or-update-banking-data/{applicationId} | path: applicationId (required); query: bankName; body: body — BankingDataRequest | 200: boolean |
GET | /api/Application/process-application/{applicationId} | path: applicationId (required) | 200: string (uuid) |
GET | /api/Application/application-status/{applicationId} | path: applicationId (required) | 200: string |
GET | /api/Application/application-offer/{applicationId} | path: applicationId (required); query: force | 200: OfferResponse |
GET | /api/Application/get-customer-applications/{customerId} | path: customerId (required) | 200: Application[] |
GET | /api/Application/get-partner-applications/{partnerId} | path: partnerId (required); query: skip; query: take | 200: Application[] |
GET | /api/Application/get-application/{applicationId} | path: applicationId (required) | 200: Application |
GET | /api/Application/update-application-name/{applicationId} | path: applicationId (required); query: name | 200: boolean |
GET | /api/Application/update-application-name-and-zip-code/{applicationId} | path: applicationId (required); query: name; query: zipCode | 200: boolean |
GET | /api/Application/update-customer-data/{applicationId} | path: applicationId (required); query: firstname (required); query: lastname (required); query: address (required); query: state (required); query: city (required); query: ssn (required); query: mobile (required); query: dateOfBirth (required) | 200: boolean |
GET | /api/Application/update-application-data/{applicationId} | path: applicationId (required); query: name (required); query: zipcode (required); query: startDate (required) | 200: boolean |
POST | /api/Application/submit-bankstatement-document/{applicationId} | path: applicationId (required); query: fileName (required); body: body — string (byte) (required) | 200: Not specified |
POST | /api/Application/cancel-application/{applicationId} | path: applicationId (required) | 200: Not specified |
POST | /api/ApplicationBulk/create-customers | body: body — UserRequest[] (required) | 200: UserResponse[] |
POST | /api/ApplicationBulk/create-applications | body: body — ApplicationRequest[] (required) | 200: ApplicationResponse[] |