How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Lookup API

Inspect a recipient before sending. Phone-number lookups return carrier, portability, number type, reachability, roaming, SIM-change, and fraud-risk data when requested. Email lookups return deliverability, confidence, failure reasons, and suggested corrections for likely misspellings.

Bird Lookup API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Lookup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

4 operations 4 paths 25 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Lookup API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Lookup 4

Inspect a recipient before sending. Phone-number lookups return carrier, portability, number type, reachability, roaming, SIM-change, and fraud-risk data when requested. Email loo…

POST
/v1/lookup/phone-number
Create a phone number lookup
createPhoneNumberLookup 2 params body → 200400401402403422429500
GET
/v1/lookup/phone-number/{number}
Get a phone number lookup by URL
getPhoneNumberLookup 3 params → 200401402403422429500503
POST
/v1/lookup/email
Create an email address lookup
createEmailLookup 2 params body → 200400401402403422429500
GET
/v1/lookup/email/{address}
Get an email address lookup by URL
getEmailLookup 2 params → 200401402403422429500503

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are PhoneNumberLookup (12 properties), ErrorBody (11 properties), EmailLookup (7 properties), LookupPorting (5 properties). Each schema is shown below with its type and property counts.

EmailLookupResult
string
The verdict on the address, and the one field to decide on. - valid: the address exists and accepts mail. - neutral: it could not be confirmed either way, usua…
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
LookupClassificationValue
string
The allocated service of the number's range, at the precision the intelligence source publishes it. This is a finer vocabulary than linetype, which reports wha…
NextAction
object
5 properties 2 required
EmailLookupReason
string
Why an address cannot receive mail. - invalidsyntax: the address is malformed. - invaliddomain: the domain does not accept mail. - invalidrecipient: the domain…
LookupLineType
string
What kind of line the number is, as reported by the carrier platform. This is included in every base lookup, regardless of which properties you request. - unkn…
PhoneNumberLookupRequest
object
2 properties 1 required
LookupPropertyStatus
string
How a requested property resolved. - ok: the property was answered and its value is in the response. - unavailable: no answer arrived, so the property adds not…
CountryCode
string
ISO 3166-1 alpha-2 country code.
LookupRoaming
object
Whether the number is roaming, and on which network. Returned when you request the roaming property.
4 properties 1 required
EmailLookup
object
Assessment of whether an email address accepts mail, the confidence and reason for that assessment, and a suggested correction when the address appears misspel…
7 properties 5 required
LookupPresence
object
Whether the number is live on its network right now. Returned when you request the presence property. The result reflects a real-time query to the network wher…
2 properties 1 required
LookupNetworkInfo
object
The network a number belongs to.
3 properties
LookupScore
object
A credibility score for the number. Returned when you request the score property.
2 properties 1 required
LookupFlag
string
A notable characteristic of a number. ported means the number has moved from the network that issued it to another one, so networkinfo and originalnetworkinfo…
EmailLookupRequest
object
1 property 1 required
LookupSimSwap
object
When the number's SIM last changed. Returned when you request the simswap property.
4 properties 1 required
Error
object
1 property 1 required
LookupPorting
object
Whether the number has ever moved network, when it last did, and its full porting record. Returned when you request the porting property. The base lookup only…
5 properties 1 required
LookupProperty
string
An intelligence property you can add to a base phone number lookup. - classification: the property resolves linetype to its precise allocated service (premium…
EmailLookupFlag
string
A notable characteristic of an email address. - role: it addresses a function rather than a person (support@, info@). Replies and consent are therefore ambiguo…
PhoneNumberLookup
object
Information about a phone number. The number, its flags, and its line type are included in the base lookup and are always present. The country and two networks…
12 properties 3 required
LookupClassification
object
The allocated service of the number's range. Returned when you request the classification property. This sits beside linetype rather than replacing it, so you…
2 properties 1 required
LookupPortingEvent
object
One recorded move of a number between networks.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-lookup-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Lookup API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.