Check

Check domain or email

This API enables you to swiftly determine the type of email domain (whether it's free, disposable, or work-related) or obtain basic information about an email address (such as whether it's a personal or role-based address, and if the email format is valid). It proves valuable in preventing unwanted emails, for instance, by blocking disposable emails during sign-up processes or free emails for demo request forms.<br><br> Cost: Each successful request will deduct 1 credit from your Check Plan. Please note that this is separate from the credits you use for verifying email addresses. To check your remaining credits for each type, kindly visit the following page: https://bounceban.com/app/account/billing

get/v1/check

Request

  • Base URL: https://api.bounceban.com
  • URL: https://api.bounceban.com/v1/check
  • Auth: API key in header Authorization

Query parameters

emailstring

(Optional) Please provide the email that needs to be checked. If both the email and domain parameters are provided, the system will only consider the email parameter.

domainstring

(Optional) Please provide the domain that needs to be checked. If both the email and domain parameters are provided, the system will only consider the email parameter.

Response

Indicates the request is successful.

status'success' | 'error'

The status for the task

success The request is successful<br> error The request has failed. You should try again.

domain_type'work' | 'disposable' | 'free'

The domain type work indicates that it is a business email domain, like my_company.com. On the other hand, free indicates that it is a free email domain, like gmail.com. Lastly, disposable refers to a disposable domain, such as 001xs.org.

username_type'personal' | 'role'

The local part (username) determines the type of email address. This information is only provided if you have submitted an email. For example, a role email would be sales@example.com, while a personal email would be john@example.com.

syntax_validboolean

It verifies the validity of the email's syntax. For instance, if you submit k&32@example.com, it will return false.

credits_consumednumber float

Credits consumed for this task.

credits_remainingnumber float

Credits remaining in your account after the current task. -1 means unlimited. Only returned for some custom plans.

Changes

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