Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Create an account

Creates a new account.

Business Rules

  • Status is set to active by default on creation
  • Maximum 20 entities per relationship type
  • Cannot mix individual and business/sole_prop entities in account_holders
  • Authorized signers required for business/sole_prop account holders
  • application_id is required for credit accounts

Idempotency

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

post/v0/accounts

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

application_idstring

Unique identifier for the application. Prefixed with application_.

capabilitiesAccountCapability[] required

List of items that inform Lead how the Account will be used

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example request

{
  "application_id": "application_xyz123",
  "entities": {
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ],
    "authorized_users": [
      "entity_xyz123"
    ]
  },
  "details": {
    "credit": {
      "currency": "USD"
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}

Response

Account created successfully.

idstring

The ID of the Account object.

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

application_idstring

Unique identifier for the application. Prefixed with application_.

status'active' | 'inactive' | 'closed'

Current state of the account

status_reason'client_closed' | 'entity_closed' | 'frozen' | 'dormant' | 'active' | 'paid_off' | 'charged_off' | 'canceled' | 'other'

Machine-readable reason for the current status

capabilitiesAccountCapability[]

List of items that inform Lead how the Account will be used

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

client_account_idstring

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

Example response

{
  "id": "account_xyz123",
  "application_id": "application_xyz123",
  "details": {
    "credit": {
      "currency": "USD"
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}