Check an email address, domain or website URL (recommended)

post/v1/check

Request

  • Base URL: https://api.isbusinessemail.com
  • URL: https://api.isbusinessemail.com/v1/check
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

emailstring
domainstring
urlstring

A website address; its host (without www.) is checked.

policy'b2b' | 'strict' | 'lenient'
deepboolean
workspaceboolean

false skips the Microsoft tenant lookup.

Response

Verdict

emailstring nullable

The address as sent (null for domain and URL checks).

urlstring

Only for URL checks: the website address as sent. Its host (without www.) is the checked domain.

normalized_emailstring nullable

Lowercased, IDN-normalised, +tag removed.

domainstring nullable required
is_businessboolean required

True for business, education and government.

category'business' | 'personal' | 'disposable' | 'relay' | 'education' | 'government' | 'invalid' | 'unknown' required
confidencenumber required
recommendation'allow' | 'review' | 'block' required
policy'b2b' | 'strict' | 'lenient'
is_free_providerboolean
is_disposableboolean
is_relayboolean
is_role_accountboolean
is_blockedboolean
is_new_domainboolean
is_lookalikeboolean
has_subaddressboolean
did_you_meanstring nullable

Suggested domain for a likely typo.

domain_age_daysinteger nullable
reasonsstring[] required

See https://isbusinessemail.com/docs/reason-codes

degradedboolean

DNS was unavailable; the verdict is from lists only.

cachedboolean
took_msinteger
request_idstring

Example response

{
  "shared_inbox": {
    "match": "support"
  },
  "group": {
    "match": "team"
  },
  "mail": {
    "provider": "google_workspace"
  },
  "workspace": {
    "microsoft_365": {
      "identity_provider": "okta"
    }
  },
  "mailbox": {
    "provider": "google_workspace",
    "gateway": "proofpoint"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.