List Document Types

Retrieve a list of all document types. You can filter the results to return the allowed document types for a specific type of account holder (Business Account, Customer Account, or Beneficial Owner).

Endpoint

GET /v1/document-types

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

holderType

string enum, values: BENEFICIARY, BUSINESS_ACCOUNT, CUSTOMER

Filter the results to return the allowed document types for a specific type of account holder. The following values are supported:

BENEFICIARY Beneficial Owner.
BUSINESS_ACCOUNT Business Account.
CUSTOMER Customer Account.

holderSubType CONDITIONAL

string enum, values: BUSINESS, INDIVIDUAL

Account holder subtype. Required if holderType is CUSTOMER. Ignored for other types of account holders.

The following values are supported:

BUSINESS Business Customer Account.
INDIVIDUAL Individual Customer Account.

Request Body

None

Returns

Retrieves an array of document types. The following fields are returned for each document type.

string

Semantic ID for the document type (example: driving-license).

name

string

Descriptive name for the document type (example: Driving License).

requiredFields

array of strings

List of required fields for the document type.

SAMPLE RESPONSE

				
					[
  {
    "id": "driving-license",
    "name": "Driving License",
    "requiredFields": [
      "holderId",
      "holderType",
      "documentType",
      "name",
      "number",
      "issuingCountryCode",
      "issuingStateCode",
      "extension",
      "contentLength",
      "expiryDate"
    ]
  },
  {...},
  {...}
]