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 validation requires using 2 API's each provide a specific purpose.
Find- Returns a list of valid business based on partial or complete business information.
Retrieve- Uses the Id value from Find API or clear text business/company number to return the validated and enriched business information available for each country.
Supported Countries: Australia, New Zealand
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.
get
Authorizations
AuthorizationstringRequired
Query parameters
countrystring · enumRequired
Country ISO2 code
Possible values:
namestringRequired
The name to be searched, it can be business number, company or any entity names
nameTypesstringOptional
Enity types want to search from, default will search ALL. It accepts multiple types seperated by comma e.g. MN,. MN → Main Entity Name; LGL → legal Entity Name, not applicable for NZ; TRD → trading name; BN → business name, not applicable for NZ; OTN → other name in Other Entity for AU and previous name for NZ; DGR → DGR name, not applicable for NZ. e.g. TRD, OTN -> search against trading names and other name
bnStatusstringOptional
business number status want to search, default will be empty which will search ALL. e.g For AU, ACT -> Active, CAN -> Cancelled.
taxStatusstringOptional
tax/gst status want to search, default will be empty which will search ALL. It is not applicable for NZ. e.g. for AU ACT -> Active, CAN -> Cancelled, NON -> None, not applicable for NZ
detailedBnStatusstringOptional
Detailed busines entity status codes, default will search ALL, 80-Removed, 50-Registered, 60-In Liquidation, 71-In Receivership & In Liquidation, 62-Removed & In Liquidation, 70-In Receivership, 61-In Liquidation and Receivership, 55-Voluntary Administration, 72-In Statutory Management, 91-Closed. e.g. 80,91 -> search for status removed and closed. Currently only supported for NZ
statestringOptional
The state of the entity for searching, default will search ALL, not applicable for NZ. It accept multiple states. e.g. NSW,QLD -> search against NSW and QLD entities
hitsstringOptional
The maximum number of results returned from the lookup. If empty default will be 20
caseTypestring · enumOptional
Case type for entity name, default is whatever the case in the reference data
Response will be a combination of Main Entity name, Trading Name and Business names etc.
Examples
Request 1: Lookup for active business names from multiple states
Response 1: Please note that the records with the same id pertains to same business. For e.g. Mastersoft Pty. Ltd. is the Main entity name while Mastersoft Pty Ltd is the Trading Name
Request 2: Lookup for active business names against Main Entity names
Response 2:
Request 3: Lookup for active business names with cancelled tax status
Response 3:
Request 4: Lookup business name using ABN number
Response 4:
Retrieve
Retrieves the validated and enriched business information for the supplied Id value from Find API or clear text business or company number.
Id value from Find API response OR clear text business OR clear text company number.
caseType
string
"LOW"
Case Type of text returned in the response.
selectedName
string
"AUGUSTA 4WD"
The 'selectedName' parameter utilized in the 'retrieve' request is used to assign either the business name or trading name to the 'display_name' field within the response payload. For instance, in the context of the 'Find' API, the name chosen by the user might not necessarily represent the primary entity name, it could be a trading name or business name etc.
When invoking the 'retrieve' request, users can pass on this 'selectedName,' resulting in the 'display_name' being rendered as 'main entity name trading as BN/main entity name trading as TRD'.
When 'selectedName' is not used in the retrieve request,' 'display_name' and 'name' both represent main entity name.