Get a phone number lookup by URL
/v1/lookup/phone-number/{number}curl -X GET "https://us1.platform.bird.com/v1/lookup/phone-number/{number}" \
-H "Authorization: Bearer $TOKEN"{
"phone_number": "+441904123456",
"country_code": "GB",
"network_info": {
"carrier_name": "BT",
"mcc": "234",
"mnc": "00"
},
"original_network_info": null,
"flags": [],
"line_type": "service",
"classification": {
"status": "ok",
"value": "premium_rate"
},
"score": {
"status": "ok",
"value": 48
},
"presence": {
"status": "ok",
"reachable": true
},
"roaming": {
"status": "unavailable"
}
}
Performs the same lookup as Create a phone number lookup, with the number in the URL. The response includes the number's serving and issuing networks, porting state, country, and line type. Repeat type to request additional blocks, such as ?type=classification&type=score; only blocks with an ok status incur an additional charge.
Because the number is in the URL, it can appear in proxies, access logs, and browser history. This form does not accept an Idempotency-Key; each retry performs and charges for another lookup.
Parameters
numberstringThe number to look up, in international format. The leading + is optional, and 00 works in its place, so 31612345678 and +31612345678 are the same number, with nothing to percent-encode. If you do send the +, percent-encode it as %2B when your client does not do that for you.
Query Parameters
typearrayAn additional data block to request. Repeat the parameter for multiple blocks; each block is billed separately only when its status is ok.
Response Payload
phone_numberThe number that was looked up, in E.164 format.
country_codeThe ISO 3166-1 alpha-2 country of the number. Absent when the number belongs to no single country, as a non-geographic range does.
network_infoThe network that serves the number today. Absent when no network could be identified.
original_network_infoThe network that issued the number's range. It differs from network_info when the number has been ported. Absent when the issuing network could not be identified.
flagsNotable characteristics of the number. Empty when none apply.
line_typeclassificationThe allocated service of the number's range. Absent unless you requested the classification property.
presenceWhether the number is live on its network. Absent unless you requested the presence property.
roamingWhether the number is roaming. Absent unless you requested the roaming property.
sim_swapWhen the number's SIM last changed. Absent unless you requested the sim_swap property.
portingThe number's porting record. Absent unless you requested the porting property.
Show child attributes
porting.statusporting.portedWhether the number has ever moved network. false is a positive finding rather than a lack of one: the registry was consulted and holds no move for this number. Present only when status is ok.
porting.last_ported_atWhen the number last moved network. Absent when it has never ported or when no date is on record.
porting.last_ported_at_is_approximateWhether last_ported_at is an approximation. Some registries record the period of a move without its exact day.
porting.historyEvery move on record, oldest first. Absent when the number has never ported or when its registry publishes no history.
scoreThe number's credibility score. Absent unless you requested the score property.
Related resources
Continue with the documentation, guides and examples for this topic.