Types of personal documents

GET

/codelist/proofOfIdentityType

Maintainer:Not configured

Meaning and Usage

This method returns a predefined list of codes and descriptions – in this case, the types of documents used for identity verification. Users or integrated systems can thus determine which document types (e.g., ID card, passport, etc.) are supported within the API.

Its primary uses are:

Obtaining a List of Document Types
For some services (e.g., package delivery against a document), the API requires specifying which type of document was used to verify the recipient. The codelist provides both the official code and the human-readable name of the type (typically in various languages).

Localized Description
As with other codelists, the API returns the text (name or description) in different languages, which is useful for displaying to users in their native language.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/codelist/proofOfIdentityType?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK

application/json

Success

Headers

Body

Example

[
    {
        "name": "string",
        "code": "string"
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-07 09:13:12

Codelist of validation messages

Customer information - permitted currencies

Types of personal documents

Meaning and Usage#

Request

Request Code Samples

Responses

Meaning and Usage