Skip to main content

Credit Applications

This process often involves a comprehensive evaluation of the applicant's financial stability, credit history, and the purpose of the loan.

There are different types of credit applications for applicants who are already your existing customers and for those who are not your customers yet and are in process of applying to become your customers.

For the existing customers ExistingCustomerCreditApplication should be created, once created it will automatically be moved to Pending status.

For the new customers the OnboardingCustomerCreditApplication should be used, once created it will stay in the Created status until the application for the banking services will be approved, denied or canceled.

Credit Application Statuses

The final statuses for the credit application are Approved, Denied or Canceled. Once an application is approved, a Customer resource will be created and associated with the application resource. The new created customer resources will be referenced in the relationships object.

During the application evaluation it can stay in the Pending status as long as the evaluation process is running. Once the process is complete, the status will change to either Approved, Denied and the relevant webhook event will be fired (see Pending status description below)

There is an option to Cancel Credit Application at any point before it is Approved or Denied. The status of the application will change to Canceled, and the relevant webhook event will be fired. Also if the banking application got canceled or achieved the corresponding credit application will be moved to Canceled status.

Below are all application statuses and their descriptions:

StatusDescription
CreatedThe application was created. Waiting for the original application evaluation.
PendingThe application is being evaluated.
ManualReviewThe application is being manually evaluated. This is functionally equivalent to the Pending status.
ApprovedThe application was approved and updated with the approved credit limit.
DeniedThe application was denied and updated with the deny reason.
CanceledThe application was сanceled.

Create Onboarding Credit Application

Create an onboarding credit application.

Credit Application creation requests support Idempotency, ensuring that performing multiple identical requests will have the same result as a single request.

VerbPOST
Urlhttps://api.s.unit.sh/credit-applications
Required Scopecredit-applications-write
Data TypecreateOnboardingCustomerCreditApplication
Timeout (Seconds)5

Attributes

NameTypeDescription
aggregatorAccessTokensArray of stringOptional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeInteger (Cents)Optional. The annual income of the applicant.
numberOfEmployeesNumberOfEmployeesOptional. Number of employees of the business.
yearsInBusinessIntegerOptional. Number of years the business has been in operation.
additionalUnderwritingDatajsonOptional. Object containing key-value pairs of underwriting data per credit policy.
idempotencyKeystringOptional. See Idempotency.

Relationships

NameTypeDescription
applicationJSON:API RelationshipThe Application for which this credit application applies to.
lendingProgramJSON:API RelationshipThe LendingProgram for which this credit application is related to.
Example Request:
curl -X POST 'https://api.s.unit.sh/credit-applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "createOnboardingCustomerCreditApplication",
"attributes": {},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}'

Response

Response is a JSON:API document.

201 Created

FieldTypeDescription
dataOnboardingCreditApplicationThe returned resource after the operation was completed.
Example Response:
{
"data": {
"type": "onboardingCustomerCreditApplication",
"id": "10",
"attributes": {
"createdAt": "2024-02-18T11:19:44.838Z",
"status": "Created",
"aggregatorAccessTokens": [],
"annualIncome": null,
"numberOfEmployees": null,
"yearsInBusiness": null,
"additionalUnderwritingData": null
},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}

Create Existing Credit Application

Create an existing customer credit application.

Credit Application creation requests support Idempotency, ensuring that performing multiple identical requests will have the same result as a single request.

VerbPOST
Urlhttps://api.s.unit.sh/credit-applications
Required Scopecredit-applications-write
Data TypecreateExistingCustomerCreditApplication
Timeout (Seconds)5

Attributes

NameTypeDescription
aggregatorAccessTokensArray of stringOptional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeInteger (Cents)Optional. The annual income of the applicant.
numberOfEmployeesNumberOfEmployeesOptional. Number of employees of the business.
yearsInBusinessIntegerOptional. Number of years the business has been in operation.
additionalUnderwritingDatajsonOptional. Object containing key-value pairs of underwriting data per credit policy.
idempotencyKeystringOptional. See Idempotency.

Relationships

NameTypeDescription
customerJSON:API RelationshipThe Customer for which this credit application applies to.
lendingProgramJSON:API RelationshipThe LendingProgram for which this credit application is related to.
Example Request:
curl -X POST 'https://api.s.unit.sh/credit-applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "createExistingCustomerCreditApplication",
"attributes": {
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}'

Response

Response is a JSON:API document.

201 Created

FieldTypeDescription
dataExistingCustomerCreditApplicationThe returned resource after the operation was completed.
Example Response:
{
"data": {
"type": "existingCustomerCreditApplication",
"id": "12",
"attributes": {
"createdAt": "2024-02-18T12:33:32.158Z",
"status": "Pending",
"aggregatorAccessTokens": [],
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}

Update

Update a credit application.

VerbPATCH
Urlhttps://api.s.unit.sh/credit-applications/:creditApplicationId
Data TypepatchCreditApplication
Timeout (Seconds)5

Attributes

NameTypeDescription
aggregatorAccessTokensArray of stringOptional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeInteger (Cents)Optional. The annual income of the applicant.
numberOfEmployeesNumberOfEmployeesOptional. Number of employees of the business.
yearsInBusinessIntegerOptional. Number of years the business has been in operation.
additionalUnderwritingDatajsonOptional. Object containing key-value pairs of underwriting data per credit policy.
curl -X PATCH 'https://api.s.unit.sh/credit-applications/42'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "patchCreditApplication",
"attributes": {
"numberOfEmployees": "Between2And5"
}
}
}'

Response

Response is a JSON:API document.

200 OK

FieldTypeDescription
dataExistingCustomerCreditApplication / OnboardingCreditApplicationThe requested resource after the operation was completed.
Example Response:
{
"data": {
"type": "existingCustomerCreditApplication",
"id": "12",
"attributes": {
"createdAt": "2024-02-18T12:33:32.158Z",
"status": "Pending",
"aggregatorAccessTokens": [],
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}

Get by Id

Get a dispute resource by id.

VerbGET
Urlhttps://api.s.unit.sh/credit-applications/{id}
Required Scopecredit-applications-read
Timeout (Seconds)5

Response

Response is a JSON:API document.

200 OK

FieldTypeDescription
dataExistingCustomerCreditApplication / OnboardingCreditApplicationA credit application resource.
curl -X GET 'https://api.s.unit.sh/credit-applications/42' \
-H "Authorization: Bearer ${TOKEN}"

List

List credit applications resources. Paging can be applied.

VerbGET
Urlhttps://api.s.unit.sh/credit-applications
Required Scopecredit-applications-read
Timeout (Seconds)5

Query Parameters

NameTypeDefaultDescription
page[limit]integer100Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]integer0Optional. Number of resources to skip. See Pagination.
filter[lendingProgramId]string(empty)Optional. Search resources by lending program id.
filter[orgId]string(empty)Optional. Search resources by organization id.
filter[bankId]string(empty)Optional. Search resources by bank id.
filter[applicationId]string(empty)Optional. Search resources by application id.
filter[customerId]string(empty)Optional. Search resources by customer id.

Response

Response is a JSON:API document.

200 OK

FieldTypeDescription
dataArray of ExistingCustomerCreditApplication / OnboardingCreditApplicationArray of credit application resources.
curl -X GET 'https://api.s.unit.sh/credit-applications?page[limit]=20' \
-H "Authorization: Bearer ${TOKEN}"