Typy osobních dokladů

GET

/codelist/proofOfIdentityType

Maintainer:Not configured

Význam a použití

Tato metoda vrací předem definovaný seznam kódů a popisků – v tomto případě typů dokladů sloužících k ověření identity. Uživatelé či integrované systémy tak mohou zjistit, jaké typy dokladů (např. občanský průkaz, cestovní pas apod.) jsou v rámci API podporované. Využití najde především v pro:

- Získání seznamu typů dokladů
Pro některé služby (např. výdej balíku proti dokladu) je v API potřeba uvádět, jaký typ dokladu byl použit pro ověření příjemce. Díky codelistu získáte oficiální kód i čitelný název daného typu (typicky v různých jazycích).

- Lokalizovaný popis
Obdobně jako u jiných codelistů, i zde API vrací text (název či popis) v různých jazycích. To se hodí pro zobrazení uživatelům v jejich jazyce.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

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;' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Success

Headers

Body

Example

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

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-05 12:34:02

Chybové hlášení

Customer

Typy osobních dokladů

Význam a použití#

Request

Request Code Samples

Responses

Význam a použití