v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-051025108.8 KB
LookupsV2PhoneNumber

Full API documentation: https://www.twilio.com/docs/lookup/v2-api

The Lookup API allows you to query information on a phone number so that you can make a trusted interaction with your user

get/v2/PhoneNumbers/{PhoneNumber}

Path parameters

PhoneNumberstring required

The phone number to lookup in E.164 or national format. Default country code is +1 (North America).

Query parameters

Fieldsstring

A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill.

CountryCodestring

The country code used if the phone number provided is in national format.

FirstNamestring

User’s first name. This query parameter is only used (optionally) for identity_match package requests.

LastNamestring

User’s last name. This query parameter is only used (optionally) for identity_match package requests.

AddressLine1string

User’s first address line. This query parameter is only used (optionally) for identity_match package requests.

AddressLine2string

User’s second address line. This query parameter is only used (optionally) for identity_match package requests.

Citystring

User’s city. This query parameter is only used (optionally) for identity_match package requests.

Statestring

User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests.

PostalCodestring

User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests.

AddressCountryCodestring iso-country-code

User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.

NationalIdstring

User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.

DateOfBirthstring

User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.

LastVerifiedDatestring

The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.

VerificationSidstring

The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.

PartnerSubIdstring

The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis.

Response

OK

calling_country_codestring nullable

International dialing prefix of the phone number defined in the E.164 standard.

country_codestring nullable

The phone number's ISO country code.

phone_numberstring phone-number nullable

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

national_formatstring nullable

The phone number in national format.

validboolean

Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user.

validation_errorsValidationError[]

Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER.

{"stackTrail":"components:schemas:LookupResponse:properties:phone_number_quality_score","oasType":"schema","type":"unknown","description":"An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number."}
{"stackTrail":"components:schemas:LookupResponse:properties:pre_fill","oasType":"schema","type":"unknown","description":"An object that contains pre fill information. pre_fill will return PII information associated with the phone number like first name, last name, address line, country code, state and postal code. "}
urlstring uri

The absolute URL of the resource.

All 10 operations