Sign in

v1

latestOpenAPI 3.0.0The MIT License (MIT)2026-07-1441848.4 KB

Basic Number Insight

Provides basic number insight information about a number.

Note that this endpoint also supports POST requests.

get/basic/{format}

Query parameters

numberstring required

A single phone number that you need insight about in national or international format.

countrystring

If a number does not have a country code or is uncertain, set the two-character country code. This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US. If you set country and number is already in E.164 format, country must match the country code in number.

Response

OK

country_codestring

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3string

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_namestring

The full name of the country that number is registered in.

country_prefixstring

The numeric prefix for the country that number is registered in.

international_format_numberstring

The number in your request in international format.

national_format_numberstring

The number in your request in the format used by the country the number belongs to.

request_idstring

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

status0 | 1 | 3 | 4 | 5 | 9
CodeText
0Success - request accepted for delivery by .
1Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3Invalid - your request is incomplete and missing some mandatory parameters.
4Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5Internal Error - the format of the recipient address is not valid.
9Partner quota exceeded - your account does not have sufficient credit to process this request.
status_messagestring

The status description of your request.

Example response

{
  "country_code": "GB",
  "country_code_iso3": "GBR",
  "country_name": "United Kingdom",
  "country_prefix": "44",
  "international_format_number": "447700900000",
  "national_format_number": "07700 900000",
  "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "status_message": "Success"
}