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
  • EmailAddress
  • EmailList
  • EmailRestRequest
  • EmailRestResponse
  • ValidatedEmailAddress <<extends>> EmailAddress
  • FeatureOption
  1. Loqate Harmony API
  2. API Specification
  3. Objects

Email Objects

An Email address for validation.

Container for Email addresses.

Request wrapper for email REST methods.

Response wrapper for email REST methods.

An Email address object containing the results of the validation.

EmailAddress

The EmailAddress is used to supply email addresses for validation.

address

Type: StringThe email address (e.g. 'bob@example.org').

JSON Representation

{
    "address": "bob@example.org"
}

EmailList

An array or list of EmailAddress structures.

JSON Representation

[ 
    { 
        address: "bob@example.org" 
    },
    {
        address: "sarah@example.org"
    },
    ... 
]

EmailRestRequest

An EmailRestRequest object is used when invoking the Harmony RightAddress email validation REST service methods.

payload

The list of EmailAddress structures being passed to the REST service method.

sourceOfTruth

Type: String

The Source of Truth to use for the validation.

featureOptions

An Object containing the values for the feature options available for the validation.

JSON Representation

{
    "payload": [ { "address": "bob@example.org" } ],
    "sourceOfTruth": "VE_ALL",
    "featureOptions: { "timeout": "1500" }
}

EmailRestResponse

An EmailRestResponse object is returned from the Harmony RightAddress email validation REST service methods.

payload

The list of EmailAddress structures being returned from the REST service method.

status

Type: String

The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[]

Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [ 
        {
            "address": "bob@example.org"
        }
    ]
}

A ValidatedEmailAddress object extends a standard EmailAddress object and is returned in the validate method response.

formatValidated

Type: Boolean

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

blackListValidated

Type: Boolean

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

domainValidated

Type: Boolean

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

mailServerValidated

Type: Boolean

mailserver_exists: True if there is a mail server for that domain, false otherwise.

mailboxValidated

Type: Boolean

email_exists: true if the mailbox for the email address has been found to exist without sending an email, false otherwise.

JSON Representation

{
    "address": "bob@example.org",
    "mailBoxValidated": false,
    "mailServerValidated": false,
    "domainValidated": false,
    "blackListValidated": true,
    "formatValidated": true
}

FeatureOption

A FeatureOption object is used to supply option values when invoking the email validation REST service methods.

timeout

Type: String

Value of the timeout in milliseconds, if the validation process takes longer than the time specified, timeout error message will be given. Default value is 10000ms (10 seconds).

JSON Representation

{
    "timeout": "1500"
}
PreviousParse ObjectsNextPhone Objects

Last updated 1 year ago

Type:

Type:

Type:

ValidatedEmailAddress <<extends>>

See for inherited attributes.

EmailList
FeatureOption
EmailList
EmailAddress
EmailAddress
EmailAddress
EmailList
EmailRestRequest
EmailRestResponse
ValidatedEmailAddress