Skip to main content
GET
Check a phone number

Authorizations

Authorization
string
header
required

Authorization: Bearer <YOUR_API_KEY>. The Bearer prefix is optional.

Headers

X-Forwarded-Host
string

Resellers only, and required for them: a unique identifier for your customer that you must be able to provide exact details for e.g. id-123 that we can later link to a customer name

Query Parameters

phone_number
string
required

E.164, URL-encoded (+ becomes %2B). The + is optional.

webhook_url
string<uri>

Turns on webhook mode. https only, at most 2048 characters, a public host, no embedded credentials.

Maximum string length: 2048

Callbacks

POST
{$request.query.webhook_url}lookupFinished

Body

application/json
correlation_id
string<uuid>
required

The correlation_id from the receipt. Deduplicate on it.

phone_number
string
required
country
string
required
do_not_call
boolean
required

true if the number is on the register.

timestamp
string<date-time>
required

When the check ran.

dnc_list_source
string | null
required

The register that answered. Can be null when the number is not listed.

cost
object
required
status
enum<string>
required
Available options:
started,
succeeded,
failed
Allowed value: "succeeded"
error_code
null
required

Response

Delivered. The body is ignored.

Response

The answer.

do_not_call
boolean
required

true if the number is on the register.

timestamp
string<date-time>
required

When the check ran.

dnc_list_source
string | null
required

The register that answered. Can be null when the number is not listed.

cost
object
required