Responses

All data is received as JSON.

Each response sent from the API contains a success parameter which is of 0/1 type, indicating whether the request was successful or not (successful is 1 and unsuccessful is 0). Upon success being 0, an optional error parameter (string) may be given. In case of success is 1, the response is always contained within a data parameter.

Success Response

All success responses follow the same schema:

JSON

HTTP/1.1 200 OK

{
    "success": 1,
    "data": {
        "email": "[email protected]",
        "email_status": "valid",
        "disposable_email": false,
        "dns_records_validation": true,
	      "mx_found": true,
        "mx_record": "gmail-smtp-in.l.google.com.",
        "full_inbox": false,
        "catch_all": false,
        "deliverable": true,
        "disabled": false,
        "valid_syntax": false,
        "domain": "gmail.com",
        "account": "john.doe",
      	"did_you_mean":""
    }
}

Error Response

All error responses follow the same schema:

JSON

HTTP/1.1 401 Unauthorized

{
    "success": 0,
    "data": {
        "error": "invalid api key"
    }
}