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
idstringOptional
borrower_idstringOptional

The borrower_id of the borrower the application belongs to

created_ondatetimeOptional
Timestamp the application object is created on
credit_typeenumOptional
The type of credit product.
decisioned_ondatetimeOptional
Timestamp when the application is either approved or rejected on
offerslist of objectsOptional
If the application is approved, an object containing the credit offer details
rejection_reasonslist of enumsOptional

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_amountintegerOptional

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_destinationstringOptional

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

lender_of_recordstringOptional
The lender of record
credit_dataobjectOptional

Errors