RocketKOR

List Document Types

Retrieve a list of allowed documents types for a specific account holder type (Beneficiary, Customer Account, or Business Account).

Endpoint

GET /v1/document-types

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

holderType

string enum, values: BUSINESS_ACCOUNT, CUSTOMER, BENEFICIARY

Type of account holder. This filter will retrieve allowed document types for this account holder type.

holderSubType  CONDITIONAL

string enum, values: INDIVIDUAL, BUSINESS

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

Request Body

None

Returns

Retrieves an array of allowed document types for the specified account holder type. The following fields are returned for each document type.

id

string

Document ID.

name

string

Document name.

requiredFields

array

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"
    ]
  },
  {...},
  {...}
]