Connector API
Search…
⌃K

Countries

Get all countries

Returns all countries supported by the API.

Request

[PlatformAddress]/api/connector/v1/countries/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0"
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.

Response

{
"Countries": [
{
"Code": "GB",
"EnglishName": "United Kingdom of Great Britain and Northern Ireland"
},
{
"Code": "US",
"EnglishName": "United States of America"
}
],
"CountrySubdivisions": [
{
"Code": "AU-NSW",
"CountryCode": "AU",
"EnglishName": "New South Wales"
},
{
"Code": "AU-QLD",
"CountryCode": "AU",
"EnglishName": "Queensland"
}
],
"CountryAlliances": [
{
"Code": "SCHENGEN",
"EnglishName": "Schengen Area",
"CountryCodes":[
"AT",
"BE",
"CZ",
...
]
}
]
}
Property
Type
Contract
Description
Countries
array of Country
required
The supported countries.
CountrySubdivisions
required
The supported country subdivisions.
CountryAlliances
array of Country alliance
required
The supported country alliances.

Country

Property
Type
Contract
Description
Code
string
required
ISO 3166-1 alpha-2 code, e.g. US or GB.
EnglishName
string
required
English name of the country.

Country subdivision

Property
Type
Contract
Description
Code
string
required
ISO 3166-2 code of the administrative division, e.g AU-QLD.
CountryCode
string
required
ISO 3166-1 code of the Country.
EnglishName
string
required
English name of the country subdivision.

Country alliance

Property
Type
Contract
Description
Code
string
required
Code of the alliance, e.g EU, SCHENGEN, SCHENGEN-VISA.
EnglishName
string
required
English name of the alliance.
CountryCodes
array of string
required
ISO 3166-1 codes of the member countries.