Tool · Business register

Search NZ businesses

Search the public NZBN register by business name with bounded cursor pagination.

Published tool ID

nzbn_search

Search the public NZBN register by business name with bounded cursor pagination.

ServerNew Zealand
SourceNew Zealand Business Number (NZBN) register
Credit behavior1 credit per page
AccessWorkspace permissions

Inputs and outputs

Published input schema

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

Public catalog
nzbn_search input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "query",
    "limit",
    "detail"
  ],
  "properties": {
    "query": {
      "type": "string",
      "minLength": 2,
      "maxLength": 200
    },
    "cursor": {
      "type": "string",
      "maxLength": 200
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 10
    },
    "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

  • A search page costs one credit with the platform or your NZBN key.
  • Use the returned NZBN to request entity details.
  • A search result is a candidate match, not a due diligence conclusion.
  • Returned fields depend on the public source record; never infer absent fields.
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.

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.