Retrieve a list of the types of official identification documents for a country.
GET {{baseUrl}}/v1/identities/types?country=OM
Use this method to determine the types of documents to use for identification purposes, and also whether you need the reverse side of the document. You can filter your search results by country with the country query parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
country | string | (Required) Two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"country":"\u003cstring\u003e","type":"\u003cstring\u003e","name":"\u003cstring\u003e","is_back_required":"\u003cboolean\u003e","is_address_extractable":"\u003cboolean\u003e"},{"country":"\u003cstring\u003e","type":"\u003cstring\u003e","name":"\u003cstring\u003e","is_back_required":"\u003cboolean\u003e","is_address_extractable":"\u003cboolean\u003e"}],"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}