v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

List Allowed Countries

Get the list of allowed countries of residence, citizenship and source of funds.

get/list/{country}

Path parameters

countrystring required

Country follows the ISO 3166-1 alpha-3 standard.

Query parameters

typestring required

type of list, options: 'RESIDENCE', 'CITIZENSHIP', 'SOURCEOFFUNDS'

Headers

api-keystring required

API key

auth-keystring required

Auth key generated using API key & secret

Response

200

OR

Example response

{
  "status": 200,
  "doc": [
    {
      "country": "ALA",
      "countryName": "Aland Islands",
      "countryCode2": "AX"
    }
  ]
}