Types of personal documents
GET
/codelist/proofOfIdentityType
Codelist
Meaning and Usage
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).
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 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 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
X-Correlation-ID
string
optional
X-LogLevel
enum<string>
optional
Allowed values:
TraceDebugInformationWarningErrorCritical