v1

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

Standard Number Insight

Provides standard number insight information about a number.

Note that this endpoint also supports POST requests.

get/standard/{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.

cnamboolean

Indicates if the name of the person who owns the phone number should be looked up and returned in the response. Set to true to receive phone number owner name in the response. This features is available for US numbers only and incurs an additional charge.

Response

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

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

status_messagestring

The status description of your request.

caller_namestring

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

caller_type'business' | 'consumer' | 'unknown'

The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

first_namestring

First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.

last_namestring

Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.

If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.

refund_pricestring

If there is an internal lookup error, the refund_price will reflect the lookup price. If cnam is requested for a non-US number the refund_price will reflect the cnam price. If both of these conditions occur, refund_price is the sum of the lookup price and cnam price.

remaining_balancestring

Your account balance in EUR after this request.

request_pricestring

The amount in EUR charged to your account.

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",
  "caller_identity": {
    "caller_name": "John Smith",
    "caller_type": "consumer",
    "first_name": "John",
    "last_name": "Smith"
  },
  "caller_name": "John Smith",
  "caller_type": "consumer",
  "current_carrier": {
    "country": "GB",
    "name": "Acme Inc",
    "network_code": "12345",
    "network_type": "mobile"
  },
  "first_name": "John",
  "last_name": "Smith",
  "original_carrier": {
    "country": "GB",
    "name": "Acme Inc",
    "network_code": "12345",
    "network_type": "mobile"
  },
  "ported": "not_ported",
  "refund_price": "0.01500000",
  "remaining_balance": "1.23456789",
  "request_price": "0.04000000"
}