Check a phone number
Returns whether the number is on its country’s do-not-call register. Send webhook_url to get the answer as a POST instead. See Webhooks.
Send numbers in E.164 with the national leading zero dropped: UK 01000822380 is +441000822380.
Authorizations
Authorization: Bearer <YOUR_API_KEY>. The Bearer prefix is optional.
Headers
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
E.164, URL-encoded (+ becomes %2B). The + is optional.
Turns on webhook mode. https only, at most 2048 characters, a public host, no embedded credentials.
2048Callbacks
POST{$request.query.webhook_url}lookupFinished
Body
- Succeeded
- Failed
The correlation_id from the receipt. Deduplicate on it.
true if the number is on the register.
When the check ran.
The register that answered. Can be null when the number is not listed.
started, succeeded, failed "succeeded"Response
Delivered. The body is ignored.