Programming Guide to the Hours of Service Platform

Email Validation

This API accepts an email address or a list of email addresses as parameter and returns a message if the email address/es is/are valid or not.

Fields

Tag Data Type Description
status Text Indicates if the email validation was successful or not. Returns “Success” if the email is valid and “Failure” if the validation failed
message Text Returns a message with the validation status.

Validate correct email address

API PATH: /api/v2/emailValidation?email-list=valid@email.com
METHOD: GET
PARAMETERS: email-list – The email address to be verified
EXAMPLE RESPONSE: 
{
  "status": "Success",
  "message": "Email validation was successful."
}

Validate incorrect email address

API PATH: /api/v2/emailValidation?email-list=invalid@@email.com
METHOD: GET
PARAMETERS: email-list – The email address to be verified
EXAMPLE RESPONSE: 
{
  "status": "Failure",
  "message": "Email list is invalid."
}