GET advanced/async/{format}

nexmo.com:number-insight

Summary: Advanced Number Insight (async)
Operation ID: getNumberInsightAsync
Auth: unknown
Description

Provides [advanced number insight](/number-insight/overview#basic-standard-and-advanced-apis) 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.

Parameters (6)

callback (string, query, required)

The callback URL

cnam (boolean, query, optional, default: False)

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.

country (string, query, optional)

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](https://en.wikipedia.org/wiki/E.164) format, country must match the country code in number.

Constraints: {'pattern': '[A-Z]{2}'}

format (string, path, required)

The format of the response

Constraints: {'enum': ['json', 'xml']}

ip (string, query, optional)

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

number (string, query, required)

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

Constraints: {'pattern': '^[0-9-+\\(\\)\\s]*$'}

No probe data for this endpoint yet.