Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Create an application

Creates a new credit application in terminal status.

Business Rules

  • Applications MUST be created in terminal status (approved, declined, canceled)
  • Maximum 20 entities per relationship type
  • Credit fields required for all applications
  • Adverse action notice required for declined applications
  • Authorized signers required for commercial account holders
  • client_application_id cannot start with reserved prefix 'application_'
  • credit.limit cannot exceed credit.max_limit

Idempotency

The Idempotency-Key header is required. Reusing a key with a different request body will return a 422 error.

post/v0/applications

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

status'approved' | 'declined' | 'canceled' required

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

metadataobject

Arbitrary metadata associated with the application

Example request

{
  "entities": {
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ],
    "authorized_users": [
      "entity_xyz123"
    ]
  },
  "details": {
    "product_name": "Growth Business Credit Line",
    "credit": {
      "underwriting_grade": "99",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}

Response

Application created successfully.

idstring

Unique identifier for the application. Prefixed with application_.

client_application_idstring

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_atstring date-time

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

updated_atstring date-time

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

status'approved' | 'declined' | 'canceled'

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

metadataobject

Arbitrary metadata associated with the application

Example response

{
  "id": "application_xyz123",
  "entities": {
    "account_holder_type": "commercial",
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ]
  },
  "details": {
    "product_name": "Growth Business Credit Line",
    "credit": {
      "underwriting_grade": "99",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}