Skip to content
Stainless Stainless Stainless SDKs

Simulate Enrollment Document Review

Simulate an account holder document upload's review
post/v1/simulate/account_holders/enrollment_document_review

Simulates a review for an account holder document upload.

Body Parameters
document_upload_tokenstring

The account holder document upload which to perform the simulation upon.

statusenum
Accepts one of the following: "UPLOADED", "ACCEPTED", "REJECTED", "PARTIAL_APPROVAL"

An account holder document's upload status for use within the simulation.

Hide ParametersShow Parameters
"UPLOADED"
"ACCEPTED"
"REJECTED"
"PARTIAL_APPROVAL"
accepted_entity_status_reasonsarray of string
optional

A list of status reasons associated with a KYB account holder in PENDING_REVIEW

status_reasonenum
optional
Accepts one of the following: "DOCUMENT_MISSING_REQUIRED_DATA", "DOCUMENT_UPLOAD_TOO_BLURRY", "FILE_SIZE_TOO_LARGE", 8 more

Status reason that will be associated with the simulated account holder status. Only required for a REJECTED status or PARTIAL_APPROVAL status.

Hide ParametersShow Parameters
"DOCUMENT_MISSING_REQUIRED_DATA"
"DOCUMENT_UPLOAD_TOO_BLURRY"
"FILE_SIZE_TOO_LARGE"
"INVALID_DOCUMENT_TYPE"
"INVALID_DOCUMENT_UPLOAD"
"INVALID_ENTITY"
"DOCUMENT_EXPIRED"
"DOCUMENT_ISSUED_GREATER_THAN_30_DAYS"
"DOCUMENT_TYPE_NOT_SUPPORTED"
"UNKNOWN_FAILURE_REASON"
"UNKNOWN_ERROR"
Returns
tokenstringaccount_holder_tokenstringdocument_typeenumentity_tokenstringrequired_document_uploadsarray of objectDocument
Request example Request
curl https://api.lithic.com/v1/simulate/account_holders/enrollment_document_review \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "document_upload_token": "document_upload_token",
      "status": "UPLOADED"
    }'
200 Example
{
  "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"
    }
  ]
}