Menu

DetectCountry

Identifies the country from a customer's contact details.

Live Demo

This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.

Changing the hosting country does not affect the data returned by the service. However you may wish to select a particular country based on your data residency requirements or network latency.
JSON
Open API
SOAP

Description

Identifies a country from a customer's contact details. All the available details for the customer should be supplied as part of the request parameter - the more information that is supplied the more accurate the country detection process will be.

The details of the detected country are provided in the returned values. If no country could be identified, the country name and ISO code are both set to "Unknown"

Credit Usage

Each request to this method consumes 1 CountryDetection credit.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
request

request

A CountryDetectionInput structure containing the following properties:

Name Description
Address The postal address
Postcode The postcode
Country Any already-known country name or code which may or may not be correct or standardised
EmailAddresses A list of email addresses
TelephoneNumbers A list of telephone numbers
IPAddress The IP address

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
CountryName

CountryName

Contains the ISO standard name of the detected country
CountryISO

CountryISO

Contains the 2-character ISO code of the detected country
IDC

IDC

Contains the international telephone dialling code of the detected country
CCTLD

CCTLD

Contains the country-code top level domain name of the detected country

Live Demo

request

Address

Sorry, this parameter type is not currently supported in Live Demo

Postcode

Country

EmailAddresses

Sorry, this parameter type is not currently supported in Live Demo

TelephoneNumbers

Sorry, this parameter type is not currently supported in Live Demo

IPAddress
options
Name Value
Common Options

Sample Code