Number Lookup API
E164PhoneNumber
string · pattern:
^\+[1-9]\d{1,14}$Phone number in E.164 format
Example: +38766000111
CarrierInfo
Carrier information returned for a valid lookup
nametypeCarrier line type, for example mobile or landline
Example: mobile
mccMobile Country Code
Example: 218
mncMobile Network Code
Example: 90
NumberLookupResult
Sanitized carrier lookup result
phone_number^\+[1-9]\d{1,14}$ · requiredPhone number in E.164 format
Example: +38766000111
country_codeISO 3166-1 alpha-2 country code
Example: BA
national_formatNationally formatted phone number
Example: 066 000-111
validWhether the phone number is considered valid
Example: true
object
Carrier information returned for a valid lookup
SingleNumberLookupRequest
phone_number^\+[1-9]\d{1,14}$ · requiredPhone number in E.164 format
Example: +38766000111
SingleNumberLookupSuccessResponse
successEnum values:
object · required
Sanitized carrier lookup result
BulkNumberLookupRequest
phone_numbersList of E.164 phone numbers to look up. Must be unique. Maximum 1000 items.
Example: ["+38766000111","+38761111222"]
BulkNumberLookupJobItem
phone_number^\+[1-9]\d{1,14}$ · requiredPhone number in E.164 format
Example: +38766000111
statusPer-number item status
Enum values:
pending
completed
failed
object
Lookup result when status is completed
errorError message when status is failed
Example: Number lookup service unavailable
ApiError
codeMachine-readable error code
Example: NUMBER_LOOKUP_UNAVAILABLE
messageHuman-readable error message
Example: Number lookup service unavailable