Lithic API Documentation | Account Holders › Get Account Holder Document Uploads

API Reference

Account Holders

account_holders

Methods

Create An Individual Or Business Account Holder -> { token, account_token, status, 4 more... }

post/v1/account_holders

Create an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is successfully created an associated account is also created. All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on accounts that are part of the program that the calling API key manages.

Update Account Holder Information And Possibly Resubmit For Evaluation -> { token, account_token, beneficial_owner_entities, 17 more... } | { token, address, business_account_token, 5 more... }

patch/v1/account_holders/{account_holder_token}

Update the information associated with a particular account holder (including business owners and control persons associated to a business account). If Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required). All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on existing accounts that are part of the program that the calling API key manages.

Get An Individual Or Business Account Holder ->

AccountHolder

get/v1/account_holders/{account_holder_token}

Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status.

Initiate Account Holder Document Upload ->

Document

post/v1/account_holders/{account_holder_token}/documents

Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification. It will return two URLs to upload your document images to - one for the front image and one for the back image.

This endpoint is only valid for evaluations in a PENDING_DOCUMENT state.

Uploaded images must either be a jpg or png file, and each must be less than 15 MiB. Once both required uploads have been successfully completed, your document will be run through KYC verification.

If you have registered a webhook, you will receive evaluation updates for any document submission evaluations, as well as for any failed document uploads.

Two document submission attempts are permitted via this endpoint before a REJECTED status is returned and the account creation process is ended. Currently only one type of account holder document is supported per KYC verification.

Get Account Holder Document Uploads -> { data }

get/v1/account_holders/{account_holder_token}/documents

Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads.

Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).

In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a previous account holder document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.

When a new document upload is generated for a failed attempt, the response will show an additional entry in the required_document_uploads list in a PENDING state for the corresponding image_type.

path Parameters

account_holder_token: string

(format: uuid)

Response fields

data: Array<

Document

Optional

Request example

curl https://api.lithic.com/v1/account_holders/$ACCOUNT_HOLDER_TOKEN/documents \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "f41c975e-cad8-4e4f-a5cb-cef92ed91083",
      "account_holder_token": "aab6ad9a-3630-4cd0-bbec-1a0fa5c7e149",
      "document_type": "EIN_LETTER",
      "entity_token": "b50a84c9-8e86-4016-b1c7-0b9f71d4bb84",
      "required_document_uploads": [
        {
          "token": "e254beee-67db-4d8c-b610-306ee07de886",
          "accepted_entity_status_reasons": [
            "string"
          ],
          "created": "2024-09-18T12:34:56Z",
          "image_type": "FRONT",
          "rejected_entity_status_reasons": [
            "string"
          ],
          "status": "PENDING_UPLOAD",
          "status_reasons": [
            "DOCUMENT_MISSING_REQUIRED_DATA"
          ],
          "updated": "2024-09-18T12:34:56Z",
          "upload_url": "https://lithic-document-verification-uploads.com"
        }
      ]
    }
  ]
}

Get Account Holder Document Upload Status ->

Document

get/v1/account_holders/{account_holder_token}/documents/{document_token}

Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.

Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).

In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.

When a new account holder document upload is generated for a failed attempt, the response will show an additional entry in the required_document_uploads array in a PENDING state for the corresponding image_type.

Get A List Of Individual Or Business Account Holders -> SinglePage<

AccountHolder

get/v1/account_holders

Get a list of individual or business account holders and their KYC or KYB evaluation status.

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

email: string

Optional

Email address of the account holder. The query must be an exact match, case insensitive.

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

external_id: string

Optional

(format: uuid)

If applicable, represents the external_id associated with the account_holder.

first_name: string

Optional

(Individual Account Holders only) The first name of the account holder. The query is case insensitive and supports partial matches.

last_name: string

Optional

(Individual Account Holders only) The last name of the account holder. The query is case insensitive and supports partial matches.

legal_business_name: string

Optional

(Business Account Holders only) The legal business name of the account holder. The query is case insensitive and supports partial matches.

limit: number

Optional

The number of account_holders to limit the response to.

phone_number: string

Optional

Phone number of the account holder. The query must be an exact match.

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response fields

data: Array<

AccountHolder

has_more: boolean

Whether there are more accounts to be retrieved.

Request example

curl https://api.lithic.com/v1/account_holders \
    -H "Authorization: $LITHIC_API_KEY"

200getAccountHoldersResponse

{
  "data": [
    {
      "account_token": "6b67b340-ed11-4463-a33d-0d7f7fdcd28c",
      "business_account_token": "00000000-0000-0000-0000-000000000000",
      "created": "2024-01-11T19:50:36.105448",
      "email": "[email protected]",
      "exemption_type": "AUTHORIZED_USER",
      "external_id": "+15555555555",
      "individual": {
        "address": {
          "address1": "123 Main Street",
          "city": "New York",
          "country": "USA",
          "postal_code": "10128",
          "state": "NY"
        },
        "dob": "2000-01-01",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Appleseed",
        "phone_number": "+15555555555",
        "entity_token": "49c978db-20c4-46d8-9db4-b0ef28c03533"
      },
      "phone_number": "+15555555555",
      "status": "ACCEPTED",
      "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
      "user_type": "INDIVIDUAL",
      "verification_application": {
        "created": "2024-01-11T19:58:24.821848",
        "status": "ACCEPTED",
        "status_reasons": [],
        "updated": "2024-01-11T19:58:24.821848"
      }
    },
    {
      "account_token": "732f7328-a2d7-4281-a264-e8cb5af8d392",
      "beneficial_owner_entities": [
        {
          "address": {
            "address1": "22 Street North",
            "city": "New York",
            "country": "USA",
            "postal_code": "10004",
            "state": "NY"
          },
          "dba_business_name": "Busy Business, Inc.",
          "government_id": "98-7654321",
          "legal_business_name": "Busy Business, Inc.",
          "parent_company": "Example company",
          "phone_numbers": [
            "+15555555555"
          ],
          "entity_token": "d89185ca-1fad-4f33-905c-416b4270a5d4"
        }
      ],
      "business_account_token": "00000000-0000-0000-0000-000000000000",
      "business_entity": {
        "address": {
          "address1": "22 Street North",
          "city": "New York",
          "country": "USA",
          "postal_code": "10004",
          "state": "NY"
        },
        "dba_business_name": "Busy Business, Inc.",
        "government_id": "98-7654321",
        "legal_business_name": "Busy Business, Inc.",
        "parent_company": "Example company",
        "phone_numbers": [
          "+15555555555"
        ],
        "entity_token": "f360a3c0-24e6-4852-ae82-27916a5c4e86"
      },
      "control_person": {
        "address": {
          "address1": "451 New Forest Way",
          "city": "Springfield",
          "country": "USA",
          "postal_code": "68022",
          "state": "IL"
        },
        "dob": "1991-03-08T08:00:00Z",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Appleseed",
        "phone_number": "+15555555555",
        "entity_token": "9d657ba0-7c8a-4946-a596-f99d978a4137"
      },
      "created": "2024-01-11T19:50:36.105449",
      "exemption_type": "AUTHORIZED_USER",
      "external_id": "851030f1-9b7b-4939-8ac9-161bd972d26f",
      "token": "fa68ed76-9d02-4d45-8a3f-782f3b6a8b3f",
      "user_type": "BUSINESS",
      "verification_application": {
        "created": "2024-01-11T19:50:36.105449",
        "status": "PENDING_REVIEW",
        "status_reasons": [],
        "updated": "2024-01-11T19:50:36.105449"
      }
    }
  ],
  "has_more": false
}

Simulate An Account Holder S Enrollment Review -> { token, account_token, beneficial_owner_entities, 17 more... }

post/v1/simulate/account_holders/enrollment_review

Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as KYB_BASIC.

Simulate An Account Holder Document Upload S Review ->

Document

post/v1/simulate/account_holders/enrollment_document_review

Simulates a review for an account holder document upload.

Domain types

AccountHolder = { token, created, account_token, 17 more... }

AddressUpdate = { address1, address2, city, 3 more... }

KYB = { beneficial_owner_individuals, business_entity, control_person, 7 more... }

KYBBusinessEntity = { address, government_id, legal_business_name, 3 more... }

KYC = { individual, tos_timestamp, workflow, 2 more... }

KYCExempt = { address, email, first_name, 6 more... }

RequiredDocument = { entity_token, status_reasons, valid_documents }