Skip to main content
POST
/
api
/
nzbn
/
companies
/nzbn/companies
curl --request POST \
  --url https://api.anysite.io/api/nzbn/companies \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "nzbn": "<string>",
  "timeout": 300
}
'
[
  {
    "nzbn": "<string>",
    "name": "<string>",
    "@type": "@nzbn_company",
    "entity_status_code": "<string>",
    "entity_status": "<string>",
    "entity_type_code": "<string>",
    "entity_type_description": "<string>",
    "registration_date": "<string>",
    "last_updated_at": "<string>",
    "source_register": "<string>",
    "source_register_id": "<string>",
    "australian_business_number": "<string>",
    "australian_company_number": "<string>",
    "overseas_company": false,
    "country_of_origin": "<string>",
    "annual_return_filing_month": 123,
    "annual_return_last_filed": "<string>",
    "financial_report_filing_month": 123,
    "has_constitution_filed": false,
    "extensive_shareholding": false,
    "removal_commenced": false,
    "number_of_shares": 123,
    "charities_number": "<string>",
    "balance_date": "<string>",
    "emails": [
      {
        "@type": "@nzbn_email",
        "email_address": "<string>",
        "purpose": "<string>",
        "start_date": "<string>"
      }
    ],
    "phones": [
      {
        "@type": "@nzbn_phone",
        "phone_number": "<string>",
        "country_code": "<string>",
        "area_code": "<string>",
        "purpose": "<string>",
        "start_date": "<string>"
      }
    ],
    "websites": [
      "<string>"
    ],
    "addresses": [
      {
        "@type": "@nzbn_address",
        "address_type": "<string>",
        "care_of": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "address_line_4": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "start_date": "<string>",
        "end_date": "<string>"
      }
    ],
    "industry_classifications": [
      {
        "@type": "@nzbn_industry_classification",
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "trading_names": [
      {
        "name": "<string>",
        "@type": "@nzbn_trading_name",
        "start_date": "<string>",
        "end_date": "<string>"
      }
    ],
    "trading_areas": [
      {
        "trading_area": "<string>",
        "@type": "@nzbn_trading_area",
        "start_date": "<string>",
        "end_date": "<string>"
      }
    ],
    "roles": [
      {
        "@type": "@nzbn_role",
        "role_type": "<string>",
        "role_status": "<string>",
        "first_name": "<string>",
        "middle_names": "<string>",
        "last_name": "<string>",
        "entity_name": "<string>",
        "entity_nzbn": "<string>",
        "start_date": "<string>",
        "end_date": "<string>",
        "addresses": [
          {
            "@type": "@nzbn_address",
            "address_type": "<string>",
            "care_of": "<string>",
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "address_line_4": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "start_date": "<string>",
            "end_date": "<string>"
          }
        ]
      }
    ],
    "share_allocations": [
      {
        "@type": "@nzbn_share_allocation",
        "allocation": 123,
        "shareholders": [
          {
            "@type": "@nzbn_shareholder",
            "type": "<string>",
            "first_name": "<string>",
            "middle_names": "<string>",
            "last_name": "<string>",
            "full_name": "<string>",
            "entity_name": "<string>",
            "entity_nzbn": "<string>",
            "appointment_date": "<string>",
            "vacation_date": "<string>",
            "address": {
              "@type": "@nzbn_address",
              "address_type": "<string>",
              "care_of": "<string>",
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "address_line_4": "<string>",
              "postal_code": "<string>",
              "country_code": "<string>",
              "start_date": "<string>",
              "end_date": "<string>"
            }
          }
        ]
      }
    ],
    "insolvencies": [
      {
        "@type": "@nzbn_insolvency",
        "insolvency_type": "<string>",
        "commenced": "<string>",
        "appointees": [
          {
            "@type": "@nzbn_insolvency_appointee",
            "first_name": "<string>",
            "middle_names": "<string>",
            "last_name": "<string>",
            "full_name": "<string>",
            "organisation_name": "<string>",
            "email": "<string>",
            "appointment_date": "<string>",
            "vacation_date": "<string>",
            "address": {
              "@type": "@nzbn_address",
              "address_type": "<string>",
              "care_of": "<string>",
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "address_line_4": "<string>",
              "postal_code": "<string>",
              "country_code": "<string>",
              "start_date": "<string>",
              "end_date": "<string>"
            }
          }
        ]
      }
    ],
    "ultimate_holding_company": {
      "@type": "@nzbn_ultimate_holding_company",
      "name": "<string>",
      "type": "<string>",
      "number": "<string>",
      "nzbn": "<string>",
      "country": "<string>",
      "effective_date": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
nzbn
string
required

New Zealand Business Number (13 digits)

Example:

"9429046208439"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

nzbn
string
required
name
string
required
@type
string
default:@nzbn_company
entity_status_code
string | null
entity_status
string | null
entity_type_code
string | null
entity_type_description
string | null
registration_date
string | null
last_updated_at
string | null
source_register
string | null
source_register_id
string | null
australian_business_number
string | null
australian_company_number
string | null
overseas_company
boolean
default:false
country_of_origin
string | null
annual_return_filing_month
integer | null
annual_return_last_filed
string | null
financial_report_filing_month
integer | null
has_constitution_filed
boolean
default:false
extensive_shareholding
boolean
default:false
removal_commenced
boolean
default:false
number_of_shares
integer | null
charities_number
string | null
balance_date
string | null
emails
NzbnEmail · object[]
phones
NzbnPhone · object[]
websites
string[]
addresses
NzbnAddress · object[]
industry_classifications
NzbnIndustryClassification · object[]
trading_names
NzbnTradingName · object[]
trading_areas
NzbnTradingArea · object[]
roles
NzbnRole · object[]
share_allocations
NzbnShareAllocation · object[]
insolvencies
NzbnInsolvency · object[]
ultimate_holding_company
NzbnUltimateHoldingCompany · object