API ReferenceApplications

Create an application

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
borrower_idstringRequired

The borrower_id of the borrower the application is for (1-256 chars)

credit_typeenumRequired
The type of credit product.
requested_amountintegerOptional

If the borrower requests an amount in their application, the requested loan or credit line amount (in cents).

third_party_disbursement_destinationstringOptional

For credit applications of type consumer/commercial_bnpl, the third party (i.e. merchant - “Acme Co.”) is the person receiving the funds

Response

This endpoint returns an object.
statusenum
idstring or null
borrower_idstring or null

The borrower_id of the borrower the application belongs to

created_ondatetime or null
Timestamp the application object is created on
credit_typeenum or null
The type of credit product.
decisioned_ondatetime or null
Timestamp when the application is either approved or rejected on
offerslist of objects or null
If the application is approved, an object containing the credit offer details
rejection_reasonslist of enums or null

If the application is rejected, a list containing 1-4 rejection reason(s). The Rejection Reasons endpoint provides a list of valid reasons and descriptors

requested_amountinteger or null

If the borrower requests an amount in their application, the requested loan or credit line amount in cents (e.g. 500000 for $5,000)

third_party_disbursement_destinationstring or null

For credit applications of type consumer_bnpl, the third party (i.e. merchant) receiving the funds is specified here

lender_of_recordstring or null
The lender of record
credit_dataobject or null

Errors