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
  1. Harmony Suite
  2. User Guides
  3. Version 3.0.0
  4. Business Lookup and Validation
  5. Business Validation

Business Validation using Commercial Name Parser

Information about commercial name parser within the context of Business Validation PDP

PreviousBusiness ValidationNextBusiness Validation Configurations

Last updated 1 year ago

It's crucial to emphasize that every commercial name undergoes parsing, and the parsed outcome from the parser is then subjected to standardization PDP or validation via Business Validation PDPs.

Brief Explanation of Standardization:

Standardization is a way of achieving consistency across company legal terms etc. for e.g. the user would want to standardize company term "proprietary" to pty" before its fed to Business Validation PDPs. Refer page no 101 of for details on standardization.

This standardization can be achieved using CompanyNameStandardization PDP.

Brief Explanation of Business Validation:

This process serves to further validate the standardized business data to reduce errors and guarantee the accuracy of business information.

Start Parse

User will need to pick the Client Role and Locale (AUSTRALIA/NEW_ZEALAND) to tokenize the company data.

Here is an explanation of commercial name parse using default DEMO role for COMPANY_DATA model. Using this role ensures the company data is parsed and standardized.

Sample 1: Single company name parse

Refer companyName json object to see that the input has been parsed as an "organisationalName" and the company terms are standardized.

// Input
{
    "harmonyServiceConfig": {
        "role": "DEMO",
        "locale":"AUSTRALIA"
    
    },
    "parserInput": {
        "rawDataInput": {
            "companyName": {
                "value": "1 CCTV Proprietary Limited"	
            }
        }
    }
}
// Response 
{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "containedInParties": false,
        "locationInParties": 0,
        "companyName": {
            "personalName": false,
            "companyName": "1 CCTV PTY LTD",
            "organisationalName": true,
            "nameQuality": 9
        }
    }
}

Sample 2: Multiple company name entities parse

// Input
{
    "harmonyServiceConfig": {
        "role": "DEMO",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
            "companyName": {
                "value": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones"
            }
            }
    }
}
// Response
{
    "ciqPartyRelationshipDocument": {
        "options": {
            "originalInput": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones",
            "exposeAttributes": "7"
        },
        "numberOfParties": 3,
        "parties": [
            {
                "pdpchangeContext": {},
                "containedInParties": true,
                "relationshipLabel": "person1",
                "locationInParties": 1,
                "personName": {
                    "personalName": true,
                    "lastName": "Graphix",
                    "firstName": "Eternal",
                    "organisationalName": false,
                    "fullName": "Eternal Graphix",
                    "nameQuality": 4
                }
            },
            {
                "pdpchangeContext": {},
                "containedInParties": true,
                "relationshipLabel": "organisation1",
                "locationInParties": 2,
                "companyName": {
                    "personalName": false,
                    "organisationalName": true,
                    "companyName": "Xyz pty ltd",
                    "nameQuality": 6
                }
            },
            {
                "pdpchangeContext": {},
                "containedInParties": true,
                "relationshipLabel": "person2",
                "locationInParties": 3,
                "personName": {
                    "personalName": true,
                    "lastName": "Jones",
                    "firstName": "James",
                    "organisationalName": false,
                    "fullName": "James Jones",
                    "nameQuality": 4
                }
            }
        ]
    },
    "relationships": [
        {
            "from": "person1",
            "to": "organisation1",
            "title": "trading",
            "arcrole": "http://www.msi.com.au/relationships/trading"
        },
        {
            "from": "organisation1",
            "to": "person2",
            "title": "trust",
            "arcrole": "http://www.msi.com.au/relationships/trust"
        }
    ]
}

Notes for Interpreting the Parsed JSON Objects of Sample 1 and Sample 2:

containedInParties in CIQPartyDocument represents tokenized presentation of input entity. containedInParties will be false for a single entity and true for multiple entities. This suggests that it contains or holds parties which could be individuals or organizations.

originalInput under options JSON object is only shown for company names.

  1. with containedInParties as true or

numberOfParties represent the actual count of the entities.

locationInParties represent the entity number.

relationships json object represents the relation of entities.

or for company names for which parsing has been surpassed in instances where the names are failed to parse by parser. For details refer .

Harmony Management Console Reference Guide
Parse exceptions