Skip to main content
POST
/
api
/
nzbn
/
companies
/
search
/nzbn/companies/search
curl --request POST \
  --url https://api.anysite.io/api/nzbn/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300,
  "entity_status": [],
  "entity_type": []
}
'
[
  {
    "nzbn": "<string>",
    "name": "<string>",
    "@type": "@nzbn_search_company",
    "entity_status_code": "<string>",
    "entity_status": "<string>",
    "entity_type_code": "<string>",
    "entity_type_description": "<string>",
    "registration_date": "<string>",
    "source_register_id": "<string>",
    "previous_names": [
      "<string>"
    ],
    "trading_names": [
      {
        "name": "<string>",
        "@type": "@nzbn_trading_name",
        "start_date": "<string>",
        "end_date": "<string>"
      }
    ],
    "industry_classifications": [
      {
        "@type": "@nzbn_industry_classification",
        "code": "<string>",
        "description": "<string>"
      }
    ]
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required

Business name or website to search for

Examples:

"spark"

"spark.co.nz"

count
integer
required

Max number of results

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
entity_status
enum<string>[] | null

Filter by one or more entity statuses

Available options:
Registered,
VoluntaryAdministration,
InReceivership,
InLiquidation,
InStatutoryAdministration,
Inactive,
RemovedClosed
entity_type
enum<string>[] | null

Filter by one or more entity types

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:@nzbn_search_company
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
NzbnTradingName · object[]
industry_classifications
NzbnIndustryClassification · object[]