POST /identifiers/_validateΒΆ
Validate an identifier (e.g. email addresses).
Body parameters:
Name |
Type |
Description |
---|---|---|
|
string, required |
identifier to validate |
|
integer, optional, min: 3, max: 15 |
timeout while validating |
Example request:
POST /identifiers/_validate HTTP/1.1
Host: api.ereceipts.co.uk
Accept: application/json
Content-Length: 39
Content-Type: application/json
{
"identifier": "valid@example.com"
}
Example responses:
Valid identifier:
HTTP/1.1 200 OK
Content-Type: application/json
{
"details": {
"accept_all": false,
"did_you_mean": null,
"disposable": false,
"domain": "example.com",
"email": "valid@example.com",
"free": false,
"message": null,
"reason": "accepted_email",
"result": "deliverable",
"role": false,
"sendex": 1,
"success": true,
"user": "valid"
},
"provider": "X001",
"status": "valid",
"suggestions": []
}
Invalid identifier:
HTTP/1.1 200 OK
Content-Type: application/json
{
"details": {
"accept_all": false,
"did_you_mean": null,
"disposable": false,
"domain": "example.com",
"email": "invalid@example.com",
"free": false,
"message": null,
"reason": "rejected_email",
"result": "undeliverable",
"role": true,
"sendex": 0,
"success": true,
"user": "invalid"
},
"provider": "X001",
"status": "invalid",
"suggestions": []
}