/nzbn/companies

POST /api/nzbn/companies

Price: 1 credit

Get a New Zealand business's full registry record from the NZBN register by its New Zealand Business Number: name, entity status and type, registration date, Australian Business Number, directors and officers, shareholders and share allocations, trading names and areas, industry classification, registered/service/postal addresses, contact details, annual return filing month, constitution status and insolvency history.

How to use it

Look up one New Zealand business by its 13-digit NZBN (e.g. '9429046208439'). Returns one item with name, status, type, directors/officers (roles), shareholders, trading names, addresses, contact details and company filing information. To find an NZBN by name, use nzbn/companies/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• nzbn string required — New Zealand Business Number (13 digits) (examples: "9429046208439")

Response

• @type string (default: "NzbnCompany")
• 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
• last_updated_at string nullable
• source_register string nullable
• source_register_id string nullable
• australian_business_number string nullable
• australian_company_number string nullable
• overseas_company boolean (default: false)
• country_of_origin string nullable
• annual_return_filing_month integer nullable
• annual_return_last_filed string nullable
• financial_report_filing_month integer nullable
• has_constitution_filed boolean (default: false)
• extensive_shareholding boolean (default: false)
• removal_commenced boolean (default: false)
• number_of_shares integer nullable
• charities_number string nullable
• balance_date string nullable
• emails array
  • @type string (default: "NzbnEmail")
  • email_address string nullable
  • purpose string nullable
  • start_date string nullable
• phones array
  • @type string (default: "NzbnPhone")
  • phone_number string nullable
  • country_code string nullable
  • area_code string nullable
  • purpose string nullable
  • start_date string nullable
• websites array
• addresses array
  • @type string (default: "NzbnAddress")
  • address_type string nullable
  • care_of string nullable
  • address_line_1 string nullable
  • address_line_2 string nullable
  • address_line_3 string nullable
  • address_line_4 string nullable
  • postal_code string nullable
  • country_code string nullable
  • start_date string nullable
  • end_date string nullable
• industry_classifications array
  • @type string (default: "NzbnIndustryClassification")
  • code string nullable
  • description string nullable
• trading_names array
  • @type string (default: "NzbnTradingName")
  • name string required
  • start_date string nullable
  • end_date string nullable
• trading_areas array
  • @type string (default: "NzbnTradingArea")
  • trading_area string required
  • start_date string nullable
  • end_date string nullable
• roles array
  • @type string (default: "NzbnRole")
  • role_type string nullable
  • role_status string nullable
  • first_name string nullable
  • middle_names string nullable
  • last_name string nullable
  • entity_name string nullable
  • entity_nzbn string nullable
  • start_date string nullable
  • end_date string nullable
  • addresses array
    • @type string (default: "NzbnAddress")
    • address_type string nullable
    • care_of string nullable
    • address_line_1 string nullable
    • address_line_2 string nullable
    • address_line_3 string nullable
    • address_line_4 string nullable
    • postal_code string nullable
    • country_code string nullable
    • start_date string nullable
    • end_date string nullable
• share_allocations array
  • @type string (default: "NzbnShareAllocation")
  • allocation integer nullable
  • shareholders array
    • @type string (default: "NzbnShareholder")
    • type string nullable
    • first_name string nullable
    • middle_names string nullable
    • last_name string nullable
    • full_name string nullable
    • entity_name string nullable
    • entity_nzbn string nullable
    • appointment_date string nullable
    • vacation_date string nullable
    • address object nullable (see schema NzbnAddress)
• insolvencies array
  • @type string (default: "NzbnInsolvency")
  • insolvency_type string nullable
  • commenced string nullable
  • appointees array
    • @type string (default: "NzbnInsolvencyAppointee")
    • first_name string nullable
    • middle_names string nullable
    • last_name string nullable
    • full_name string nullable
    • organisation_name string nullable
    • email string nullable
    • appointment_date string nullable
    • vacation_date string nullable
    • address object nullable (see schema NzbnAddress)
• ultimate_holding_company object nullable
  • @type string (default: "NzbnUltimateHoldingCompany")
  • name string nullable
  • type string nullable
  • number string nullable
  • nzbn string nullable
  • country string nullable
  • effective_date 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 — No business found for the given NZBN 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.