Retrieve a list of Document Types available for the account.
POST http://api.kompliant.com/account.documentType.list (OpenAPI specification )
This method returns a list of all available Document Type records associated with a specific account, providing a complete view of acceptable document types and their requirements. Each document type includes its status, default requirements, and any alternative requirements that may apply. Use this method as a reference to be able to add Required Documents for a workflow, doing validations, or displaying available Document Type options to users during the application process.
Authentication : KSig1-HMAC-SHA256
Parameter Type Required Description account_id string Yes The account where the subject record will be created. The Account ID is supplied to you when you receive your credentials.
JSON
{
"account_id": "sb_j8gh53b"
}
Parameter Type Description document_types array An array of document_type objects that contain information about document types available for the account.
Parameter Type Description account_document_type_id string The ID of the Account Document Type. document_type_code string The code of the document type. Must be one of the DOCUMENT_TYPE_CODES . document_name string Display name of the Document Type such as "Bank Statement" for BANK_STATEMENTS. status string The status of the Document Type. Must be one of ACCOUNT_DOCUMENT_TYPE_STATUSES . requirements object Object with the information of the default requirements defined in the table below. alternate_requirements array An array of requirement text objects containing the alternative requirements for the Document Type. Requirement text is defined in the table below.
Parameter Type Description default_requirement object Object with the requirement_text for the default requirement, defined in the table below.
Parameter Type Description requirement_text string The display text for the requirement.
JSON
{
"meta": {
"status": "SUCCESS",
"trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
"version": "2025-03-24"
},
"data": {
"document_types": [
{
"account_document_type_id": "adt_6zNzQZHSf26V83BO3uW6dS",
"document_type_code": "PASSPORT",
"document_name": "Passport Document",
"status": "ACTIVE",
"requirements": {
"default_requirement": {
"requirement_text": "Valid passport required"
}
},
"alternate_requirements": [
{
"requirement_text": "Must be valid for at least 6 months"
},
{
"requirement_text": "Must contain clear photo and signature"
}
]
}
]
}
}
Error Code HTTP Code Possible Cause BAD_REQUEST 400 Required parameters not provided. ENTITY_NOT_FOUND 400 The account_id provided does not exist.
