Checks an email address for validity at the requested level, and provides suggested corrections. The service can suggest corrections for misspelt email domains and mailboxes, and common errors such as incorrect punctuation. For the best results, supply the person's name as part of the record
parameter.
To connect to this service you'll need to use one of these endpoints:
Protocol | URL |
---|---|
JSON |
JSON
https://webservices.data-8.co.uk/EmailValidation/Cleanse.json |
OPEN API |
OPEN API
https://webservices.data-8.co.uk/swagger/EmailValidation/swagger.json |
SOAP |
SOAP
https://webservices.data-8.co.uk/emailvalidation.asmx |
Name | Description |
---|---|
username | username
See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix |
password | password
If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank. |
email
The email address to validate | |
level | level
The level to validate the
|
record | record
Additional details about the person or company the
|
options | options
An array of options that control further details of how this method operates. See the |
option
parameter. Each option is specified as a key/value pair.
The list of available names is shown below, along with a description of the allowable values for that name.
Name | Description |
---|---|
Common Options | |
ApplicationName |
ApplicationName
Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
|
Service Specific Options | |
MissingMXRecordHandling | MissingMXRecordHandling
If the The default Alternatively the values |
Name | Description |
---|---|
Status | Status
Indicates whether the method call was successful, or if some error occurred. If the |
Result | Result
A status code indicating if the email address could be validated. The following values are available:
|
OriginalValid | OriginalValid
Indicates if the original email address was valid before being corrected |
EmailType | EmailType
Indicates the type of email address that was supplied. This can be one of the following values:
|
SuggestedEmailAddress | SuggestedEmailAddress
A suggested correction of the supplied email address |
Comment | Comment
A free-text description of why the email address was modified |
Salutation | Salutation
The suggested name to be used in the greeting line of an email to this address |
StructureUsed | StructureUsed
A description of the structure of the username part of the email address |
ParsedName | ParsedName
A parsed name constructed from the email address |
Each request to this method consumes 1 EmailValidation credit.
Request Format
{ "email": "joe.blogs@data-8.co.uk", "level": "MX", "record": null, "options": { "MissingMXRecordHandling": "ServerCheck" } }
Response Format
{ "Status": { "Success": true, "CreditsRemaining": 1000 }, "Result": "CatchAll", "OriginalValid": true, "EmailType": "Personal", "SuggestedEmailAddress": "joe.bloggs@data-8.co.uk", "Comment": "Potential Mispelling detected in blogs", "Salutation": "Joe", "StructureUsed": "<FORENAME>.<SURNAME>", "ParsedName": { "Forename": "Joe", "Surname": "Blogs" } }
Depending on your chosen authentication method you will need to modify this request slightly:
API Key
https://webservices.data-8.co.uk/EmailValidation/Cleanse.json?key=your-api-key
and do NOT include the
username
or password
properties in the request JSON document.
Username and Password
https://webservices.data-8.co.uk/EmailValidation/Cleanse.json
and include
username
and password
properties in the request JSON document.Do not use for client-side requests!
JWT Token
https://webservices.data-8.co.uk/EmailValidation/Cleanse.json
Include the JWT token in the request headers as:
Authorization: Bearer your-jwt-token
Parameter | Value |
---|---|
Parameters | |
email
| |
level | level
|
record | |
CompanyName | CompanyName
|
Name | |
Name | Title
Forename
MiddleName
Surname
|
Address | |
Address | Lines |
Common Options | |
ApplicationName |
ApplicationName
|
Service-Specific Options | |
MissingMXRecordHandling |
MissingMXRecordHandling |
Credits Remaining Today: 5 |