Email Validation using Harmony WS

This document provides instructions on utilizing the Harmony Restful WebServices for the Validation of email addresses using Email Validation PDPs in different locales.

API:

http://localhost:8080/HarmonyWS/rest/parseCustomerData

Role used in Webservice Request

Use the role detailed in PDP configuration setup.

Sample Request and Response

1. Pre Reading

Please ensure that you have read and understood the rule when you are running Email Validation. Although locale must be set in the request it doesn't impact the Email Validation results, user can choose either AUSTRALIA/NEW_ZEALAND as Default Locale. Refer guidance on Alignment of Default Locale and 'hosted.defaultCountry' for Phone Validation Users.

2. Request Samples

Request 1: Input Deliverable email

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"  //doesnot impact processing
     
    },
    "parserInput": {
        "rawDataInput": {
           
            "emailAddress":
            {
            	"value":"[e-mail]"
            }
        }
    }
}

Response 1: Validated Email that is DELIVERABLE.

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "emailAddress": {
            "emailAddress": "[e-mail]",
            "uniqueName": "jim",
            "domainName": "hotmail.com",
            "extraAttributes": {
                "catchAll": "false",
                "do_not_send": "false",
                "hashmd5": "3e9385d795906ee1a3e04aa93bfa3a41",
                "hashsha256": "4c93fb55adc0297ee4086a8d047ff7ca694784c690703eab0f215685db180f37",
                "domain_exists": "VALID",
                "mailserver_exists": "VALID",
                "deliverable": "DELIVERABLE",
                "email_valid": "VALID",
                "domainValidated": "true",
                "message": "Email verified.",
                "disposable": "false",
                "email_exists": "VALID",
                "do_not_mail": "false",
                "hashsha1": "7a90bf8dcac4717728d4f36e291ff17255dadeb2",
                "rolebased": "false",
                "mailBoxValidated": "true",
                "blackListValidated": "true",
                "domain": "hotmail.com",
                "formatValidated": "true",
                "subdomain": "false",
                "risk": "LOW",
                "emailValidated": "true",
                "account": "jim"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 2: Input Email Address that Doesn't Exist on Mail Server.

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"  //doesnot impact processing
        
     
    },
    "parserInput": {
        "rawDataInput": {
           
            "emailAddress":
            {
            	"value":"[e-mail]"
            }
        }
    }
}

Response 2: Undeliverable Email with Mail Box Not Validated

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "emailAddress": {
            "emailAddress": "[e-mail]",
            "uniqueName": "jimmy",
            "domainName": "yahoo.com",
            "extraAttributes": {
                "catchAll": "false",
                "reason": "[mailbox_does_not_exist]",
                "do_not_send": "false",
                "hashmd5": "efa811854abb0ad7de2579a349c2d470",
                "hashsha256": "1bc88ec6d822c4bd4c88b399ee7874effea66c26e5a1ac895dbd263792d26ca4",
                "domain_exists": "VALID",
                "mailserver_exists": "VALID",
                "deliverable": "UNDELIVERABLE",
                "email_valid": "VALID",
                "domainValidated": "true",
                "message": "Email address does not exist on mail server.",
                "disposable": "false",
                "email_exists": "INVALID",
                "do_not_mail": "false",
                "hashsha1": "225da63df3d2b1fb9fd6b49e7f8068da88c23733",
                "rolebased": "false",
                "mailBoxValidated": "false",
                "blackListValidated": "true",
                "domain": "yahoo.com",
                "formatValidated": "true",
                "subdomain": "false",
                "risk": "HIGH",
                "emailValidated": "true",
                "account": "jimmy"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 3: Input Timed Out by the SMTP Provider

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"  //doesnot impact processing
     
    },
    "parserInput": {
        "rawDataInput": {
           
            "emailAddress":
            {
            	"value":"[e-mail]"
            }
        }
    }
}

Response 3: Undeliverable Email with Reason Code: smtp_timeout

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "locationInParties": 0,
        "containedInParties": false,
        "emailAddress": {
            "emailAddress": "[e-mail]",
            "uniqueName": "thiswilltimeout",
            "domainName": "email.com",
            "extraAttributes": {
                "catchAll": "false",
                "reason": "[smtp_timeout]",
                "do_not_send": "false",
                "hashmd5": "cd4bdd475145f8b4bdacfedb1de18db2",
                "hashsha256": "62940336864af888c55aaf6b15cb23501449a5093b39cfa5ab59325dbbbc7093",
                "formateValidated": "true",
                "domain_exists": "VALID",
                "mailserver_exists": "VALID",
                "deliverable": "UNKNOWN",
                "email_valid": "VALID",
                "domainValidated": "true",
                "message": "Please check email, unable to determine if valid or invalid.",
                "disposable": "false",
                "email_exists": "UNKNOWN",
                "do_not_mail": "false",
                "hashsha1": "e84fec215fd77d9d9e3e827585dc000b0a1e2de3",
                "rolebased": "false",
                "mailBoxValidated": "false",
                "blackListValidated": "true",
                "domain": "email.com",
                "subdomain": "false",
                "risk": "UNKNOWN",
                "emailValidated": "true",
                "account": "thiswilltimeout"
            }
        }
    }
}