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

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

The telephone number to validate

The ISO 2-character country code or international dialling code of the country to validate the telephoneNumber in, unless that number contains an explicit country code prefix. Alternatively, use "auto" to detect a country based on the user's location (ideal for client-side integrations - see also the EndUserIPAddress advanced option for server-side code).

An array of options that control further details of how this method operates. See the Advanced Options section below, for more information.

Indicates the country that the number must be in to be considered valid. This should be provided as the ISO 2-character country code.

A comma-separated list of prefixes in standard international format that the number must start with to be treated as valid. For example, use "+441,+442" to allow only standard UK landline numbers.

A comma-separated list of prefixes in standard international format that will cause the number to be treated as invalid. For example, use "+90,+447781" to block any Indian numbers or numbers allocated to C&W Guernsey.

When validating a mobile number and the number is unavailable, this option causes the service to return Invalid as the ValidationResult instead of the default Unavailable. This will cause your calling application to have a stricter level of validation for mobiles, i.e. they must be turned on.

If set to true, the service will perform an additional regex check and invalidate any unlikely numbers even if they are technically valid, such as 07000000000 or 01234567890

The format the telephone number should be returned in. This can be one of the following values:

• International - the number is presented back with full international dialling code
• National - the number is presented back without the international dialling code but with the full area code
• Local - the number is presented back with only the local part

A comma-separated list of country codes (without leading + or 00). Any telephone numbers for these countries will be formatted using the DifferentFormatType format instead of the DefaultFormatType. If this is not specified it will default to the same value as the defaultCountry parameter. To format all telephone numbers according to the DefaultFormatType regardless of country, set this value to an empty string.

The format the telephone number should be returned in if it is from a country listed in DifferentFormatCountries. This can be one of the same set of values as DefaultFormatType.

Indicates if telephone numbers should be formatted according to the country-specific rules for its particular country with spaces, punctuation etc. If this is set to false, numbers are formatted according to ITU international standard formatting.

If the defaultCountry parameter is set to "auto", the country will be detected based on the IP address the request is coming from. While this works for client-side integrations, when using the service from server-side code you will need to specify the IP address that the country should be derived from by specifying it in this option. This would typically be taken from the IP address that your client is submitting the data from, and can be obtained from server variables e.g. $_SERVER['REMOTE_HOST'] in PHP.

The TelephoneNumber field in the result will be formatted according to our standard country-specific rules. This option allows you to override those formats. Custom formats are specified as a semi-colon separated list of <countrycode>=<format>, where <countrycode> is the international dialling code and <format> is the format to use for telephone numbers in that country.

Formats are specified using the following special characters. Examples show the result of the formatting character based on the input telephone number +441513554555 extension 1234.

Any other characters will be treated as literal strings. The backslash character is used as an escape character, so \i will output i and \\ will output \.

If there are more numbers in the telephone number than are output by the specified format string, the additional numbers will be appended to the result to ensure no data is lost.

By default, all North American phone numbers will be validated to ensure the exchange is correct, i.e. all but the final 4 digits. Full number validation is available for US mobile numbers, but due to the costs involved in this process any such numbers are billed at 2 credits per lookup instead of the usual 1. Because of this difference in cost, this is an opt-in process. You can opt-in to this additional validation on a per-request basis using this option, or you can change your default setting on your dashboard.

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.

Contains properties indicating the validity and other information for the supplied telephone number: