Account Holder KYC Document

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/document",
  "title": "Account Holder KYC Document",
  "type": "object",
  "description": "Describes the document and the required document image uploads\nrequired to re-run KYC",
  "examples": [
    {
      "account_holder_token": "aab6ad9a-3630-4cd0-bbec-1a0fa5c7e149",
      "token": "f41c975e-cad8-4e4f-a5cb-cef92ed91083",
      "document_type": "EIN_LETTER",
      "entity_token": "b50a84c9-8e86-4016-b1c7-0b9f71d4bb84",
      "required_document_uploads": [
        {
          "image_type": "FRONT",
          "status": "PENDING_UPLOAD",
          "status_reasons": [],
          "upload_url": "https://lithic-document-verification-uploads.com",
          "token": "e254beee-67db-4d8c-b610-306ee07de886",
          "accepted_entity_status_reasons": [],
          "rejected_entity_status_reasons": [],
          "created": "2024-09-18T12:34:56Z",
          "updated": "2024-09-18T12:34:56Z"
        }
      ]
    }
  ],
  "properties": {
    "token": {
      "type": "string",
      "format": "uuid",
      "description": "Globally unique identifier for the document."
    },
    "account_holder_token": {
      "type": "string",
      "format": "uuid",
      "description": "Globally unique identifier for the account holder."
    },
    "document_type": {
      "$ref": "#/components/schemas/document-type"
    },
    "entity_token": {
      "type": "string",
      "format": "uuid",
      "description": "Globally unique identifier for an entity."
    },
    "required_document_uploads": {
      "type": "array",
      "description": "Represents a single image of the document to upload.",
      "items": {
        "type": "object",
        "description": "Represents a single image of the document to upload.",
        "properties": {
          "image_type": {
            "type": "string",
            "enum": [
              "FRONT",
              "BACK"
            ],
            "description": "Type of image to upload."
          },
          "status": {
            "$ref": "#/components/schemas/document-upload-status"
          },
          "status_reasons": {
            "description": "Reasons for document image upload status.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/document-upload-status-reasons"
            }
          },
          "upload_url": {
            "type": "string",
            "description": "URL to upload document image to.\n\nNote that the upload URLs expire after 7 days. If an upload URL expires, you can\nrefresh the URLs by retrieving the document upload from `GET /account_holders/{account_holder_token}/documents`."
          },
          "token": {
            "type": "string",
            "format": "uuid",
            "description": "Globally unique identifier for the document upload."
          },
          "accepted_entity_status_reasons": {
            "description": "A list of status reasons associated with a KYB account holder that have been satisfied by the document upload",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rejected_entity_status_reasons": {
            "description": "A list of status reasons associated with a KYB account holder that have not been satisfied by the document upload",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "When the document upload was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "When the document upload was last updated"
          }
        },
        "required": [
          "image_type",
          "status",
          "status_reasons",
          "upload_url",
          "token",
          "created",
          "updated",
          "accepted_entity_status_reasons",
          "rejected_entity_status_reasons"
        ]
      }
    }
  },
  "required": [
    "account_holder_token",
    "document_type",
    "entity_token",
    "required_document_uploads",
    "token"
  ]
}