Types of personal documents

GET

/codelist/proofOfIdentityType

Codelist

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 Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Request

Query Params

Limit

integer <int32>

required

>= 1<= 1000

Offset

integer <int32>

required

>= 0

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

X-Paging-Total-Items-Count

string

optional

Total items in result

X-Paging-Offset

string

optional

Paging offset

X-Paging-Limit

string

optional

Page size

Body

array of:

name

string | null

optional

Name of identity type

code

string | null

optional

Code of identity type

🟠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

Responses

Meaning and Usage