API Reference

All requests are performed via an HTTPS connection and responses are returned as JSON. All responses will contain a success parameter. This parameter will indicate whether the requested operation was successfully completed or if an error was encountered.

Always check the response status code to ensure the request was successfully received and successfully handled.

Success Response

All success responses follow the same schema:

{
    "email": "[email protected]",
    "user": "help",
    "domain": "unelmasupport.com",
    "accept_all": 0,
    "role": 0,
    "free_email": 0,
    "disposable": 0,
    "spamtrap": 0,
    "success": true,
    "result": "deliverable",
    "message": "This address can receive emails."
}

In the response, you’ll find the result parameter. This parameter will indicate the status of the email.

Error Response

All error responses follow the same schema:

{
    "message": "Unauthorized"
}