v1

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

Advanced Number Insight (async)

Provides advanced number insight number information asynchronously using the URL specified in the callback parameter. recommends asynchronous use of the Number Insight Advanced API, to avoid timeouts.

Note that this endpoint also supports POST requests.

get/advanced/async/{format}

Query parameters

callbackstring uriref required

The callback URL

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.

ipstring

This parameter is deprecated as we are no longer able to retrieve reliable IP data globally from carriers.

Response

OK

error_textstring

The status description of your request. Note: This field is equivalent to status_message field in the other endpoints

numberstring

The number in your request

remaining_balancestring

Your account balance in EUR after this request.

request_idstring

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

request_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.

status0 | 1 | 3 | 4 | 5 | 9 | 19 | 43 | 44 | 45 | 999
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.
19Facility Not Allowed - your request makes use of a facility that is not enabled on your account.
43, 44, 45Live mobile lookup not returned. Not all return parameters are available.
999Request unparseable.

Example response

{
  "error_text": "Success",
  "number": "447700900000",
  "remaining_balance": "1.23456789",
  "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "request_price": "0.01500000"
}
All 4 operations