Business lookup methods take partial or complete business information to search against the business Source of Truth, returning validated and enriched business information.
To complete business lookup requires one Find API that returns detailed information of the business entity.
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.
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 statesResponse 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)
Request 2: GET- Lookup for Legal Entity NamesResponse 2: Response includes Legal Entity Names only.Request 3: POST- Lookup for business names with active tax statusResponse 3: Response includes business with active tax statusRequest 4: GET- Lookup business name using Business NumberResponse 4: Returns only one business entity name
Sample Request and Response for NewZealand
Request 1: POST -Lookup for active business namesResponse 1: Response includes only active business.Request 2: POST- Lookup for main names and trading names with cancelled business statusResponse 2: Response includes only cancelled business. Request 3: GET -Lookup business name using Company NumberResponse 3: Returns only one business entity name.Request 4: POST -Lookup business using Business NumberResponse 4: Returns only one business entity name.
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'Response: New Business Data has been uploaded to the "LATEST" directory. Information from the "DOWNLOAD" location will be deleted.Request 2: POST -Reload without any data in the designated DOWNLOAD folder.Response 2: No new data will be refreshed; as a result, the Version API should continue to provide details of the existing business data.
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.Response: Returns Version and Expiry date of Business Data