Tool · Business register

NZBN entity details

Look up public New Zealand business data using a 13-digit NZBN.

Start building free Connect your client

Published tool ID

nzbn_get_entity

Look up public New Zealand business data using a 13-digit NZBN.

ServerNew Zealand

SourceNew Zealand Business Number (NZBN) register

Credit behavior1 credit

AccessWorkspace permissions

Inputs and outputs

Published input schema

Use the discovered runtime schema for the workspace you are connected to.

Public catalog

nzbn_get_entity input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "nzbn",
    "detail"
  ],
  "properties": {
    "nzbn": {
      "type": "string",
      "pattern": "^\\d{13}$"
    },
    "detail": {
      "type": "string",
      "enum": [
        "summary",
        "standard",
        "full"
      ],
      "default": "standard"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-zA-Z][a-zA-Z0-9_.]*$"
      },
      "maxItems": 30
    }
  },
  "additionalProperties": false
}

Published output shape

Tool results return structured data or a stable error object.

Shared Aroai tool output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "summary": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        "executionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "creditsCharged": {
          "type": "number",
          "minimum": 0
        }
      },
      "required": [
        "summary",
        "data",
        "creditsCharged"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "retryable": {
              "type": "boolean"
            }
          },
          "required": [
            "code",
            "message",
            "retryable"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "error"
      ],
      "additionalProperties": false
    }
  ]
}

Source and usage notes

Understand the result boundary

Use the exact identifier returned by a search or another authorised source.
The NZBN source accepts a workspace-provided key; the listed credit behavior remains one credit.
Select detail and fields to keep the response focused.
Do not claim a director or shareholder field unless the returned source data contains it.

View sources and coverage

Use this capability

Put the tool in a complete workflow.

Follow a recipe that explains the input, sequence, result and human review points.

Open a recipe Client setup

Local intelligence. Ready to build.

Start with a task you can inspect.

Connect a compatible client, choose a workflow and review the source fields that come back.

Start building free Explore tools