Skip to content

List Documents

Get account holder document uploads
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_tokenstring
formatuuid
Returns
dataarray of tokenstringaccount_holder_tokenstringdocument_typeenumentity_tokenstringrequired_document_uploadsarray of objectDocument
optional
Request example Request
curl https://api.lithic.com/v1/account_holders/$ACCOUNT_HOLDER_TOKEN/documents \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_holder_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "document_type": "DRIVERS_LICENSE",
      "entity_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "required_document_uploads": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "accepted_entity_status_reasons": [
            "string"
          ],
          "created": "2019-12-27T18:11:19.117Z",
          "image_type": "FRONT",
          "rejected_entity_status_reasons": [
            "string"
          ],
          "status": "ACCEPTED",
          "status_reasons": [
            "DOCUMENT_MISSING_REQUIRED_DATA"
          ],
          "updated": "2019-12-27T18:11:19.117Z",
          "upload_url": "upload_url"
        }
      ]
    }
  ]
}