Loqate Harmony Documentation
  • GBG Loqate AU & NZ
  • Loqate Harmony API
    • Sign up for free trial
    • Login
    • API Specification
      • Authentication
      • Address
        • Address Validation & Lookup
        • Address by Geocode
        • Address Cleanse
        • Address Parse
        • Geocode Intl
      • Address Insights
        • Australian Insights
          • SEIFA Australia
          • ASGS Australia Statistical Geography Standard
          • Residential / Commercial
          • Deliverable address
      • Suburb Lookup
      • Business Validation and Lookup
      • Email Validation
      • Phone Validation
      • Matching
      • Moved Suppression
      • Deceased Suppression
      • Objects
        • Address Objects
        • Address Type Objects
        • Suburb Objects
        • Parse Objects
        • Email Objects
        • Phone Objects
        • Property Title Objects
        • Match Objects
        • Business Objects
      • Deprecated API services
        • Email Validation v1.1
        • Address v1
        • Address Cleanse v1
        • Address International
        • Address Combined
        • Address Types
    • Guides
      • Best Practices
        • Address Field Mappings
        • Finding an Address
      • User Derived Address
      • Expanded sub-premise reach
      • Parcel Locker Plus
      • Migrating to Address V2
      • Sign up/ Login
      • Support
      • Console
        • Getting your API keys
        • Getting Started
        • Add a Service
        • Dashboard
        • Subscriptions
          • Features
          • Users
          • Subscribed Plans
          • Allowlisting domains
          • Blocklist - Email Validation
        • Reports
        • Invoices
          • Paying Invoices
      • API Latency
    • Demos
      • How to use our demos
      • Address Validation Demo
      • Address by Geocode (Reverse Geocode) Demo
      • Address Cleanse Demo
      • Address Parse Demo
      • Business Validation Demo
      • Email Validation Demo
      • Phone Validation demo
    • Integrations
      • Client Libraries
        • Javascript Library v2.1.0
      • Adobe Commerce (Magento 2) Plugin
        • Magento2 User Guide
      • Woocommerce Plugin
        • Woocommerce Install Guide v2.0.0
        • Woocommerce Settings guide v2.0.0
      • Shopify Plus App
      • Gravity Forms
      • Voxco Survey Software
      • Salesforce CRM
      • Dynamics 365 CRM
      • Batch App - Lightweight
      • Deprecated Integrations
        • Harmony RightAddress c# example
        • Harmony RightAddress cURL example
        • Deprecated JS Library v2.0.1
        • Deprecated JQuery Library v1.8.1
    • Coverage
    • Address Exchange (Beta)
      • ADX Console
        • Searching Addresses in console
        • Create Address in console
        • Create Actions in console
      • ADX API Specification
        • Create Address
        • Get Address
        • Create Address Event
        • Edit Address Event
        • Create/Edit Address Attributes
        • Create/Edit Address Geopoint
        • Get Source Events
      • Reserved Attributes
    • GBG Status
  • Batch / Bulk Data Services
    • Serviced Batch
      • Bulk Address Cleanse
      • Email Serviced Batch
      • Phone Serviced Batch
      • Business Serviced Batch
  • Harmony Suite
    • Harmony Suite Overview
    • Release Notes
      • Version 3.0.0
        • New Features
        • Enhancements
        • Bug Fixes
        • Supported Platforms
    • User Guides
      • Version 3.0.0
        • Welcome to Harmony Suite
        • Glossary of terms
        • Upgrades
          • HSQL Upgrade
        • Email and Phone Validation
          • Prerequisites
          • Phone and Email PDP Configuration Setup
          • Phone Validation using Harmony Batch System
          • Phone Validation using Harmony WS
          • Email Validation using Harmony Batch
          • Email Validation using Harmony WS
          • Guides
            • Understanding Phone Data
            • Understanding Email Data
        • Business Lookup and Validation
          • Prerequisites
          • Business Lookup
          • Business Validation
            • Business Validation using Commercial Name Parser
            • Business Validation Configurations
            • Business Validation using Harmony Batch System
            • Business Validation using Harmony WS
          • Business data update guide
          • Guides
            • Understanding Business Data
            • Understanding Business Verification Code
            • Name Parse Ambiguity
        • Australia Post Parcel Locker Plus Lookup and Validation
          • Prerequisites
          • Australia Post Parcel Locker Plus Lookup
          • Australia Post Parcel Locker Plus Validation
            • PDP Configuration Setup
            • AupostValidation using Harmony Batch System
            • AupostValidation using Harmony WS
          • Guides
            • Knowledgebase Lexical Update
            • Understanding Australia Post Parcel Locker Plus Data
            • Interchangeable terms for Australia Post Parcel Lockers
        • Installation and Upgrade Reference Guide
        • Locate Reference Guide
        • Extensions Reference Guide
        • RealTime Reference Guide
        • Postmaster Reference Guide
        • Rapid Address ANZ Reference Guide
        • Post ANZ Reference Guide
        • Source of Truth Installation Reference Guide
        • Knowledgebase Configuration Reference Guide
        • Web Services Reference Guide
        • Management Console Reference Guide
        • Batch System Match Reference Guide
        • Batch System Cleanse Reference Guide
  • More from GBG
    • GBG GreenID
    • GBG Identity
    • GBG Fraud & Compliance
Powered by GitBook
On this page
  • Email Validation JSON Payload
  • Reason List
  • Understanding Email Validation Exceptions
  1. Harmony Suite
  2. User Guides
  3. Version 3.0.0
  4. Email and Phone Validation
  5. Guides

Understanding Email Data

This section includes explanation of all the enriched information returned by Email Validation PDP.

Email Validation JSON Payload

Element Name
Description
Example

emailAddress

the email address that is being validated.

jim@hotmail.com

mailBoxValidated

Determines if the mailbox for the email address exists. true if deliverable, false otherwise.

true/false

mailServerValidated

Determines if the mailserver is valid or not. It will validate do_not_send. If onboarding (particularly B2B) use this. If marketing, use deliverable.

true if there is a mail server for that domain, false otherwise.

true/false

domainValidated

Determines if the domain is valid or not.

true if the domain of the email address exists and has proper Domain Name Server (DNS) records, false otherwise.

true/false

blackListValidated

Determines if the user has blocked this email address.

true if the email address does not appear in the internal email block list, false otherwise.

true/false

formatValidated

Determines if the syntax of the email address is valid.

true if the email address syntax conforms to RFC 2822 standard,false otherwise.

true/false

email_valid

Attribute of the email format validation. Determines if the email format is valid or not.

Valid - format is valid.

(blank) - format is invalid and API timeout.

VALID, (blank)

domain_exists

Attribute of the domain validation. Determines if the domain exists and can receive email.

Valid - domain exists.

Invalid - domain does not exist or can't receive email.

Unknown - unable to determine if valid or not, check email.

VALID, INVALID, UNKNOWN

mailserver_exists

Attribute of the mailserver validation. Determines if the mailserver is valid or not.

Valid - mailserver exists.

Invalid - there is no mail server present at this domain.

Unknown - unable to determine if valid or not, check email.

VALID, INVALID, UNKNOWN

email_exists

Attribute of the mailbox validation.

Valid - email is verified.

Invalid - email address does not exist on mail server.

Unknown - unable to verify email address.

VALID, INVALID, UNKNOWN

message

additional information

Email verified.

Domain does not exist or cannot receive email.

Email address does not exist on mail server.

Please check email, unable to determine if valid or invalid.

This mail server accepts all requests. Unable to verify email address.

do_not_send

Often these emails cause you reputation damage on email sending platforms.

true/false

disposable

Known Temporary email address that is used to hide the real email address of the user. These usual last 15 min to 6 months.

true/false

rolebased

Role based email (e.g., sales@, marketing@) and not an individual's email address.

true/false

catchAll

Catch all based email (e.g., donotreply@ client@) and not an individual's email address.

true/false

subdomain

email is subdomain email.

true/false

account

The portion of the email address before the "@" symbol.

jim

domain

The portion of the email address after the "@" symbol.

hotmail.com

risk

Potential impact on sender reputation score depending on all aspects.

LOW, MEDIUM, HIGH, UNKNOWN

suggested_email

Suggestive Fix for an email typo

jim@hotmail.com

deliverable

status type field

deliverable, undeliverable, do_not_send, catch_all or unknown

reason

List of reasons validation was unsuccessful

hashsha256

Hashed using sha256

4c93fb55adc02....

Reason List

Reason
Description

catch_all

The validity of the recipient address cannot be determined as the provider accepts any and all email regardless of whether or not the recipient’s mailbox exists.

disallow_list

Email is on your disallow list.

failed custom grammar check

The mailbox failed our local-part grammar check.

format_failed

Failed format syntax check.

high_risk_domain

Information obtained about the domain indicates it is high risk to send email to.

immature_domain

The domain is newly created based on the WHOIS information.

long_term_disposable

The mailbox has been identified as a long term disposable address. Long term disposable addresses can be quickly and easily deactivated by users, but they will not expire without user intervention.

mailbox_does_not_exist

The mailbox is undeliverable or does not exist.

mailbox_is_disposable_address

The mailbox has been identified to be a disposable address. Disposable address are temporary, generally one time use, addresses.

mailbox_is_role_address

The mailbox is a role based address (ex. support@…, marketing@…).

no_mx / No MX host found

The recipient domain does not have a valid MX host.

req_timeout

Timed out by request timeout setting e.g. your timeout setting. You may need to increase your timeout setting.

smtp_timeout

Timed out by smtp provider.

subdomain_mailer

The recipient domain is identified to be a subdomain and is not on our exception list. Subdomains are considered to be high risk as many spammers and malicious actors utilize them.

tld_risk

The domain has a top-level-domain (TLD) that has been identified as high risk.

unknown_provider

The MX provider is an unknown provider.

Understanding Email Validation Exceptions

Exception generated for an email with invalid domain.

{
    "exceptions": [
        {
            "code": "H148",
            "category": "VALIDATOR",
            "description": "No MX and A entry in the Domain Name System (DNS) - gmail.com.au: 12345@gmail.com.au",
            "inputType": "EMAIL_DATA",
            "inputData": "12345@gmail.com.au",
            "message": "H148 : No MX and A entry in the Domain Name System (DNS) - gmail.com.au: 12345@gmail.com.au",
            "localizedMessage": "H148 : No MX and A entry in the Domain Name System (DNS) - gmail.com.au: 12345@gmail.com.au"
        }
    ]
}

Exception generated for an email that does not conform to syntax rules outlined in RFC 2822 standard

{
    "exceptions": [
        {
            "code": "H146",
            "category": "VALIDATOR",
            "description": "Invalid syntax of email address (RFC-2822 compliant): jim<>@hotmail.com",
            "inputType": "EMAIL_DATA",
            "inputData": "jim<>@hotmail.com",
            "message": "H146 : Invalid syntax of email address (RFC-2822 compliant): jim<>@hotmail.com",
            "localizedMessage": "H146 : Invalid syntax of email address (RFC-2822 compliant): jim<>@hotmail.com"
        }
    ]
}
PreviousUnderstanding Phone DataNextBusiness Lookup and Validation

Last updated 1 year ago

You can block email addresses via

see

Harmony Console
reason list