All Countries API
This API is used to obtain a list of all supported countries.
Command
"client/listCountries/1"
Inputs
The following values are expected in the JSON body:
Name | Type | Required | Description |
---|---|---|---|
command | String | Must be "client/listCountries/1" |
|
verbose | Boolean | If true, returns country names instead of ISO Codes (i.e. United States of America, Canada, etc...) |
Outputs
The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the following is included in the response field:
Name | Type | Description |
---|---|---|
countries | String[] | All supported countries in ISO Code (i.e. US, CA, etc..) |
Example Response
response : {
countries : [
"US",
"CA",
...
"SA",
"ZA"
]
}