Business Validation using Harmony WS
This document provides instructions on utilizing the Harmony Restful WebServices for the Validation of business samples using Business Validation PDPs in different locales.
API:
http://localhost:8080/HarmonyWS/rest/parseCustomerDataRole used in Webservice Request
Sample Request and Response for Australia
Response 1 to 3 illustrates single company entity. Irrespective of whether the input is a main entity name, trading name, business names or other entity name the response will always depict the rule name as MainName in business_ver_code.
Request 1: Input main entity name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "AUGUSTA AUTO MART PTY LTD"
}
}
}
}
Response 1: Exact match to the input
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"locationInParties": 0,
"containedInParties": false,
"companyName": {
"companyName": "AUGUSTA AUTO MART PTY LTD",
"personalName": false,
"organisationalName": true,
"nameQuality": 9
},
"customAttributes": {
"business_name": "AUGUSTA AUTO MART PTY LTD",
"business_tax_status_from_date": "20030210",
"business_display_name": "AUGUSTA AUTO MART PTY LTD",
"business_ver_code": "MainName_1_1.0",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "31103593666",
"business_cn": "103593666",
"business_entity_type_ind": "PRV",
"business_postcode": "5700",
"business_bn_status_from_date": "20030205",
"business_month_as_tax_business": "251",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "251",
"business_last_updated_date": "20200214",
"business_other_entities": "[{\"entity_name\":\"AUGUSTA AUTO MART\",\"entity_type\":\"TRD\"},{\"entity_name\":\"PORT AUGUSTA WINDSCREENS AND RADIATORS\",\"entity_type\":\"OTN\"},{\"entity_name\":\"AUGUSTA 4WD\",\"entity_type\":\"BN\"},{\"entity_name\":\"Augusta 4x4\",\"entity_type\":\"BN\"},{\"entity_name\":\"Auto One Port Augusta\",\"entity_type\":\"BN\"},{\"entity_name\":\"Drop Bear 4x4 & Leisure\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "SA"
}
}
}Request 2: Input misspelt business name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "SAFETYFAURST FOOD CONSULTANCY"
}
}
}
}
Response 2: Response shows validated business information. business_display_name holds the corrected business_name.
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"locationInParties": 0,
"containedInParties": false,
"companyName": {
"companyName": "SAFETYFAURST FOOD CONSULTANCY",
"personalName": false,
"organisationalName": true,
"nameQuality": 9
},
"customAttributes": {
"business_name": "BEN CONE",
"business_tax_status_from_date": "20150831",
"business_display_name": "BEN CONE Trading As SAFETYFIRST FOOD CONSULTANCY",
"business_ver_code": "MainName_1_0.3333333333333333",
"business_name_entity_type": "LGL",
"business_bn": "61537423057",
"business_entity_type_ind": "IND",
"business_postcode": "2768",
"business_bn_status_from_date": "20150831",
"business_month_as_tax_business": "101",
"business_entity_type_text": "Individual/Sole Trader",
"business_country": "au",
"business_month_in_business": "101",
"business_last_updated_date": "20230713",
"business_other_entities": "[{\"entity_name\":\"SAFETYFIRST FOOD CONSULTANCY\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "NSW"
}
}
}Request 3: Input Trading Name
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "AUGUSTA 4WD SERVICE CENTRE"
}
}
}Response 3: Response shows validated business information. business_display_name holds the trading name.
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"locationInParties": 0,
"containedInParties": false,
"companyName": {
"companyName": "AUGUSTA 4WD SERVICE CENTRE",
"personalName": false,
"organisationalName": true,
"nameQuality": 9
},
"customAttributes": {
"business_name": "ANDREW STEPHEN FITZGERALD",
"business_tax_status_from_date": "20180401",
"business_display_name": "ANDREW STEPHEN FITZGERALD Trading As AUGUSTA 4WD SERVICE CENTRE",
"business_ver_code": "MainName_1_1.0",
"business_name_entity_type": "LGL",
"business_bn": "61749773494",
"business_entity_type_ind": "IND",
"business_postcode": "5700",
"business_bn_status_from_date": "20000401",
"business_entity_type_text": "Individual/Sole Trader",
"business_country": "au",
"business_month_in_business": "286",
"business_last_updated_date": "20180501",
"business_other_entities": "[{\"entity_name\":\"AUGUSTA 4WD SERVICE CENTRE\",\"entity_type\":\"TRD\"},{\"entity_name\":\"AUGUSTA 4WD SERVICE CENTRE\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "CAN",
"business_state": "SA"
}
}
}Response 4 to 9 illustrates complex business structures with multiple entities.
These samples depict the order of priority for rules as listed in matching rules list.
Request 4: Validate a Complex business with multiple entities, person name trading as another business name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "BEN CONE Trading As SAFETYFIRST FOOD CONSULTANCY"
}
}
}
}
Response 4: Match found using MainName
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "BEN CONE Trading As SAFETYFIRST FOOD CONSULTANCY",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"locationInParties": 1,
"containedInParties": true,
"customAttributes": {
"business_name": "BEN CONE",
"business_tax_status_from_date": "20150831",
"business_display_name": "BEN CONE",
"business_ver_code": "MainName_1_1.0",
"business_name_entity_type": "LGL",
"business_bn": "61537423057",
"business_entity_type_ind": "IND",
"business_postcode": "2768",
"business_bn_status_from_date": "20150831",
"business_month_as_tax_business": "101",
"business_entity_type_text": "Individual/Sole Trader",
"business_country": "au",
"business_month_in_business": "101",
"business_last_updated_date": "20230713",
"business_other_entities": "[{\"entity_name\":\"SAFETYFIRST FOOD CONSULTANCY\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "NSW"
},
"personName": {
"fullName": "BEN CONE",
"personalName": true,
"firstName": "BEN",
"lastName": "CONE",
"organisationalName": false,
"nameQuality": 4
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation1",
"locationInParties": 2,
"containedInParties": true,
"companyName": {
"companyName": "SAFETYFIRST FOOD CONSULTANCY",
"personalName": false,
"organisationalName": true,
"nameQuality": 9
}
}
],
"numberOfParties": 2
},
"relationships": [
{
"from": "person1",
"to": "organisation1",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
}
]
}Request 5: Validate a Complex business with main entity trading as a business in trust for beneficiary. Sample for an ambiguous match.
Sample for an ambiguous match
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones"
}
}
}
}Response 5: Response shows an ambiguous match using BeneficiaryName. No further rules are validated due to ambiguity.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"locationInParties": 1,
"containedInParties": true,
"personName": {
"fullName": "Eternal Graphix",
"personalName": true,
"firstName": "Eternal",
"lastName": "Graphix",
"organisationalName": false,
"nameQuality": 4
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation1",
"locationInParties": 2,
"containedInParties": true,
"companyName": {
"companyName": "Xyz pty ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 6
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "person2",
"locationInParties": 3,
"containedInParties": true,
"customAttributes": {
"business_ver_code": "BeneficiaryName_6_1.0"
},
"personName": {
"fullName": "James Jones",
"personalName": true,
"firstName": "James",
"lastName": "Jones",
"organisationalName": false,
"nameQuality": 4
}
}
],
"numberOfParties": 3
},
"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"
}
]
}These samples depict the order of priority for rules as listed in matching rules list.
Request 6: Complex business entity, match found on BeneficiaryName.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Eternal Graphix trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd"
}
}
}
}
Response 6: Exact Match found on BeneficiaryName.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Eternal Graphix trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"locationInParties": 1,
"containedInParties": true,
"personName": {
"fullName": "Eternal Graphix",
"personalName": true,
"firstName": "Eternal",
"lastName": "Graphix",
"organisationalName": false,
"nameQuality": 4
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation1",
"locationInParties": 2,
"containedInParties": true,
"companyName": {
"companyName": "Xyz pty ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 6
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation2",
"locationInParties": 3,
"containedInParties": true,
"companyName": {
"companyName": "Mastersoft Pty Ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 8
},
"customAttributes": {
"business_name": "MASTERSOFT PTY. LTD.",
"business_tax_status_from_date": "20211002",
"business_display_name": "MASTERSOFT PTY. LTD. Trading As MASTERSOFT PTY LTD",
"business_ver_code": "BeneficiaryName_1_1.0",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "15007342029",
"business_cn": "007342029",
"business_entity_type_ind": "PRV",
"business_postcode": "3144",
"business_bn_status_from_date": "20000501",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "285",
"business_last_updated_date": "20211028",
"business_other_entities": "[{\"entity_name\":\"MASTERSOFT PTY LTD\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT",
"business_tax_status": "CAN",
"business_state": "VIC"
}
}
],
"numberOfParties": 3
},
"relationships": [
{
"from": "person1",
"to": "organisation1",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation1",
"to": "organisation2",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 7: Complex business entity, match found on MainName
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Eternal Graphix trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd xzxz"
}
}
}
}
Response 7: Exact match found on MainName
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Eternal Graphix trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd xzxz",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"locationInParties": 1,
"containedInParties": true,
"customAttributes": {
"business_name": "ABC Pty Ltd",
"business_tax_status_from_date": "19000101",
"business_display_name": "ABC Pty Ltd Trading As Eternal Graphix",
"business_ver_code": "MainName_1_1.0",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "43154618498",
"business_cn": "154618498",
"business_entity_type_ind": "PRV",
"business_postcode": "4216",
"business_bn_status_from_date": "20120410",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "141",
"business_last_updated_date": "20210616",
"business_other_entities": "[{\"entity_name\":\"ABC Pty Ltd\",\"entity_type\":\"TRD\"},{\"entity_name\":\"ABC Gold\",\"entity_type\":\"BN\"},{\"entity_name\":\"Eternal Graphics\",\"entity_type\":\"BN\"},{\"entity_name\":\"Eternal Graphix\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "NON",
"business_state": "QLD"
},
"personName": {
"fullName": "Eternal Graphix",
"personalName": true,
"firstName": "Eternal",
"lastName": "Graphix",
"organisationalName": false,
"nameQuality": 4
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation1",
"locationInParties": 2,
"containedInParties": true,
"companyName": {
"companyName": "Xyz pty ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 6
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation2",
"locationInParties": 3,
"containedInParties": true,
"companyName": {
"companyName": "Mastersoft Pty Ltd xzxz",
"personalName": false,
"organisationalName": true,
"nameQuality": 8
}
}
],
"numberOfParties": 3
},
"relationships": [
{
"from": "person1",
"to": "organisation1",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation1",
"to": "organisation2",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 8: Complex business entity, match found on TradingName
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Eternal Graphix XZ XZ trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd xzxz"
}
}
}
}
Response 8: Exact Match found on TradingName
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Eternal Graphix XZ XZ trading as Xyz pty ltd as trustee for Mastersoft Pty Ltd xzxz",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"locationInParties": 1,
"containedInParties": true,
"personName": {
"fullName": "Eternal Graphix X Z XZ",
"personalName": true,
"firstName": "Eternal",
"middleName": "Graphix X Z",
"lastName": "XZ",
"organisationalName": false,
"nameQuality": 7
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation1",
"locationInParties": 2,
"containedInParties": true,
"companyName": {
"companyName": "Xyz pty ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 6
},
"customAttributes": {
"business_name": "XYZ PLUMBING PTY LTD",
"business_tax_status_from_date": "20020214",
"business_display_name": "XYZ PLUMBING PTY LTD Trading As XYZ PTY LTD",
"business_ver_code": "TradingName_1_1.0",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "93099586535",
"business_cn": "099586535",
"business_entity_type_ind": "PRV",
"business_postcode": "2208",
"business_bn_status_from_date": "20020214",
"business_month_as_tax_business": "263",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "263",
"business_last_updated_date": "20110815",
"business_other_entities": "[{\"entity_name\":\"XYZ PTY LTD\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "NSW"
}
},
{
"pdpchangeContext": {},
"relationshipLabel": "organisation2",
"locationInParties": 3,
"containedInParties": true,
"companyName": {
"companyName": "Mastersoft Pty Ltd xzxz",
"personalName": false,
"organisationalName": true,
"nameQuality": 8
}
}
],
"numberOfParties": 3
},
"relationships": [
{
"from": "person1",
"to": "organisation1",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation1",
"to": "organisation2",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 9: Validate business using OriginalInput
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "The trustee for RICHARD PATRICK"
}
}
}
}Response:9 Partial match was found with a very weak match
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "The trustee for RICHARD PATRICK",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"companyName": {
"companyName": "The",
"personalName": false,
"organisationalName": true,
"nameQuality": 3
},
"relationshipLabel": "organisation1",
"customAttributes": {
"business_name": "The Trustee for Richard Patrick Eisele",
"business_tax_status_from_date": "19000101",
"business_display_name": "The Trustee for Richard Patrick Eisele",
"business_ver_code": "OriginalInput_1_0.125",
"business_name_entity_type": "MN",
"business_bn": "78485861784",
"business_entity_type_ind": "DES",
"business_postcode": "7330",
"business_bn_status_from_date": "20200112",
"business_entity_type_text": "Deceased Estate",
"business_country": "au",
"business_month_in_business": "48",
"business_last_updated_date": "20200203",
"business_bn_status": "ACT",
"business_tax_status": "NON",
"business_state": "TAS"
},
"containedInParties": true,
"locationInParties": 1
},
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"personName": {
"fullName": "RICHARD PATRICK",
"personalName": true,
"firstName": "RICHARD",
"lastName": "PATRICK",
"organisationalName": false,
"nameQuality": 4
},
"containedInParties": true,
"locationInParties": 2
}
],
"numberOfParties": 2
},
"relationships": [
{
"from": "organisation1",
"to": "person1",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Response 10 illustrates business validation utilizing multiple data models: ID and companyName. The ID can represent either a business number or a company number, while the companyName can denote a person's name or a complex company entity.
Request 10: Validate business input with both business number and company name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones"
},
"id":{
"value":"15007342029"
}
}
}
}
Response 10: Exact match found on business number. No further rules are processed.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Eternal Graphix trading as Xyz pty ltd as trustee for James Jones",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"personName": {
"fullName": "Eternal Graphix",
"personalName": true,
"firstName": "Eternal",
"lastName": "Graphix",
"organisationalName": false,
"nameQuality": 4
},
"customAttributes": {
"business_name": "MASTERSOFT PTY. LTD.",
"business_tax_status_from_date": "20211002",
"business_display_name": "MASTERSOFT PTY. LTD.",
"business_ver_code": "Id_1_1.0",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "15007342029",
"business_cn": "007342029",
"business_entity_type_ind": "PRV",
"business_postcode": "3144",
"business_bn_status_from_date": "20000501",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "285",
"business_last_updated_date": "20211028",
"business_other_entities": "[{\"entity_name\":\"MASTERSOFT PTY LTD\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT",
"business_tax_status": "CAN",
"business_state": "VIC"
},
"containedInParties": true,
"locationInParties": 1,
"individualIdentifier": "15007342029"
},
{
"pdpchangeContext": {},
"companyName": {
"companyName": "Xyz pty ltd",
"personalName": false,
"organisationalName": true,
"nameQuality": 6
},
"relationshipLabel": "organisation1",
"containedInParties": true,
"locationInParties": 2,
"individualIdentifier": "15007342029"
},
{
"pdpchangeContext": {},
"relationshipLabel": "person2",
"personName": {
"fullName": "James Jones",
"personalName": true,
"firstName": "James",
"lastName": "Jones",
"organisationalName": false,
"nameQuality": 4
},
"containedInParties": true,
"locationInParties": 3,
"individualIdentifier": "15007342029"
}
],
"numberOfParties": 3
},
"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"
}
]
}