Skip to main content
POST
people.phone.carrier

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phone
string
required

The number in international form, digits only, without the leading plus, e.g. 447700900123.

Required string length: 1 - 20
Pattern: ^(?:^[0-9]{6,20}$)$

Response

The result

currentNetwork
string

Name of the network serving the number now.

originalNetwork
string

Name of the network the number was first issued on.

ported
boolean

True when the number moved from its first network to another.

countryCode3
string

Country of the number, three letters (ISO 3166 alpha-3, e.g. USA).

countryName
string

Country of the number, in words.