Phone response
Returned by GET /phone-finder and GET /phone-validator at data. The same object makes up the phone_data array of person and email verifier results when you set enrich_mobile=true.
Fields
| Field | Type | Description |
|---|---|---|
valid | boolean | true if the number is valid in its country's numbering plan. |
e164_format | string | E.164 format, such as +14155550132. |
intl_format | string | International format, such as +1 415-555-0132. |
local_format | string | National format, such as (415) 555-0132. |
rfc3966_format | string | RFC 3966 URI, such as tel:+1-415-555-0132. |
country_code | string | Two-letter country code (ISO 3166-1 alpha-2) of the number. |
line_type | string | See Line types. |
carrier | string | Carrier the number was assigned to. Empty when unknown. |
region | object or null | State or province of the number: name and ISO 3166-2 code, such as California and CA. null when the number doesn't identify one. |
timezones | array of strings | IANA time zones of the number, such as America/Los_Angeles. |
email | string | Phone finder only. The address the number was found for. |
domain | string | Phone finder only. The domain the number was found for. |
linkedin | string | Phone finder only. The LinkedIn profile URL the number was found for. |
The phone finder returns one number in data, preferring a valid one. With full=true, data is an array of every number found. When nothing is found, data is an empty array and the response repeats the email, domain, or linkedin you sent.
The phone validator returns data only for a valid number. For an invalid number, data is an empty array and the response repeats your input in phone.
Line types
line_type | Meaning |
|---|---|
MOBILE | Mobile number. |
FIXED_LINE | Landline. |
FIXED_LINE_OR_MOBILE | The numbering plan doesn't distinguish landlines from mobiles for this number. |
VOIP | Internet (VoIP) number. |
TOLL_FREE | Toll-free number. |
PREMIUM_RATE | Premium-rate number. |
SHARED_COST | Shared-cost number. |
PERSONAL_NUMBER | Personal number that forwards to a mobile or landline. |
PAGER | Pager. |
UAN | Universal access number: one company number that routes to several offices. |
UNKNOWN | The type can't be determined. Voicemail numbers are also reported as UNKNOWN. |
For US, Canadian, and Mexican numbers, Tomba uses the numbering plan's allocation data to replace FIXED_LINE_OR_MOBILE with MOBILE, FIXED_LINE, VOIP, or TOLL_FREE when the number's block is classified, and to fill in carrier and region.
Example
GET /phone-finder?email=jane.doe@stripe.com:
Code