API method email_check_one
 

• Common description
• Method's get parameters
• Response Explanation
• Restrictions
   

Method Description

In order to use EMAIL_CHECK_ONE method, you have to buy a separate license — BlackList API. Our prices are here: https://cleantalk.org/price-database-api

You can purchase it here on your billing page: https://cleantalk.org/my/bill/api

Method's response is information about the existence of an email address. The method is guaranteed to return a response in 60 seconds even if the process of email verification wasn't finished. In such a case the server will continue its work in background and the final decision might be retreived later.

Required GET Parameters:

• method_name — should be 'email_check_one'
• auth_key — Database API key. To obtain a key please get an account here: https://cleantalk.org/register?platform=api
• email — email address to check

Example request:

https://api.cleantalk.org/?method_name=email_check_one&auth_key=123456&email=stop_email@example.com

API returns JSON string, for example:

{"data":{"stop_email@example.com":"EXISTS"}}

Response Explanation:

data — contains a JSON object, where a singular key is the email and value is the status.

The status might be one of the following:

• EXISTS — address exists,
• NOT_EXISTS — address not exists,
• MX_FAIL, MX_ERROR — сannot obtain information about e-mail or domain.
• PROCESSING — address being checked at the moment.

Note: requests finished with the status "PROCESSING" do not count towards your BlackList API license usage limit. Although they will still count towards your rate limit.

Restrictions:

If you hit API's rate limit, API returns error notice. Example:

{"error_message":"Calls limit exceeded.","error_no":10}

The current rate limit is 100 per 60 seconds.

The recommended timeout is no more than 60 seconds.

You can ask us any question concerning the CleanTalk Anti-Spam via:

 — Private Ticket [ https://cleantalk.org/my/support/open ].