Lookup
Use the /lookup endpoint to search for an entity by its registry identifier and retrieve basic information such as the entity name, status, classification, and address. This is useful for pre-filling verification or form submissions with official registry data before calling the Forms API or KYB API.
Supported countries
| Country | Accepted identifiers | Data source |
|---|---|---|
| Australia (AUS) | ABN (11 digits) or ACN (9 digits) | Australian Business Register (ABR) and ASIC Company Dataset |
| New Zealand (NZL) | NZBN (13 digits) | New Zealand Business Number registry |
Look up an entity
This endpoint allows you to look up an entity by country and identifier. It returns basic registry information such as the entity name, classification options, status, and address.
Query parameters
- Name
country- Type
- string
- Description
3 letter country ISO code (e.g. AUS, NZL).
- Name
id- Type
- string
- Description
The unique identifier of the entity to look up. Country-specific (e.g. ABN or ACN in Australia, NZBN in New Zealand).
Request
curl "https://dev.bronid.com/v5/lookup?country=AUS&id=33051775556" \
--user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314"
AUS response
{
"match": true,
"country": "AUS",
"name": "TELSTRA CORPORATION LIMITED",
"classification": {
"default": {
"type": "company",
"subType": "none"
},
"options": [
{
"type": "company",
"subTypes": ["none"]
}
]
},
"names": [
{
"value": "TELSTRA INFRACO",
"type": "businessName"
},
{
"value": "TELECOM AUSTRALIA",
"type": "businessName"
},
{
"value": "TELSTRA",
"type": "tradingName"
},
{
"value": "TELSTRA CORPORATION LIMITED",
"type": "tradingName"
}
],
"entityNumber": "33051775556",
"entityNumbers": [
{
"value": "33051775556",
"type": "ABN"
},
{
"value": "051775556",
"type": "ACN"
}
],
"entityStatus": "Active",
"entityType": "Australian Public Company",
"entityTypeCode": "publicCompany",
"address": {
"text": "VIC 3000",
"state": "VIC",
"postcode": "3000"
},
"metadata": {
"dateRegistered": "2000-07-01"
}
}
NZL response
{
"match": true,
"country": "NZL",
"name": "SPARK NEW ZEALAND LIMITED",
"classification": {
"default": {
"type": "company",
"subType": "none"
},
"options": [
{
"type": "company",
"subTypes": ["none"]
}
]
},
"names": [
{
"value": "SPARK NEW ZEALAND",
"type": "tradingName"
}
],
"entityNumber": "9429041910672",
"entityNumbers": [
{
"value": "9429041910672",
"type": "NZBN"
}
],
"entityStatus": "Registered",
"entityType": "NZ Limited Company",
"entityTypeCode": "company",
"address": null,
"metadata": {
"dateRegistered": "2014-06-01"
}
}
The lookup response model
The lookup response contains basic registry information about the matched entity, including its name, identifiers, status, classification, and address.
Properties
- Name
match- Type
- boolean
- Description
Indicates if the entity was found in the registry.
- Name
country- Type
- string
- Description
3 letter country ISO code.
- Name
name- Type
- string
- Description
The main name of the entity.
- Name
classification- Type
- object
- Description
The canonical classification model for the entity. It provides a default and most likely pair through
classification.default, plus any additional validtype/subTypecombinations throughclassification.options. You can map these values directly into request payload fields for the Forms API and KYB API. For more details, see Working With Classification below.
- Name
entityType- Type
- string
- Description
Human-readable description of the entity type (e.g. Australian Public Company, NZ Limited Company).
- Name
entityTypeCode- Type
- string
- Deprecated
- deprecated
- Description
Legacy entity type code kept for compatibility. Use
classification.defaultas the primary value andclassification.optionsfor additional valid choices.
- Name
names- Type
- array
- Description
Array of name objects with different names the entity is known by.
- Name
entityNumber- Type
- string
- Description
The main entity number found.
- Name
entityNumbers- Type
- array
- Description
Array of entity number objects.
- Name
entityStatus- Type
- string
- Description
Text description of entity status from the registry (e.g. Active, Registered).
- Name
address- Type
- object | null
- Description
Address of the entity, or null if not available. NZL lookups always return
nullfor this field.
- Name
metadata- Type
- object
- Description
Additional registry metadata. See Metadata below.
Names array
- Name
value- Type
- string
- Description
The name of the entity.
- Name
type- Type
- string
- Description
The type of name: businessName, tradingName, or formerName.
Entity numbers array
- Name
value- Type
- string
- Description
The entity number.
- Name
type- Type
- string
- Description
The type of identifier (e.g. ABN, ACN, NZBN).
Address object
- Name
text- Type
- string | null
- Description
Address as a single line of text.
- Name
state- Type
- string | null
- Description
State of the address.
- Name
postcode- Type
- string | null
- Description
Postcode of the address.
Metadata
- Name
dateRegistered- Type
- string | null
- Description
The date the entity was registered with the registry (e.g.
"2000-07-01"), or null if not available.
Error responses
When the lookup fails, the response will differ depending on the type of error.
Entity not found
Returned when the identifier does not match any entity in the registry.
{
"match": false,
"message": "Could not find entity."
}
Unsupported country
Returned when the country parameter is not a supported country.
{
"match": false,
"message": "Country not supported"
}
Validation error
Returned with HTTP status 400 when the request is missing required parameters or contains invalid values.
{
"details": [
{
"message": "id is required",
"path": "id",
"value": ""
}
],
"error": "Bad Request",
"message": "Validation failed",
"timestamp": 1700000000000
}
Working With Classification
Use the classification field as your source of truth for choosing type and subType values for downstream API calls.
1) Classification Schema
- Name
default- Type
- object
- Description
The default and most likely classification pair to use automatically. In some cases, additional valid pairs may also be available in
options.
- Name
options- Type
- array
- Description
Non-empty list of available classification options for the entity, which will include the default pair.
2) Default Item Schema
- Name
type- Type
- string
- Description
Default entity type to use when no user selection is needed.
- Name
subType- Type
- string
- Description
Default entity subtype paired with the default type.
3) Option Item Schema
- Name
type- Type
- string
- Description
The entity type for this option (e.g. company, trust, partnership).
- Name
subTypes- Type
- array
- Description
Non-empty list of allowed entity subtypes for this option.
In practice, only two entity types — Other Unincorporated Entity and Other Incorporated Entity — produce multiple classification options.
In almost all cases, options will contain a single item with a single subType, so the customer will know exactly which option to use and no
selection prompt is needed and it's safe to auto-select the default.
4) How To Use It
- Call
/v5/lookupand readclassification.options. - If
optionshas exactly 1 item with 1 subType — the entity type is unambiguous. Auto-selectclassification.defaultand skip any user prompt. - If
optionshas multiple items — the registry entity type is ambiguous (e.g. a Government Co-operative could becooperative,governmentBody, orother). Pre-selectclassification.defaultbut let the customer choose from all options. - If a single option has multiple
subTypes— the type is known but the subtype is ambiguous. Pre-select the default subType but let the customer pick. - Submit the selected
typeandsubTypevalues directly to the Forms API or KYB API.
5) Practical Examples
Example A — Unambiguous entity (auto-select)
An Australian Private Company (ABN lookup). Single option, single subType. Use the default directly — no user selection needed.
{
"classification": {
"default": { "type": "company", "subType": "none" },
"options": [{ "type": "company", "subTypes": ["none"] }]
}
}
Auto-populate type: "company" and subType: "none" in your form submission.
Example B — Ambiguous entity type (let user choose type)
A Government Co-operative registered with ABR. The registry code maps to 3 possible types. Pre-select the default but present all options to the customer.
{
"classification": {
"default": { "type": "cooperative", "subType": "none" },
"options": [
{ "type": "cooperative", "subTypes": ["none"] },
{ "type": "governmentBody", "subTypes": ["none"] },
{ "type": "other", "subTypes": ["none"] }
]
}
}
Show a selector pre-filled with "cooperative". The customer can confirm or switch to "governmentBody" or "other".
Example C — Known type, multiple subtypes (let user choose subtype)
A trust registered with the NZBN. The type is known (trust) but the specific trust subtype is ambiguous.
{
"classification": {
"default": { "type": "trust", "subType": "discretionaryTrust" },
"options": [{ "type": "trust", "subTypes": ["discretionaryTrust", "unitTrust", "hybridTrust"] }]
}
}
Show a subtype selector pre-filled with "discretionaryTrust". The customer can confirm or pick "unitTrust" or "hybridTrust".
What's next?
Once you have the lookup response, use the classification values to pre-fill your downstream API requests: