Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Unique key to ensure idempotent requests

Maximum string length: 255

Body

application/json

Request body for creating a new application in terminal status

status
enum<string>
required

Terminal state of the application. Possible values: approved, declined, canceled.

Available options:
approved,
declined,
canceled
entities
object
required

Entity relationships for the application. Maximum 20 entities per relationship type. Authorized signers required for commercial account holders.

details
object
required

Details for creating an application

decision
object
required

Decision-related information for the application

documents
(Disclosure · object | Consent · object)[]
required

Documents associated with the application

Document reference for creating applications and accounts.

One of displayed_at or consented_at is required depending on document type:

  • displayed_at: Required for aan, loan_agreement, loc_agreement, truth_in_lending_document, ach_authorization, notice_of_incompleteness, credit_score_notice, offer_summary, personal_guarantee, consumer_credit_auth, partner_privacy_policy, lead_privacy_policy, terms_of_use, fcra_notice, tcpa_consent, patriot_act_notice, mla_notice, pre_approval_terms, eft_authorization, prohibited_industry_certification, decision_maker_document, bo_certification, missed_payments_policy, lead_funds_transfer_agreement
  • consented_at: Required for esign_agreement, credit_pull_consent, consent_to_link_account, consent_to_link_hsa, negative_option_consent
metadata
object

Arbitrary metadata associated with the application

Response

Application created successfully.

An application object representing a credit application

id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

client_application_id
string
read-only

Client-provided identifier for the application. Optional: present only for applications created via file upload, and omitted for applications created through the API, which are identified solely by their server-generated ID.

created_at
string<date-time>

Lead server-generated ISO 8601 timestamp when the application was created.

updated_at
string<date-time>

Lead server-generated ISO 8601 timestamp when the application was last updated.

status
enum<string>

Terminal state of the application. Possible values: approved, declined, canceled.

Available options:
approved,
declined,
canceled
entities
object
read-only

Entity relationships associated with the application (response only)

details
object
read-only

Application details (response, all properties optional)

decision
object
read-only

Decision-related information (response, all properties optional)

documents
object[]

Documents associated with the application

metadata
object

Arbitrary metadata associated with the application