Email Validation API

• Provides email address validation using standard URL requests.
• The service follows RESTful principles – accepting HTTP requests and returning JSON response documents.

• To use this functionality you will need to buy an Email Validation click bundle from the Shop located in our Portal. Register for the Portal here.
• An email address is validated by sending a POST request to the URL:

https://api.hopewiser.com/email-verify/verify

where the request body contains the email address to verify. For example:

{
"email": "support@hopewiser.com"
}

• The service can respond with a status of either Completed or Processing. If the status is Processing, then the result should be obtained by making periodic GET requests for the returned resource ID. For example:

https://api.hopewiser.com/email-verify/verify/afe5bc5f-1078-422b-9a342-eba02ba8a395

• Authentication is achieved using HTTP Basic Authentication, where both the token username and password are supplied in the Authorization request header. To secure this information all requests should use the https:// protocol, in preference to standard http://.

How do I determine if my token can use the Email Validation API?

The Email Validation API is only available when your Portal account contains an active Email Validation plan. You can determine this by sending a GET request to the URL:

https://api.hopewiser.com/email-verify/provisioned

• The service will respond with the HTTP status code 200 (OK) if the token has been successfully authenticated. The response body will be a JSON object comprising a provisioned and optional blocked property.

Example response body:

{
"provisioned": true
}

How do I submit an email address for validation?

An email validation is initiated by sending a POST request to the URL:

https://api.hopewiser.com/email-verify/verify

Where the request body is a JSON object comprising a single mandatory property

For Example :

{
"email": "support@hopewiser.com"
}

How do I obtain the results for an email address validation?

If the returned status is Processing, then the validation result may be obtained by periodically sending a GET request. For example:

https://api.hopewiser.com/email-verify/verify/{id}

The ID should be replaced with the ID provided in the initial submission. For example:

https://api.hopewiser.com/email-verify/verify/afe5bc5f-1078-422b-9a342-eba02ba8a395

The service will respond with the HTTP status code 200 (OK) if the validation has completed. Otherwise, the HTTP status code 202 (Accepted) will be returned indicating that the validation is still being processed.

Results can be obtained up to 10 minutes from the initial request submission.

The response body will have the same structure as that returned for the initial POST request.

For all status codes, other than 200 (OK) and 202 (Accepted), a textual description of the response may also provided. For example:

{
     "status": "Not Found",
     "statusDetails": {
        "description": "The specified resource does not exist or is no longer available"
     }
}