latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Person identifications

List supported documents for a person identification

Returns an array of document types that a customer may use to identify themselves along with a list of allowed issuing countries. The issuing_countries are provided as ISO country codes (ISO-3166-1 alpha 2). If the customer does not provide a supported document type in the identification process, then their identification will eventually fail.

get/v1/persons/{person_id}/identifications/{id}/supported_documents

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper
idstring required

The unique ID of the identification resource created for a customer.

Example:6dc54352d6793a892e0702850d07b831cidt

Response

Successful result of the operation

typestring

Document type

issuing_countriesstring[]

Array of country codes

Example response

[
  {
    "type": "Passport",
    "issuing_countries": [
      "ES"
    ]
  }
]