Skip to main content
GET
Look up one number

Authorizations

X-API-Key
string
header
required

Your API key from the dashboard.

Query Parameters

number
string
required

A +1 (NANP) number: +14169670000 (encode the + as %2B) or 4169670000.

Response

Lookup result.

status
string
Example:

"success"

phone
string

The number you sent, normalised to E.164 when it is a valid +1 number.

phone_valid
boolean
phone_type
enum<string> | null
Available options:
mobile,
fixed_line,
voip,
toll_free,
premium_rate,
unknown
phone_region
string | null
country
string | null
country_code
string | null
country_prefix
string | null
international_number
string | null

Display format, like +1 416-967-0000.

local_number
string | null

Display format, like (416) 967-0000.

e164
string | null

Normalised. Use this (or the input position) to match results.

carrier
string | null

The carrier the number block was first allocated to. Ported numbers can show the old carrier.

mode
string
Example:

"static"

timezone
string[]
geographical
boolean | null
verdict
enum<string>
Available options:
valid,
risky,
invalid
reasons
string[]

Why the verdict was given.