Skip to main content
POST
/nzbn/companies/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
entity_status
enum<string>[] | null
Available options:
Registered,
VoluntaryAdministration,
InReceivership,
InLiquidation,
InStatutoryAdministration,
Inactive,
RemovedClosed
entity_type
enum<string>[] | null
Available options:
NZCompany,
OverseasCompany,
SoleTrader,
Partnership,
Trust,
IncorporatedSociety,
CharitableTrust,
GovtCentral,
GovtEdu,
GovtLocal,
GovtOther,
LimitedPartnershipNz,
FriendlySociety,
IndustrialAndProvidentSociety,
CreditUnion,
LimitedPartnershipOverseas,
BuildingSociety,
SpecialBodies

Response

Successful Response

nzbn
string
required
name
string
required
@type
string
default:NzbnSearchCompany
entity_status_code
string | null
entity_status
string | null
entity_type_code
string | null
entity_type_description
string | null
registration_date
string | null
source_register_id
string | null
previous_names
string[]
trading_names
object[]
industry_classifications
object[]