/nzbn/companies/search

POST /api/nzbn/companies/search

Price: 1 credit

Search the New Zealand Business Number register by business name or website, optionally filtered by one or more entity statuses (e.g. Registered, InLiquidation) and entity types (e.g. NZCompany, SoleTrader, Trust). Returns matching businesses with NZBN, name, status, type, trading names, previous names and industry classification.

How to use it

Search New Zealand businesses by name or website. Filter by entity_status and/or entity_type (both accept multiple values). Returns NZBN, name, status, type and trading names. Use nzbn/companies to fetch one business's full record by NZBN.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Business name or website to search for (examples: "spark", "spark.co.nz")
• entity_status array nullable — Filter by one or more entity statuses (one of: "Registered", "VoluntaryAdministration", "InReceivership", "InLiquidation", "InStatutoryAdministration", "Inactive", "RemovedClosed")
• entity_type array nullable — Filter by one or more entity types (one of: "NZCompany", "OverseasCompany", "SoleTrader", "Partnership", "Trust", "IncorporatedSociety", "CharitableTrust", "GovtCentral", "GovtEdu", "GovtLocal", "GovtOther", "LimitedPartnershipNz", "FriendlySociety", "IndustrialAndProvidentSociety", "CreditUnion", "LimitedPartnershipOverseas", "BuildingSociety", "SpecialBodies")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "NzbnSearchCompany")
• nzbn string required
• name string required
• entity_status_code string nullable
• entity_status string nullable
• entity_type_code string nullable
• entity_type_description string nullable
• registration_date string nullable
• source_register_id string nullable
• previous_names array
• trading_names array
  • @type string (default: "NzbnTradingName")
  • name string required
  • start_date string nullable
  • end_date string nullable
• industry_classifications array
  • @type string (default: "NzbnIndustryClassification")
  • code string nullable
  • description string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.