Get an email address lookup by URL
GET
/v1/lookup/email/{address}
curl -X GET "https://us1.platform.bird.com/v1/lookup/email/{address}" \
-H "Authorization: Bearer $TOKEN"Response200
{
"email": "aisha.khan@example.com",
"valid": true,
"result": "risky",
"delivery_confidence": 42,
"flags": [
"role",
"free_provider"
]
}
Performs the same deliverability lookup as Create an email address lookup, with the address in the URL. The response includes a result, confidence score, address characteristics, failure reason, and suggested correction when available. Treat unknown result and reason values as valid additions.
Because the address 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
address
string
The email address to look up. Percent-encode it, because a local part may legally contain characters a URL path reads as structure. The @ itself is safe either way.
Response Payload
email
string
required
The address that was looked up, exactly as you sent it.
valid
boolean
required
Whether the address is well-formed and its domain is set up to receive mail at all. It says nothing about the mailbox itself, so a valid domain with no such mailbox is true here and undeliverable in result.
result
string
required
delivery_confidence
integer
required
How likely mail to this address is to be delivered, from 0 (certain not to be) to 100 (certain to be). Read it alongside result rather than instead of it, because the same score can sit under neutral or risky for different reasons.
flags
array of string
required
Notable characteristics of the address. Empty when none apply.
reason
string
Why the address cannot receive mail. Absent unless result is undeliverable.
did_you_mean
string
The address this one looks like a misspelling of. Absent unless a correction was found, which in practice means result is typo. Offer it to whoever typed the original rather than sending to it unasked, because it is a guess and the address they meant may be neither one.