Submit Pre-Approved Application

Submits a pre-approved credit application for a customer. Use this endpoint for applicants who have already passed the necessary diligence checks and have been pre-approved for a line of credit. Unlike the standard Create Credit Application endpoint, this endpoint requires credit limit, cash limit, and interest rate fields to be included in the request, as these have been determined prior to submission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Early Access

Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.


Body Params
string
required

The unique ID of the credit product.

string
required
length between 1 and 5

The title of the applicant.

string
required

The first name of the applicant. For application and customer records, verification checks, correspondence, and to display on the customer's card. Maximum length is 50 characters.

string | null

The middle name of the applicant, if applicable. For application and customer records, verification checks, correspondence, and to display on the customer's card. Maximum length is 50 characters.

string
required

The last name of the applicant. For application and customer records, verification checks, correspondence, and appears on the customer's card. Maximum length is 50 characters.

string
enum
required

A suffix appended to the end of the applicant's name. For example, JR for Junior or SR for Senior.

dateOfBirth
object
required

The date of birth of the applicant.

nationalId
object
required

The national identification details of the applicant. Used for identity and verification checks, and links an applicant to their application. Note that a National ID Type of SSN requires a corresponding ID number of nine digits, in the format: ###-##-####.

string
enum
required

The customer type of the applicant.

Allowed:
string
enum
Defaults to UNKNOWN

The gender of the applicant. Defaults to UNKNOWN if not specified.

Allowed:
string
required

The primary email address of the applicant. Used for customer records and communications and notifications by email. It must be a valid email format.

residentialAddress
object
required

The address of the applicant. The country field must be a two-letter ISO 3166 alpha-2 country code. Accepted values: US. If specified, the mailing address must follow the same format as the residential address.

mailingAddress
object

The address of the applicant. The country field must be a two-letter ISO 3166 alpha-2 country code. Accepted values: US. If specified, the mailing address must follow the same format as the residential address.

phoneNumbers
object
required

Contains the phone numbers of the applicant. For use in applicant records and communication.

string
enum

Employment status of the applicant, if known.

Allowed:
string | null

The occupation of the applicant.

integer | null

The total annual income of the applicant.

integer | null

The amount that the applicant is required to pay for their monthly rent or mortgage.

string
enum

The type of bank account that the applicant holds, if any.

Allowed:
boolean | null

Whether the applicant is a U.S. Citizen (a Citizen of the United States).

boolean | null

Whether the applicant is a legal citizen of more than one country.

boolean
required
string | null

The IP address of the applicant to aid fraud detection.

integer
required

Credit limit.

integer
required

Cash advances limit.

required

Interest rate for cash advances.

required

Interest rate for purchases.

string | null

The name of the employer.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json