Skip to main content
GET
Full phone number intelligence lookup

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

phoneNumber
string
required

Phone number in E.164 format. URL-encode the leading + (or use %2B). The route also accepts an unencoded + for back-compat — decodeURIComponent runs server-side.

Query Parameters

fields
string

Optional Twilio-compat data-package selector. Comma-separated list of field names from the enumeration below (case-insensitive, deduped server-side, max 16 fields per request). Unknown field names reject the whole request with 422.

Required only when reassigned_number is in fields. The date (YYYY-MM-DD) prior-express consent was obtained or last verified. The FCC reassigned-number safe harbor is evaluated against this date — if reassigned_number is requested without it, that field returns status: error (consent_date_required) while the rest of the response is unaffected.

Pattern: ^\d{4}-\d{2}-\d{2}$
identity_name
string

Used only when identity_match is in fields. Full registered name to verify against the operator's KYC records. Supply at least one identity_* attribute when requesting identity_match, else that field returns status: error (identity_attributes_required).

identity_given_name
string

Used only when identity_match is in fields. Given (first) name to verify against the operator's KYC records.

identity_family_name
string

Used only when identity_match is in fields. Family (last) name to verify against the operator's KYC records.

identity_birthdate
string

Used only when identity_match is in fields. Date of birth (YYYY-MM-DD) to verify against the operator's KYC records.

Pattern: ^\d{4}-\d{2}-\d{2}$
identity_email
string

Used only when identity_match is in fields. Email address to verify against the operator's KYC records.

identity_id_document
string

Used only when identity_match is in fields. Government ID document reference to verify against the operator's KYC records.

Response

Phone number intelligence result

Phone number intelligence result

data
object
meta
object