latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lookup

Email Lookup

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Lookup/doEmailLookup" target="_blank">Try in sandbox</a><br>To get more details about an email address or to check whether it is a valid email or not, you can use the Email Lookup command. To upload and check emails in bulk, please use our Web app.

This API call allows you to retrieve additional information about an email address, such as mailbox detection, syntax checks, DNS validation, deliverability status, and many more helpful values (see the table below).

Emails must be checked one by one. You cannot check multiple emails in one request. To upload and check emails in bulk, please use our Web app.

get/api/v2/email-lookups/{email}

Path parameters

emailstring email required

Email address.

Response

Returned when successful.

addressstring email required

The email address passed to the call.

status'valid' | 'invalid' required

The email is valid or invalid.

deliverabilitystring required

The delivery status of the email address isdeliverable, undeliverable. or unknown.

reasonstring nullable required

The reason why the checked email is invalid/undeliverable.

riskstring required

The risk score of the email ishigh, medium, low or null.

addressType'corporate' | 'free' required

The email address type (domain) is free or corporate.

isDisposableAddressboolean required

This is true if the domain is in the list of disposable email addresses; otherwise, it returns as false.

suggestionstring nullable required

Null if nothing is suggested; however, if there is a potential typo in the email address, the closest suggestion is provided.

emailRolestring nullable required

Checks the mailbox part of the email to see whether it matches a specific role type (‘admin’, ‘sales’, ‘webmaster’).

localPartstring required

The local part of the email address.

domainPartstring required

The domain part of the email address.

exchangestring nullable required

Email exchange server domain name (MX record value).

preferenceinteger nullable required

MX record preference.

isInWhiteListboolean required

true if the email address exists in the Textmagic whitelist.

isInBlackListboolean required

true if the email address exists in the Textmagic blacklist.

hasMxboolean required

true if the email address domain has an MX record.

hasAaboolean required

true if the email address domain has an A record (IPv4).

hasAaaaboolean required

true if the email address domain has an AAAA record (IPv6).

Example response

{
  "address": "john@sample.com",
  "deliverability": "undeliverable",
  "reason": "No MX host found",
  "risk": "high",
  "addressType": "corporate",
  "suggestion": "john@sample.com",
  "emailRole": "admin",
  "localPart": "john",
  "domainPart": "sample.com",
  "exchange": "mx1.textmagic.com",
  "preference": 10,
  "hasMx": true,
  "hasAa": true,
  "hasAaaa": true
}