Skip to content

Get all countries

POST
/api/connector/v1/countries/getAll

Returns all countries supported by the API.

Parameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0"
}

OK

CountryResult
object
Countries
required

The supported countries.

Array<object>
Country
object
Code
required

ISO 3166-1 alpha-2 code, e.g. CZ or SK.

string
>= 1 characters
SovereignCountryCode
required

ISO 3166-1 alpha-2 code of the sovereign country. May differ from Code for dependent territories.

string
>= 1 characters
EnglishName
required

English name of the country.

string
>= 1 characters
CountrySubdivisions
required

The supported country subdivisions.

Array<object>
Country subdivision
object
Code
required

ISO 3166-2 code of the administrative division, e.g AU-QLD.

string
>= 1 characters
CountryCode
required

ISO 3166-1 code of the Country.

string
>= 1 characters
EnglishName
required

English name of the country subdivision.

string
>= 1 characters
CountryRules
required

Country-specific rules

Array<object>
Country rules

Country-specific rules

object
CountryCode
required

ISO 3166-1 alpha-2 code, e.g. US or GB.

string
>= 1 characters
IdentityCardExpirationDateNotRequired
required

Whether the country requires expiration date for identity card.

boolean
DriverLicenceExpirationDateNotRequired
required

Whether the country requires expiration date for driver’s license.

boolean
CountryGroups
required
Country group

The supported country groups.

Array<object>
Country group
object
Code
required

Group code, e.g. EU, SCHENGEN, NORDIC

string
>= 1 characters
EnglishName
required

English name of the country group.

string
>= 1 characters
CountryCodes
required

Codes of countries included in the group, in ISO 3166-1 alpha-2 format.

Array<string>
Example
{
"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",
"..."
]
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable