Countries
Get all countries
Returns all countries supported by the API.
Request
[PlatformAddress]/api/connector/v1/countries/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Country | required | The supported countries. |
| array of Country subdivision | required | The supported country subdivisions. |
| array of Country rules | required | Country-specific rules |
| array of Country group | required | The supported country groups. |
Country
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO 3166-1 alpha-2 code, e.g. |
| string | required | ISO 3166-1 alpha-2 code of the sovereign country. May differ from |
| string | required | English name of the country. |
Country subdivision
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO 3166-2 code of the administrative division, e.g AU-QLD. |
| string | required | ISO 3166-1 code of the Country. |
| string | required | English name of the country subdivision. |
Country rules
Country-specific rules
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO 3166-1 alpha-2 code, e.g. US or GB. |
| boolean | required | Whether the country requires expiration date for identity card. |
| boolean | required | Whether the country requires expiration date for driver's license. |
Country group
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Group code, e.g. |
| string | required | English name of the country group. |
| array of string | required | Codes of countries included in the group, in ISO 3166-1 alpha-2 format. |
Last updated