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"
}
]
}Request 11: Validate Family Partnership entity.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "PETER & PAMELA J LITTLE"
}
}
}
}
Response 11: Exact match using OriginalInput
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "PETER & PAMELA J LITTLE",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"relationshipLabel": "person2",
"personName": {
"fullName": "PETER LITTLE",
"personalName": true,
"firstName": "PETER",
"lastName": "LITTLE",
"organisationalName": false,
"nameQuality": 4
},
"customAttributes": {
"business_name": "PETER & PAMELA J LITTLE",
"business_tax_status_from_date": "20210701",
"business_display_name": "PETER & PAMELA J LITTLE",
"business_ver_code": "OriginalInput_1_1.0",
"business_name_entity_type": "MN",
"business_bn": "82391644703",
"business_entity_type_ind": "FPT",
"business_postcode": "2680",
"business_bn_status_from_date": "20000325",
"business_entity_type_text": "Family Partnership",
"business_country": "au",
"business_month_in_business": "286",
"business_last_updated_date": "20210707",
"business_other_entities": "[{\"entity_name\":\"P & P LITTLE\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT",
"business_tax_status": "CAN",
"business_state": "NSW"
},
"containedInParties": true,
"locationInParties": 1
},
{
"pdpchangeContext": {},
"relationshipLabel": "person1",
"personName": {
"fullName": "PAMELA J LITTLE",
"personalName": true,
"middleName": "J",
"firstName": "PAMELA",
"lastName": "LITTLE",
"organisationalName": false,
"nameQuality": 6
},
"containedInParties": true,
"locationInParties": 2
}
],
"numberOfParties": 2
},
"relationships": [
{
"from": "person2",
"to": "person1",
"title": "joint",
"arcrole": "http://www.msi.com.au/relationships/joint"
},
{
"from": "person1",
"to": "person2",
"title": "joint",
"arcrole": "http://www.msi.com.au/relationships/joint"
}
]
}Response 12 to 14 illustrates business validation when custom rules are set in business_validation_config.yml file.
Request 12: Validate business using custom rule for taxStatus. Configure business_validation_config.yml with taxStatus: "ACT" for au.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastersoft pty. Ltd. trading as Mastersoft pty ltd"
}
}
}
}
Response 12: Input business is validated against active business tax status only.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastersoft pty. Ltd. trading as Mastersoft pty ltd",
"exposeAttributes": "7"
},
"parties": [
{
"pdpchangeContext": {},
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastersoft pty. Ltd.",
"nameQuality": 8
},
"locationInParties": 1,
"containedInParties": true,
"relationshipLabel": "organisation1",
"customAttributes": {
"business_name": "MASTERSOFT GROUP PTY LTD",
"business_tax_status_from_date": "20110523",
"business_display_name": "MASTERSOFT GROUP PTY LTD",
"business_ver_code": "MainName_1_0.1111111111111111",
"business_name_entity_type": "MN",
"business_cn_type": "undetermined",
"business_bn": "91151055800",
"business_cn": "151055800",
"business_entity_type_ind": "PRV",
"business_postcode": "2000",
"business_bn_status_from_date": "20110523",
"business_month_as_tax_business": "152",
"business_entity_type_text": "Australian Private Company",
"business_country": "au",
"business_month_in_business": "152",
"business_last_updated_date": "20200214",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "NSW"
}
},
{
"pdpchangeContext": {},
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastersoft pty ltd",
"nameQuality": 8
},
"locationInParties": 2,
"containedInParties": true,
"relationshipLabel": "organisation2"
}
],
"numberOfParties": 2
},
"relationships": [
{
"from": "organisation1",
"to": "organisation2",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
}
]
}Request 13: Validate business using custom rule for nameTypes. Configure business_validation_config.yml including an additional nameType "OTN" for au.
nameTypes:
- "MN"
- "LGL"
- "TRD"
- "BN"
- "OTN"
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "PORT AUGUSTA WINDSCREENS AND RADIATORS"
}
}
}
}
Response 13: Input business is validated against various nameTypes including other names.
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"containedInParties": false,
"locationInParties": 0,
"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_0.03571428571428571",
"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": "252",
"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"
},
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "PORT AUGUSTA WINDSCREENS AND RADIATORS",
"nameQuality": 9
}
}
}Request 14: Validate business using custom scoreThreshold. Configure business_validation_config.yml with scoreThreshold: 0.2 for au. Same Input record as in Request 9.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "The trustee for RICHARD PATRICK"
}
}
}
}Response 14: Score of the validated input falls below the threshold, hence it is categorized as a NoMatch on OriginalInput. Nevertheless, if there is a match found on the BeneficiaryName, it signifies an alternate outcome.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "The trustee for RICHARD PATRICK",
"exposeAttributes": "7"
},
"numberOfParties": 2,
"parties": [
{
"pdpchangeContext": {},
"companyName": {
"organisationalName": true,
"companyName": "The",
"personalName": false,
"nameQuality": 3
},
"locationInParties": 1,
"containedInParties": true,
"relationshipLabel": "organisation1"
},
{
"pdpchangeContext": {},
"customAttributes": {
"business_name": "RICHARD PATRICK",
"business_tax_status_from_date": "20000702",
"business_display_name": "RICHARD PATRICK",
"business_ver_code": "BeneficiaryName_1_1.0",
"business_name_entity_type": "LGL",
"business_bn": "23897996450",
"business_entity_type_ind": "IND",
"business_postcode": "4870",
"business_bn_status_from_date": "20000605",
"business_month_as_tax_business": "283",
"business_entity_type_text": "Individual/Sole Trader",
"business_country": "au",
"business_month_in_business": "284",
"business_last_updated_date": "20211121",
"business_other_entities": "[{\"entity_name\":\"FNQ SAME DAY ANTENNAS\",\"entity_type\":\"TRD\"},{\"entity_name\":\"CARAVAN SATELLITE SOLUTIONS\",\"entity_type\":\"BN\"},{\"entity_name\":\"Sameday antennas\",\"entity_type\":\"BN\"},{\"entity_name\":\"SATELLITE SOLUTIONS\",\"entity_type\":\"BN\"},{\"entity_name\":\"The Loan Aranger\",\"entity_type\":\"BN\"}]",
"business_bn_status": "ACT",
"business_tax_status": "ACT",
"business_state": "QLD"
},
"locationInParties": 2,
"containedInParties": true,
"relationshipLabel": "person1",
"personName": {
"fullName": "RICHARD PATRICK",
"firstName": "RICHARD",
"organisationalName": false,
"personalName": true,
"lastName": "PATRICK",
"nameQuality": 4
}
}
]
},
"relationships": [
{
"from": "organisation1",
"to": "person1",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Response 15 illustrates how business names can surpass parsing failures through the utilization of configuration in $HARMONY_HOME/config/scrubbing/harmony_scrubbing_descriptor.xml.
default configuration is false.
Set the configuration to true, as below to surpass parse failure and proceed with business validation.
<h:passthrough-name-on-parse-failure>true</h:passthrough-name-on-parse-failure>.
Request 15: Validate an alphanumeric business name
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"AUSTRALIA"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "AUGUSTA 4WD"
}
}
}
}
Response 15: Validated business information using OriginalInput.
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"originalInput": "AUGUSTA 4WD",
"exposeAttributes": "7"
},
"customAttributes": {
"business_name": "AUGUSTA AUTO MART PTY LTD",
"business_tax_status_from_date": "20030210",
"business_display_name": "AUGUSTA AUTO MART PTY LTD Trading As AUGUSTA 4WD",
"business_ver_code": "OriginalInput_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": "252",
"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"
},
"containedInParties": false,
"locationInParties": 0
}
}Sample Request and Response for New Zealand
Response 1 and 2 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 exact main entity name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "ministry of justice"
}
}
}
}
Response 1: Exact match to the input
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"containedInParties": false,
"locationInParties": 0,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "ministry of justice",
"nameQuality": 8
},
"customAttributes": {
"business_name": "Ministry of Justice",
"business_display_name": "Ministry of Justice",
"business_ver_code": "MainName_1_1.0",
"business_bn_start_date": "2017-06-14T00:00:00",
"business_name_entity_type": "MN",
"business_cn_type": "GovtCentral",
"business_location_identifier": "nzOnly",
"business_bn": "9429041908907",
"business_cn": "300001099",
"business_entity_type_ind": "GovtCentral",
"business_phones": "[{\"phoneAreaCode\":\"04\",\"phoneCountryCode\":\"64\",\"phoneNumber\":\"9188800\",\"phonePurpose\":\"phone\",\"startDate\":\"2017-06-14T00:00:00\",\"uniqueIdentifier\":\"5388\"}]",
"business_registration_date": "2017-06-14T00:00:00",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "Central Government",
"business_country": "nz",
"business_month_in_business": "79",
"business_last_updated_date": "2017-10-20T17:10:29",
"business_bn_status": "ACT"
}
}
}Request 2: Validate a misspelt Trading Name
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "GL & AS NORJE TRUST"
}
}
}
}
Response 2: Response shows validated trading name information. business_display_name holds the corrected trading_name
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"exposeAttributes": "7"
},
"containedInParties": false,
"locationInParties": 0,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "GL & AS NORJE TRUST",
"nameQuality": 8
},
"customAttributes": {
"business_name": "G.N. & ASSOCIATES LIMITED",
"business_display_name": "G.N. & ASSOCIATES LIMITED Trading As GL & AS Nortje Trust",
"business_ver_code": "MainName_1_0.5",
"business_bn_start_date": "2006-02-02T00:00:00",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429034333303",
"business_cn": "1761142",
"business_entity_type_ind": "LTD",
"business_shareholding": "[{\"numberOfShares\":\"100\",\"shareAllocation\":[{\"allocation\":\"100\",\"shareholder\":[{\"appointmentDate\":\"2006-02-02T00:00:00\",\"individualShareholder\":[{\"firstName\":\"Gerhard\",\"fullName\":\"Gerhard Lukas NORTJE\",\"lastName\":\"NORTJE\",\"middleNames\":\"Lukas\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]}]}]",
"business_bn_status_from_date": "2006-02-02T00:00:00",
"business_registration_date": "2006-02-02T00:00:00",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "216",
"business_last_updated_date": "2020-03-28T00:17:33",
"business_other_entities": "[{\"entity_name\":\"GL & AS Nortje Trust\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT"
}
}
}Response 3 to 7 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 company name with multiple entities. These samples depict the order of priority for rules as listed in matching rules list.
Request 3: Validate an input with multiple data models ID, Company name trading as another business name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastersoft trading as shelkam engineering ltd"
}
,
"id":{
"value":"8051618"
}
}
}
}
Response 3: Match is obtained on ID. No further rules are processed.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastersoft trading as shelkam engineering ltd",
"exposeAttributes": "7"
},
"numberOfParties": 2,
"parties": [
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation1",
"locationInParties": 1,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastersoft",
"nameQuality": 6
},
"customAttributes": {
"business_name": "LION BUILDS LIMITED",
"business_display_name": "LION BUILDS LIMITED",
"business_ver_code": "Id_1_1.0",
"business_bn_start_date": "2020-07-10T14:53:24",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429048442503",
"business_cn": "8051618",
"business_entity_type_ind": "LTD",
"business_postcode": "3189",
"business_shareholding": "[{\"numberOfShares\":\"2\",\"shareAllocation\":[{\"allocation\":\"1\",\"shareholder\":[{\"appointmentDate\":\"2020-07-10T14:53:24\",\"individualShareholder\":[{\"firstName\":\"Peggy\",\"fullName\":\"Peggy Rose ARANUI\",\"lastName\":\"ARANUI\",\"middleNames\":\"Rose\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]},{\"allocation\":\"1\",\"shareholder\":[{\"appointmentDate\":\"2020-07-10T14:53:24\",\"individualShareholder\":[{\"firstName\":\"Ngarangi\",\"fullName\":\"Ngarangi Bungi Hohepa Raymond John MIHAERE\",\"lastName\":\"MIHAERE\",\"middleNames\":\"Bungi Hohepa Raymond John\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]}]}]",
"business_bn_status_from_date": "2020-07-10T14:53:24",
"business_registration_date": "2020-07-10T14:53:24",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "43",
"business_last_updated_date": "2021-08-03T08:13:11",
"business_other_entities": "[{\"entity_name\":\"Lion Builds Ltd\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT"
},
"individualIdentifier": "8051618"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation2",
"locationInParties": 2,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "shelkam engineering ltd",
"nameQuality": 8
},
"individualIdentifier": "8051618"
}
]
},
"relationships": [
{
"from": "organisation1",
"to": "organisation2",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
}
]
}Request 4: Validate an input containing multiple data models, including an ID and a company name operating under another business name entrusted to a trust (Beneficiary). The ID yields no matches.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastersoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST"
}
,
"id":{
"value":"8051618jkjkf"
}
}
}
}
Response 4: Exact match obtained on BeneficiaryName.
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastersoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST",
"exposeAttributes": "7"
},
"numberOfParties": 3,
"parties": [
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation1",
"locationInParties": 1,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastersoft",
"nameQuality": 6
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation2",
"locationInParties": 2,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "THE PIN TIN",
"nameQuality": 6
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation3",
"locationInParties": 3,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "GL & AS NORTJE TRUST",
"nameQuality": 8
},
"customAttributes": {
"business_name": "G.N. & ASSOCIATES LIMITED",
"business_display_name": "G.N. & ASSOCIATES LIMITED Trading As GL & AS Nortje Trust",
"business_ver_code": "BeneficiaryName_1_1.0",
"business_bn_start_date": "2006-02-02T00:00:00",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429034333303",
"business_cn": "1761142",
"business_entity_type_ind": "LTD",
"business_shareholding": "[{\"numberOfShares\":\"100\",\"shareAllocation\":[{\"allocation\":\"100\",\"shareholder\":[{\"appointmentDate\":\"2006-02-02T00:00:00\",\"individualShareholder\":[{\"firstName\":\"Gerhard\",\"fullName\":\"Gerhard Lukas NORTJE\",\"lastName\":\"NORTJE\",\"middleNames\":\"Lukas\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]}]}]",
"business_bn_status_from_date": "2006-02-02T00:00:00",
"business_registration_date": "2006-02-02T00:00:00",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "216",
"business_last_updated_date": "2020-03-28T00:17:33",
"business_other_entities": "[{\"entity_name\":\"GL & AS Nortje Trust\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT"
},
"individualIdentifier": "8051618jkjkf"
}
]
},
"relationships": [
{
"from": "organisation1",
"to": "organisation2",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation2",
"to": "organisation3",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 5: Validate an input containing multiple data models, including an ID and a company name operating under another business name entrusted to a trust (Beneficiary). The provided ID and trust name do not yield matches.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastersoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz"
}
,
"id":{
"value":"8051618jkjkf"
}
}
}
}
Response 5: Partial match obtained on MainName 0.071
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastersoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz",
"exposeAttributes": "7"
},
"numberOfParties": 3,
"parties": [
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation1",
"locationInParties": 1,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastersoft",
"nameQuality": 6
},
"customAttributes": {
"business_name": "MASTERSOFT (NZ) LIMITED",
"business_display_name": "MASTERSOFT (NZ) LIMITED",
"business_ver_code": "MainName_1_0.07142857142857142",
"business_bn_start_date": "2005-03-21T00:00:00",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429034884508",
"business_cn": "1611874",
"business_entity_type_ind": "LTD",
"business_postcode": "6011",
"business_shareholding": "[{\"numberOfShares\":\"100\",\"shareAllocation\":[{\"allocation\":\"100\",\"shareholder\":[{\"appointmentDate\":\"2011-06-17T16:01:40\",\"individualShareholder\":[],\"otherShareholder\":[{\"companyNumber\":\"2415211\",\"currentEntityName\":\"Mastersoft Group Pty Limited\"}],\"shareholderAddress\":[{\"address1\":\"Suite 7, Level 7, 330 Collins Street\",\"address3\":\"Melbourne Vic\",\"countryCode\":\"AU\"}],\"type\":\"other\"}]}]}]",
"business_bn_status_from_date": "2005-03-21T00:00:00",
"business_registration_date": "2005-03-21T00:00:00",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "226",
"business_last_updated_date": "2023-09-04T11:02:07",
"business_other_entities": "[{\"entity_name\":\"GPIC INVESTMENTS LIMITED\",\"entity_type\":\"OTN\",\"start_date\":\"2005-03-21T00:00:00\",\"end_date\":\"2011-06-13T15:59:46\"}]",
"business_bn_status": "ACT"
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation2",
"locationInParties": 2,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "THE PIN TIN",
"nameQuality": 6
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation3",
"locationInParties": 3,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "GL & AS NORTJE TRUST xz xz",
"nameQuality": 9
},
"individualIdentifier": "8051618jkjkf"
}
]
},
"relationships": [
{
"from": "organisation1",
"to": "organisation2",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation2",
"to": "organisation3",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 6: Validate an input containing multiple data models, including an ID and a company name operating under another business name entrusted to a trust (Beneficiary). The provided ID and trust name do not yield matches.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastertsoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz"
}
,
"id":{
"value":"8051618jkjkf"
}
}
}
}
Response 6: Ambiguous match obtained on MainName
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastertsoft TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz",
"exposeAttributes": "7"
},
"numberOfParties": 3,
"parties": [
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation1",
"locationInParties": 1,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "Mastertsoft",
"nameQuality": 6
},
"customAttributes": {
"business_ver_code": "MainName_2_0.125"
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation2",
"locationInParties": 2,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "THE PIN TIN",
"nameQuality": 6
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation3",
"locationInParties": 3,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "GL & AS NORTJE TRUST xz xz",
"nameQuality": 9
},
"individualIdentifier": "8051618jkjkf"
}
]
},
"relationships": [
{
"from": "organisation1",
"to": "organisation2",
"title": "trading",
"arcrole": "http://www.msi.com.au/relationships/trading"
},
{
"from": "organisation2",
"to": "organisation3",
"title": "trust",
"arcrole": "http://www.msi.com.au/relationships/trust"
}
]
}Request 7: Validate an input containing multiple data models, including an ID and a company name operating under another business name entrusted to a trust (Beneficiary). The provided ID, trust name and main name do not yield matches.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Mastersoft xz xz TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz"
}
,
"id":{
"value":"8051618jkjkf"
}
}
}
}
Response 7: Exact match obtained on TradingName
{
"ciqPartyRelationshipDocument": {
"options": {
"originalInput": "Mastersoft xz xz TRADING AS THE PIN TIN IN TRUST FOR GL & AS NORTJE TRUST xz xz",
"exposeAttributes": "7"
},
"numberOfParties": 3,
"parties": [
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "person1",
"locationInParties": 1,
"personName": {
"personalName": true,
"lastName": "xz",
"middleName": "x z",
"firstName": "Mastersoft",
"organisationalName": false,
"fullName": "Mastersoft x z xz",
"nameQuality": 6
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation1",
"locationInParties": 2,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "THE PIN TIN",
"nameQuality": 6
},
"customAttributes": {
"business_name": "R & L PILGRIM LIMITED",
"business_display_name": "R & L PILGRIM LIMITED Trading As The Pin Tin",
"business_ver_code": "TradingName_1_1.0",
"business_bn_start_date": "2014-03-03T17:06:31",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429041121481",
"business_cn": "4979800",
"business_entity_type_ind": "LTD",
"business_postcode": "7930",
"business_shareholding": "[{\"numberOfShares\":\"1000\",\"shareAllocation\":[{\"allocation\":\"500\",\"shareholder\":[{\"appointmentDate\":\"2014-03-03T17:06:31\",\"individualShareholder\":[{\"firstName\":\"Reon\",\"fullName\":\"Reon David PILGRIM\",\"lastName\":\"PILGRIM\",\"middleNames\":\"David\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"director\"}]},{\"allocation\":\"500\",\"shareholder\":[{\"appointmentDate\":\"2016-01-12T08:46:57\",\"individualShareholder\":[{\"firstName\":\"Lisa\",\"fullName\":\"Lisa Dawn PILGRIM\",\"lastName\":\"PILGRIM\",\"middleNames\":\"Dawn\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]}]}]",
"business_bn_status_from_date": "2014-03-03T17:06:31",
"business_registration_date": "2014-03-03T17:06:31",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "119",
"business_last_updated_date": "2020-10-28T13:03:50",
"business_other_entities": "[{\"entity_name\":\"The Pin Tin\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT"
},
"individualIdentifier": "8051618jkjkf"
},
{
"pdpchangeContext": {},
"containedInParties": true,
"relationshipLabel": "organisation2",
"locationInParties": 3,
"companyName": {
"personalName": false,
"organisationalName": true,
"companyName": "GL & AS NORTJE TRUST xz xz",
"nameQuality": 9
},
"individualIdentifier": "8051618jkjkf"
}
]
},
"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"
}
]
}Response 9 illustrates how business names can surpass parsing failures through the utilization of configuration in $HARMONY_HOME/config/scrubbing/harmony_scrubbing_descriptor.xml.
default configuration is false.
Set the configuration to true, as below to surpass parse failure and proceed with business validation.
<h:passthrough-name-on-parse-failure>true</h:passthrough-name-on-parse-failure>
Request 9: Validate an alphanumeric business name.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Trading as CC591"
}
}
}
}
Response 9: Validated business information using OriginalInput.
{
"ciqPartyDocument": {
"pdpchangeContext": {},
"options": {
"originalInput": "Trading as CC591",
"exposeAttributes": "7"
},
"containedInParties": false,
"locationInParties": 0,
"customAttributes": {
"business_name": "RELATIVITY LIMITED",
"business_display_name": "RELATIVITY LIMITED Trading As Trading as CC591",
"business_ver_code": "OriginalInput_1_0.058823529411764705",
"business_bn_start_date": "2001-05-21T00:00:00",
"business_name_entity_type": "MN",
"business_cn_type": "LTD",
"business_bn": "9429036897711",
"business_cn": "1138994",
"business_entity_type_ind": "LTD",
"business_postcode": "6037",
"business_shareholding": "[{\"numberOfShares\":\"1000\",\"shareAllocation\":[{\"allocation\":\"500\",\"shareholder\":[{\"appointmentDate\":\"2001-05-21T00:00:00\",\"individualShareholder\":[{\"firstName\":\"Julie\",\"fullName\":\"Julie Anne BAKER\",\"lastName\":\"BAKER\",\"middleNames\":\"Anne\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]},{\"allocation\":\"500\",\"shareholder\":[{\"appointmentDate\":\"2001-05-21T00:00:00\",\"individualShareholder\":[{\"firstName\":\"Ross\",\"fullName\":\"Ross Lambert BAKER\",\"lastName\":\"BAKER\",\"middleNames\":\"Lambert\"}],\"otherShareholder\":[],\"shareholderAddress\":[],\"type\":\"individual\"}]}]}]",
"business_bn_status_from_date": "2001-05-21T00:00:00",
"business_registration_date": "2001-05-21T00:00:00",
"business_detailed_bn_status": "50 (Registered)",
"business_entity_type_text": "NZ Limited Company",
"business_country": "nz",
"business_month_in_business": "272",
"business_last_updated_date": "2023-06-03T15:54:35",
"business_other_entities": "[{\"entity_name\":\"Trading as CC591\",\"entity_type\":\"TRD\"},{\"entity_name\":\"Trading as Corporate Cabs #591\",\"entity_type\":\"TRD\"}]",
"business_bn_status": "ACT"
}
}
}Response 10 illustrates business names that are failed to parse.
Request 10: Business names that are failed to parse.
{
"harmonyServiceConfig": {
"role": "BusinessValRole",
"locale":"NEW_ZEALAND"
},
"parserInput": {
"rawDataInput": {
"companyName": {
"value": "Trading as CC591"
}
}
}
}
Response 10: Business Validation will not be processed for failed to parse names.
{
"exceptions": [
{
"code": "H020",
"category": "PARSER",
"description": "Major Conjunction cannot be at the start of a name",
"inputData": "Trading as CC591",
"inputType": "COMPANY_DATA",
"message": "H020 : Major Conjunction cannot be at the start of a name",
"localizedMessage": "H020 : Major Conjunction cannot be at the start of a name"
}
]
}Last updated
