Analyze an email address
Changed onRuns one email address through the pipeline and returns a single record describing it: its parts (local, username, tag, domain), the top-level domain and the country that administers it, what's known about the domain (mail provider, category, live MX records, SPF and DMARC policy, registration dates), whether it has a Gravatar, a did_you_mean correction for likely typos, and boolean attributes such as is_free, is_disposable, is_forwarder, and is_likely_role_based. The address is read from email, or from q as an alias, and one of the two is required; a request naming neither is rejected with a 400 (email_intelligence.email_missing). A malformed address is not an error: it answers 200 with attributes.is_valid_syntax false and no lookups run. Every response carries the same shape, and a value the data can't name comes back null. Omitting a branch with response_fields_omit also skips the lookup behind it (for example gravatar or domain.registration), which makes the request faster. See https://restcountries.com/docs/email-intelligence for the full reference.
Request
- Base URLhttps://api.restcountries.com
- Auth
- HTTP bearer
- or API key in query parameter api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Email address to analyze. Required unless the q alias is supplied instead; email wins when both are present. Encode a + in plus-addressed aliases as %2B, since a bare + is read as a space.
Alias for email, used only when email is absent.
Comma-separated dot-path projection. Only the specified fields are returned. Example: names.common,codes.alpha_2,flag.emoji
Comma-separated dot-path blocklist. The specified fields are removed from the response. Useful for trimming heavy branches like names.translations.
Set to true (a bare ?pretty, 1, or true) to pretty-print the JSON response; 0 or false keep it minified. Default is minified.
Response
Analysis record for the requested email address, always a single object.
Changes
- info
endpoint added
- info