APIs

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.

Verb	`POST`
URL	`https://api.s.unit.sh/credit-applications`
Required Scope	`credit-applications-write`
Data Type	`createOnboardingCustomerCreditApplication`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
aggregatorAccessTokens Optional	Array of string	Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	Optional. The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Optional. Number of employees of the business.
yearsInBusiness Optional	Integer	Optional. Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Optional. Object containing key-value pairs of underwriting data per credit policy.
idempotencyKey Optional	string	Optional. See Idempotency.

Relationships

Name	Type	Description
application	JSON:API Relationship	The Application for which this credit application applies to.
lendingProgram	JSON:API Relationship	The 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

Name	Type	Description
data	OnboardingCreditApplication	The 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.

Verb	`POST`
URL	`https://api.s.unit.sh/credit-applications`
Required Scope	`credit-applications-write`
Data Type	`createExistingCustomerCreditApplication`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
aggregatorAccessTokens Optional	Array of string	Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	Optional. The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Optional. Number of employees of the business.
yearsInBusiness Optional	Integer	Optional. Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Optional. Object containing key-value pairs of underwriting data per credit policy.
idempotencyKey Optional	string	Optional. See Idempotency.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The Customer for which this credit application applies to.
lendingProgram	JSON:API Relationship	The 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

Name	Type	Description
data	ExistingCustomerCreditApplication	The 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.

Verb	`PATCH`
URL	`https://api.s.unit.sh/credit-applications/:creditApplicationId`
Data Type	`patchCreditApplication`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
aggregatorAccessTokens Optional	Array of string	Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	Optional. The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Optional. Number of employees of the business.
yearsInBusiness Optional	Integer	Optional. Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Optional. 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

Name	Type	Description
data	ExistingCustomerCreditApplication / OnboardingCreditApplication	The 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.

Verb	`GET`
URL	`https://api.s.unit.sh/credit-applications/{id}`
Required Scope	`credit-applications-read`
Timeout (Seconds)	`5`

Response

Response is a JSON:API document.

200 OK

Name	Type	Description
data	ExistingCustomerCreditApplication / OnboardingCreditApplication	A 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.

Verb	`GET`
URL	`https://api.s.unit.sh/credit-applications`
Required Scope	`credit-applications-read`
Timeout (Seconds)	`5`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Optional. 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

Name	Type	Description
data	Array of ExistingCustomerCreditApplication / OnboardingCreditApplication	Array of credit application resources.

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

Create Onboarding Credit Application​

Attributes​

Relationships​

Response​

201 Created​

Create Existing Credit Application​

Attributes​

Relationships​

Response​

201 Created​

Update​

Attributes​

Response​

200 OK​

Get by Id​

Response​

200 OK​

List​

Query Parameters​

Response​

200 OK​

Create Onboarding Credit Application

Attributes

Relationships

Response

201 Created

Create Existing Credit Application

Attributes

Relationships

Response

201 Created

Update

Attributes

Response

200 OK

Get by Id

Response

200 OK

List

Query Parameters

Response

200 OK