# Business Lookup
To complete business lookup requires one Find API that returns detailed information of the business entity.
1. [**Find**](#find) - Returns a list of valid business based on partial or complete business information.
**Supported Countries:** Australia, New Zealand
## Prerequisites:
A comprehensive guide that signifies the essential requirements that needs to be met to access Business Lookup.
{% content-ref url="/pages/iCvh6rgMXc08eZxFBUeG" %}
[Prerequisites](/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/prerequisites.md)
{% endcontent-ref %}
## Find
Lookup businesses using a partial or complete business information in a single line business field.
The name to be searched can be a business number, company or any entity names.
HTTP `POST` will only process the **first** record in the request.
### Resource
Default Port is 18080. Port number is configurable. For details on how to use a different port, refer [Getting Started](/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/prerequisites.md#getting-started)
GET http://localhost:18080/business/v1/find
POST http://localhost:18080/business/v1/find
### Request
required input field\*
| Name | Type | Example | Description |
| --------- | ------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| country\* | string | AU | ISO 2 country AU or NZ |
| name\* | string | "gbg aust" | partial/complete business name or registered business number or company number |
| nameTypes | string | "TRD,BN,OTN" | Filters for specific or multiple Entity types depending on country.
Australia
MN-->Main Entity name;
LGL-->Legal Entity Name (individuals/sole traders). Use with MN;
TRD-->Trading name in Other Entity;
BN-->Business name in Other Entity; DGR-->Deductible Gift Recipient;
OTN-->Other name in Other Entity.
New Zealand
MN-->Main Entity name;
TRD-->Trading name in Other Entity;
OTN-->Other name in Other Entity.
|
| bnStatus | string | "ACT"
default blank
| Filters based on business number status. Options
ACT = Active, CAN = Cancelled
|
| taxStatus | string | "ACT"
default blank
| Filters based on business tax status. Options
ACT = Active, CAN = Cancelled, NON = None
|
| State | string | "NSW, QLD"
default blank
| Filters for specific or multiple states the business is located. Blank is all. state is only applicable for au. |
| hits | integer | 5
default 20
| Number of results to be returned from the Find response. |
| caseType | string | "TITLE"
default UP
| The case type for the returned information UP,LOW,TITLE |
### Response
Response will be a combination of Main Entity name, Trading Name and Business names etc.
### Sample Request and Response for Australia
Request 1: POST- Lookup for active business names from multiple states
```
{
"name": "Mastersoft",
"country": "au",
"bnStatus":"ACT",
"state": [
"NSW","VIC"
],
"caseType": "TITLE"
}
```
Response 1: Response including combination of main entity names and trading names.
**when response is not a main entity name then display\_name in json response is set to**
**display\_name:** XXX(mn) trading as YYY(TRD)
**name:** XXX(mn)
**when response is a main name, display\_name in json response is the same as name**
**display\_name:** XXX(mn)
**name:** XXX(mn)
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "Mastersoft Pty. Ltd.",
"name": "Mastersoft Pty. Ltd.",
"bn": "15007342029",
"cn": "007342029",
"state": "VIC",
"postcode": "3144",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20000501",
"tax_status": "CAN",
"tax_status_from_date": "20211002",
"entity_type_ind": "PRV",
"entity_type_text": "Australian Private Company",
"other_entities": [
{
"entity_name": "Mastersoft Pty Ltd",
"entity_type": "TRD"
}
],
"attributes": {
"month_in_business": "283"
},
"last_updated_date": "20211028"
},
{
"display_name": "Mastersoft Pty. Ltd. Trading As Mastersoft Pty Ltd",
"name": "Mastersoft Pty. Ltd.",
"bn": "15007342029",
"cn": "007342029",
"state": "VIC",
"postcode": "3144",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20000501",
"tax_status": "CAN",
"tax_status_from_date": "20211002",
"entity_type_ind": "PRV",
"entity_type_text": "Australian Private Company",
"other_entities": [
{
"entity_name": "Mastersoft Pty Ltd",
"entity_type": "TRD"
}
],
"attributes": {
"month_in_business": "283"
},
"last_updated_date": "20211028"
},
{
"display_name": "Mastersoft Superannuation Fund",
"name": "Mastersoft Superannuation Fund",
"bn": "57290362590",
"state": "VIC",
"postcode": "3006",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20000406",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "SMF",
"entity_type_text": "ATO Regulated Self-Managed Superannuation Fund",
"other_entities": [
{
"entity_name": "Mastersoft Superannuation Fund",
"entity_type": "TRD"
}
],
"attributes": {
"month_in_business": "283"
},
"last_updated_date": "20190731"
},
{
"display_name": "Mastersoft Superannuation Fund Trading As Mastersoft Superannuation Fund",
"name": "Mastersoft Superannuation Fund",
"bn": "57290362590",
"state": "VIC",
"postcode": "3006",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20000406",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "SMF",
"entity_type_text": "ATO Regulated Self-Managed Superannuation Fund",
"other_entities": [
{
"entity_name": "Mastersoft Superannuation Fund",
"entity_type": "TRD"
}
],
"attributes": {
"month_in_business": "283"
},
"last_updated_date": "20190731"
},
{
"display_name": "Mastersoft Group Pty Ltd",
"name": "Mastersoft Group Pty Ltd",
"bn": "91151055800",
"cn": "151055800",
"state": "NSW",
"postcode": "2000",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20110523",
"tax_status": "ACT",
"tax_status_from_date": "20110523",
"entity_type_ind": "PRV",
"entity_type_text": "Australian Private Company",
"attributes": {
"month_as_tax_business": "150",
"month_in_business": "150"
},
"last_updated_date": "20200214"
}
]
}
```
Request 2: GET- Lookup for Legal Entity Names
```http
http://localhost:18080/business/v1/find?country=au&name=claudio%20esp&nameTypes=LGL&caseType=UP
```
Response 2: Response includes Legal Entity Names only.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "CLAUDIO ESPINOZA",
"name": "CLAUDIO ESPINOZA",
"bn": "52755328790",
"state": "NSW",
"postcode": "2136",
"country": "au",
"bn_status": "CAN",
"bn_status_from_date": "20080811",
"tax_status": "CAN",
"tax_status_from_date": "20080811",
"entity_type_ind": "IND",
"entity_type_text": "Individual/Sole Trader",
"last_updated_date": "20100805"
},
{
"display_name": "CLAUDIO ESPINOSA",
"name": "CLAUDIO ESPINOSA",
"bn": "79698017130",
"state": "WA",
"postcode": "6000",
"country": "au",
"bn_status": "CAN",
"bn_status_from_date": "20151103",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "IND",
"entity_type_text": "Individual/Sole Trader",
"last_updated_date": "20151103"
},
{
"display_name": "CLAUDIO ESPOSITO",
"name": "CLAUDIO ESPOSITO",
"bn": "79171302295",
"state": "VIC",
"postcode": "3012",
"country": "au",
"bn_status": "CAN",
"bn_status_from_date": "20210429",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "IND",
"entity_type_text": "Individual/Sole Trader",
"last_updated_date": "20210429"
},
{
"display_name": "MR CLAUDIO ENRIQUE ESPINOSA",
"name": "MR CLAUDIO ENRIQUE ESPINOSA",
"bn": "70604342414",
"state": "QLD",
"postcode": "4078",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20070701",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "IND",
"entity_type_text": "Individual/Sole Trader",
"attributes": {
"month_in_business": "197"
},
"last_updated_date": "20070701"
},
{
"display_name": "CLAUDIO ALEJANDRO HERRERA ESPINDOLA",
"name": "CLAUDIO ALEJANDRO HERRERA ESPINDOLA",
"bn": "24350648123",
"state": "NSW",
"postcode": "2000",
"country": "au",
"bn_status": "CAN",
"bn_status_from_date": "20231003",
"tax_status": "NON",
"tax_status_from_date": "19000101",
"entity_type_ind": "IND",
"entity_type_text": "Individual/Sole Trader",
"last_updated_date": "20231004"
}
]
}
```
Request 3: POST- Lookup for business names with active tax status
```json
{
"name": "Mastersoft",
"country": "au",
"bnStatus":"ACT",
"nameTypes":["MN"],
"taxStatus":"ACT",
"state": [
"NSW","VIC"
],
"caseType": "UP"
}
```
Response 3: Response includes business with active tax status
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "MASTERSOFT GROUP PTY LTD",
"name": "MASTERSOFT GROUP PTY LTD",
"bn": "91151055800",
"cn": "151055800",
"state": "NSW",
"postcode": "2000",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20110523",
"tax_status": "ACT",
"tax_status_from_date": "20110523",
"entity_type_ind": "PRV",
"entity_type_text": "Australian Private Company",
"attributes": {
"month_as_tax_business": "150",
"month_in_business": "150"
},
"last_updated_date": "20200214"
}
]
}
```
Request 4: GET- Lookup business name using Business Number
```http
http://localhost:18080/business/v1/find?country=au&name=15007342029
```
Response 4: Returns only one business entity name
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "MASTERSOFT PTY. LTD.",
"name": "MASTERSOFT PTY. LTD.",
"bn": "15007342029",
"cn": "007342029",
"state": "VIC",
"postcode": "3144",
"country": "au",
"bn_status": "ACT",
"bn_status_from_date": "20000501",
"tax_status": "CAN",
"tax_status_from_date": "20211002",
"entity_type_ind": "PRV",
"entity_type_text": "Australian Private Company",
"other_entities": [
{
"entity_name": "MASTERSOFT PTY LTD",
"entity_type": "TRD"
}
],
"attributes": {
"month_in_business": "283"
},
"last_updated_date": "20211028"
}
]
}
```
### Sample Request and Response for NewZealand
Request 1: POST -Lookup for active business names
```json
{
"name": "shelkam engin",
"country": "nz",
"bnStatus":"ACT",
"caseType": "UP"
}
```
Response 1: Response includes only active business.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "SHELKAM ENGINEERING LIMITED TRADING AS SHELKAM ENGINEERING LTD",
"name": "SHELKAM ENGINEERING LIMITED",
"bn": "9429032232776",
"cn": "2248146",
"postcode": "0992",
"country": "nz",
"bn_status": "ACT",
"bn_status_from_date": "2009-05-25T00:00:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"other_entities": [
{
"entity_name": "SHELKAM ENGINEERING LTD",
"entity_type": "TRD"
}
],
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "227 A WAIRAU ROAD, WAIRAU VALLEY, AUCKLAND",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "137 YOUNG ACCESS, RD 2, SILVERDALE",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "137 YOUNG ACCESS, RD 2, SILVERDALE",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "227 A WAIRAU ROAD, WAIRAU VALLEY, AUCKLAND",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Mohanan",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Sheela",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "6",
"annualReturnLastFiled": "2023-06-02T05:53:59",
"extensiveShareholding": "false",
"hasConstitutionFiled": "false",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "100",
"shareAllocation": [
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Mohanan",
"fullName": "Mohanan Gopalakrishnan NAIR",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Sheela",
"fullName": "Sheela Mohanan NAIR",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2009-05-25T00:00:00",
"detailed_bn_status": "50 (Registered)",
"month_in_business": "174",
"registration_date": "2009-05-25T00:00:00"
},
"last_updated_date": "2022-07-05T20:52:46"
},
{
"display_name": "SHELKAM ENGINEERING LIMITED",
"name": "SHELKAM ENGINEERING LIMITED",
"bn": "9429032232776",
"cn": "2248146",
"postcode": "0992",
"country": "nz",
"bn_status": "ACT",
"bn_status_from_date": "2009-05-25T00:00:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"other_entities": [
{
"entity_name": "SHELKAM ENGINEERING LTD",
"entity_type": "TRD"
}
],
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "227 A WAIRAU ROAD, WAIRAU VALLEY, AUCKLAND",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "137 YOUNG ACCESS, RD 2, SILVERDALE",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "137 YOUNG ACCESS, RD 2, SILVERDALE",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "227 A WAIRAU ROAD, WAIRAU VALLEY, AUCKLAND",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Mohanan",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Sheela",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "6",
"annualReturnLastFiled": "2023-06-02T05:53:59",
"extensiveShareholding": "false",
"hasConstitutionFiled": "false",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "100",
"shareAllocation": [
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Mohanan",
"fullName": "Mohanan Gopalakrishnan NAIR",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Sheela",
"fullName": "Sheela Mohanan NAIR",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2009-05-25T00:00:00",
"detailed_bn_status": "50 (Registered)",
"month_in_business": "174",
"registration_date": "2009-05-25T00:00:00"
},
"last_updated_date": "2022-07-05T20:52:46"
}
]
}
```
Request 2: POST- Lookup for main names and trading names with cancelled business status
```json
{
"name": "Mas eng",
"country": "nz",
"bnStatus":"CAN",
"caseType": "TITLE",
"nameTypes":["MN","TRD"]
}
```
Response 2: Response includes only cancelled business.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "Mas Engineers Limited Trading As Mas Engineers Ltd",
"name": "Mas Engineers Limited",
"bn": "9429036054343",
"cn": "1288118",
"postcode": "3110",
"country": "nz",
"bn_status": "CAN",
"bn_status_from_date": "2016-07-08T17:11:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"other_entities": [
{
"entity_name": "Mas Engineers Ltd",
"entity_type": "TRD"
}
],
"classifications": [
{
"type": "IndustryClassification",
"attributes": {
"classificationCode": "M692343",
"classificationDescription": "Engineering consulting service nec"
}
}
],
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "37 Braeburn Place, Tauranga",
"country": "NZ",
"start_date": "2003-03-28T00:00:00",
"end_date": "2011-08-09T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "37 Braeburn Place, Bethlehem, Tauranga",
"postcode": "3110",
"country": "NZ",
"start_date": "2011-08-09T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "37 Braeburn Place, Bethlehem, Tauranga",
"postcode": "3110",
"country": "NZ",
"start_date": "2011-08-09T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "37 Braeburn Place, Tauranga",
"country": "NZ",
"start_date": "2003-03-28T00:00:00",
"end_date": "2011-08-09T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Kathryn",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2003-03-28T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Malcolm",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2003-03-28T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "8",
"annualReturnLastFiled": "2013-09-02T15:10:23",
"extensiveShareholding": "false",
"hasConstitutionFiled": "true",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "1000",
"shareAllocation": [
{
"allocation": "950",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Malcolm",
"fullName": "Malcolm Leslie ANGELL",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
},
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Kathryn",
"fullName": "Kathryn Suzanne ANGELL",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "25",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Malcolm",
"fullName": "Malcolm Leslie ANGELL",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "25",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Kathryn",
"fullName": "Kathryn Suzanne ANGELL",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2003-03-28T00:00:00",
"detailed_bn_status": "80 (Removed)",
"month_in_business": "248",
"registration_date": "2003-03-28T00:00:00"
},
"last_updated_date": "2016-07-08T17:11:00"
},
{
"display_name": "Mas Engineers Limited",
"name": "Mas Engineers Limited",
"bn": "9429036054343",
"cn": "1288118",
"postcode": "3110",
"country": "nz",
"bn_status": "CAN",
"bn_status_from_date": "2016-07-08T17:11:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"other_entities": [
{
"entity_name": "Mas Engineers Ltd",
"entity_type": "TRD"
}
],
"classifications": [
{
"type": "IndustryClassification",
"attributes": {
"classificationCode": "M692343",
"classificationDescription": "Engineering consulting service nec"
}
}
],
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "37 Braeburn Place, Tauranga",
"country": "NZ",
"start_date": "2003-03-28T00:00:00",
"end_date": "2011-08-09T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "37 Braeburn Place, Bethlehem, Tauranga",
"postcode": "3110",
"country": "NZ",
"start_date": "2011-08-09T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "37 Braeburn Place, Bethlehem, Tauranga",
"postcode": "3110",
"country": "NZ",
"start_date": "2011-08-09T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "37 Braeburn Place, Tauranga",
"country": "NZ",
"start_date": "2003-03-28T00:00:00",
"end_date": "2011-08-09T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Kathryn",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2003-03-28T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Malcolm",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2003-03-28T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "8",
"annualReturnLastFiled": "2013-09-02T15:10:23",
"extensiveShareholding": "false",
"hasConstitutionFiled": "true",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "1000",
"shareAllocation": [
{
"allocation": "950",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Malcolm",
"fullName": "Malcolm Leslie ANGELL",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
},
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Kathryn",
"fullName": "Kathryn Suzanne ANGELL",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "25",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Malcolm",
"fullName": "Malcolm Leslie ANGELL",
"lastName": "ANGELL",
"middleNames": "Leslie"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "25",
"shareholder": [
{
"appointmentDate": "2003-03-28T00:00:00",
"individualShareholder": [
{
"firstName": "Kathryn",
"fullName": "Kathryn Suzanne ANGELL",
"lastName": "ANGELL",
"middleNames": "Suzanne"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2003-03-28T00:00:00",
"detailed_bn_status": "80 (Removed)",
"month_in_business": "248",
"registration_date": "2003-03-28T00:00:00"
},
"last_updated_date": "2016-07-08T17:11:00"
}
]
}
```
Request 3: GET -Lookup business name using Company Number
```http
http://localhost:18080/business/v1/find?country=nz&name=2248146
```
Response 3: Returns only one business entity name.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "SHELKAM ENGINEERING LIMITED",
"name": "SHELKAM ENGINEERING LIMITED",
"bn": "9429032232776",
"cn": "2248146",
"postcode": "0992",
"country": "nz",
"bn_status": "ACT",
"bn_status_from_date": "2009-05-25T00:00:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"other_entities": [
{
"entity_name": "shelkam engineering ltd",
"entity_type": "TRD"
}
],
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "227 A Wairau Road, Wairau Valley, Auckland",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "137 Young Access, Rd 2, Silverdale",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "137 Young Access, Rd 2, Silverdale",
"postcode": "0992",
"country": "NZ",
"start_date": "2016-05-04T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "227 A Wairau Road, Wairau Valley, Auckland",
"postcode": "0672",
"country": "NZ",
"start_date": "2009-05-25T00:00:00",
"end_date": "2016-05-04T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Mohanan",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Sheela",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2009-05-25T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "6",
"annualReturnLastFiled": "2023-06-02T05:53:59",
"extensiveShareholding": "false",
"hasConstitutionFiled": "false",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "100",
"shareAllocation": [
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Mohanan",
"fullName": "Mohanan Gopalakrishnan NAIR",
"lastName": "NAIR",
"middleNames": "Gopalakrishnan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "50",
"shareholder": [
{
"appointmentDate": "2009-05-25T00:00:00",
"individualShareholder": [
{
"firstName": "Sheela",
"fullName": "Sheela Mohanan NAIR",
"lastName": "NAIR",
"middleNames": "Mohanan"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2009-05-25T00:00:00",
"detailed_bn_status": "50 (Registered)",
"month_in_business": "174",
"registration_date": "2009-05-25T00:00:00"
},
"last_updated_date": "2022-07-05T20:52:46"
}
]
}
```
Request 4: POST -Lookup business using Business Number
```json
{
"name": "9429034441299",
"country": "nz"
}
```
Response 4: Returns only one business entity name.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"display_name": "FRAGMENT TRUSTEE LIMITED",
"name": "FRAGMENT TRUSTEE LIMITED",
"bn": "9429034441299",
"cn": "1725839",
"country": "nz",
"bn_status": "CAN",
"bn_status_from_date": "2010-04-13T00:00:00",
"entity_type_ind": "LTD",
"entity_type_text": "NZ Limited Company",
"addresses": [
{
"type": "PhysicalAddress",
"fullAddress": "C/-Morrison Creed, 1st Floor, Cnr Main, St & Victoria Ave, Palmerston North",
"country": "NZ",
"start_date": "2006-09-25T00:00:00"
},
{
"type": "PhysicalAddress",
"fullAddress": "C/-Morrison Advisory, Floor 5, TelstraClear House, Cnr The Sq &, Fitzherbert Ave, Palmerston North",
"start_date": "2005-11-14T00:00:00",
"end_date": "2006-09-25T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "C/-Morrison Advisory, Floor 5, TelstraClear House, Cnr The Sq &, Fitzherbert Ave, Palmerston North",
"start_date": "2005-11-14T00:00:00",
"end_date": "2006-09-25T00:00:00"
},
{
"type": "RegisteredAddress",
"fullAddress": "C/-Morrison Creed, 1st Floor, Cnr Main, St & Victoria Ave, Palmerston North",
"country": "NZ",
"start_date": "2006-09-25T00:00:00"
}
],
"directors": [
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Lance",
"lastName": "MORRISON",
"middleNames": "David"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2005-11-14T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Frances",
"lastName": "HARVEY",
"middleNames": "Ann"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2005-11-14T00:00:00"
},
{
"asicDirectorshipYn": "false",
"roleAddress": [],
"roleAsicAddress": [],
"rolePerson": [
{
"firstName": "Martin",
"lastName": "HARVEY",
"middleNames": "Gray"
}
],
"roleStatus": "ACTIVE",
"roleType": "Director",
"startDate": "2005-11-14T00:00:00"
}
],
"info": {
"annualReturnFilingMonth": "9",
"annualReturnLastFiled": "2009-08-25T15:53:45",
"extensiveShareholding": "false",
"hasConstitutionFiled": "false",
"overseasCompany": "false",
"shareholding": [
{
"numberOfShares": "120",
"shareAllocation": [
{
"allocation": "60",
"shareholder": [
{
"appointmentDate": "2005-11-14T00:00:00",
"individualShareholder": [
{
"firstName": "Martin",
"fullName": "Martin Gray HARVEY",
"lastName": "HARVEY",
"middleNames": "Gray"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
},
{
"allocation": "60",
"shareholder": [
{
"appointmentDate": "2005-11-14T00:00:00",
"individualShareholder": [
{
"firstName": "Frances",
"fullName": "Frances Ann HARVEY",
"lastName": "HARVEY",
"middleNames": "Ann"
}
],
"otherShareholder": [],
"shareholderAddress": [],
"type": "individual"
}
]
}
]
}
]
},
"attributes": {
"bn_start_date": "2005-11-14T00:00:00",
"detailed_bn_status": "80 (Removed)",
"month_in_business": "216",
"registration_date": "2005-11-14T00:00:00"
},
"last_updated_date": "2013-11-02T15:10:16"
}
]
}
```
### Sample Request and Response for Reload API
Request 1: POST -Reload the recently downloaded data from $HARMONY_HOME/ROAD/DOWNLOAD into $HARMONY_HOME/ROAD/LATEST , to reload NewZealand Business Data use country in request as 'nz'
```http
http://localhost:18080/business/v1/reload?country=au&key=123456
```
Response: New Business Data has been uploaded to the "LATEST" directory. Information from the "DOWNLOAD" location will be deleted.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": "Index reloaded!"
}
```
Request 2: POST -Reload without any data in the designated DOWNLOAD folder.
```json
http://localhost:18080/business/v1/reload?country=au&key=123456
```
Response 2: No new data will be refreshed; as a result, the Version API should continue to provide details of the existing business data.
```json
{
"status": "SUCCESS",
"messages": [],
"payload": "No new index to reload!"
}
```
### Sample Request and Response for Version API
Request: GET- Verify Business Data Version Number and Expiry Date for au, for NewZealand use country in the request as nz.
```http
http://localhost:18080/business/v1/version?country=au
```
Response: Returns Version and Expiry date of Business Data
```json
{
"status": "SUCCESS",
"messages": [],
"payload": {
"name": "HELLO_ABN",
"number": "ABN Bulk Extract Part 1-Tue Oct 17 00:00:00 GMT 2023;ABN Bulk Extract Part 2 -Tue Oct 17 00:00:00 GMT 2023",
"expiryDate": "2024-10-17T00:00:00.000+00:00",
"implVersion": "0.0.1"
}
}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-lookup.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.