Create Credit Application

post

https://api.thredd.com/api/v1/credit/applications

Also known as the Start Credit Application endpoint. Creates and submits a credit application for a customer. The application is created with an initial status of PENDED.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
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

productId

string

required

The unique ID of the credit product.

title

string

required

length between 1 and 5

The title of the applicant.

firstName

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.

middleName

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.

lastName

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.

nameSuffix

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: ###-##-####.

customerType

string

enum

required

The customer type of the applicant.

Allowed:

gender

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

phoneNumbers

object

required

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

employmentStatus

string

enum

required

The employment status of the applicant.

Allowed:

occupation

string

required

The occupation of the applicant.

totalAnnualIncome

integer

required

The total annual income of the applicant.

monthlyRentOrMortgage

integer

required

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

bankAccounts

string

enum

required

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

Allowed:

usCitizen

boolean

required

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

dualCitizenship

boolean

required

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

consent

boolean

required

Whether the applicant consents to submitting the application.

ipAddress

string | null

The IP address of the applicant to aid fraud detection.

employerName

string | null

The name of the employer.

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

Early Access

200Successful Response.

422Validation Error.