External Lookup – New Zealand Business Number

Business Background

Look up external information on businesses registered in New Zealand using Titan Web.

Titan Solution

You can use the external lookup widget to look up external business information, such as the NZBN or name.

The widget will provide access to publicly available information when businesses register for a New Zealand Business Number (NZBN) or a business name. The latter is useful when you don’t have an NZBN.

How to Video

Coming soon!

How to Guide

  1. Select the + icon to add an element.
  2. Under the Widget option, drag-and-drop the External Lookup widget to the canvas.
External lookup widget
  1. Select the External Lookup widget’s Gear icon. The External Lookup Settings screen opens.
  2. Select the Configure APIs button. The API Keys screen opens.
Configure APIs button
Configure APIs button
  1. Select the NZBN option.
  2. Use the Enable toggle switch to switch it on.
  3. Paste the NZBN API Key in the field and select the Apply button. Browse here for more information on obtaining the API from the New Zealand government.
API Keys screen
API Keys screen
  1. Use the drop-down list to select the NZBN option.
  2. Select the Configure Mapping button. The Configure Custom Parameters screen opens.
Configure Mapping
Configure Mapping
  1. Map the relevant fields.
Configure Custom Parameters screen
Configure Custom Parameters screen
NumberTitan labelAPI labelDescription
1entityStatusCodeentityStatusCodeA code that identifies the business entity’s current trading status, during formation, operation, and voluntary or involuntary winding up. A full list is available on the API explorer website. Not required for POST.
2entityNameentityNameThe current registered name of the business entity, which may differ from its trading name(s) and historic entity names. For sole traders the entity name is a concatenation of First, Middle and Last Names recorded in the sole trader role entry. Not required for POST.
3nbznnbznThe 13 digit unique identifier of a New Zealand business entity. Not required for POST.
4entityTypeCodeentityTypeCodeEntity type code. One of LTD, ULTD, COOP, ASIC, NON_ASIC, Sole_Trader, Partnership, Trading_Trust, B, I, D, F, N, S, T, Y, Z, GovtCentral, GovtLocal, GovtEdu, GovtOther.
5entityTypeDescriptionentityTypeDescriptionOne of NZ Limited Company, NZ Unlimited Company, NZ Co-operative Company, Overseas ASIC Company, Overseas Non-ASIC Company, Sole Trader, Partnership, Trust, Building Society, Incorporated Society, Credit Union , Friendly Society, Industrial & Provident Society, Special Body, Charitable Trust, Limited Partnership (NZ), Limited Partnership (Overseas), Central Government, Local Government, Education, Other Public Entity.
6entityStatusDescriptionentityStatusDescriptionThe description of the business entity’s trading status, e.g. showing registered or in voluntary or involuntary winding up. Not required for POST.
7tradingNamestradingNamesA trading name used by this business entity.
8classificationCodesclassificationCodeBIC Code that is applicable to this entity’s nature of work.
9classificationDescriptionclassificationDescriptionDescription of this entity’s nature of work.
10classificationUniqueIdentifiersuniqueIdentifierA code to allow updating of this record.
11registrationDateregistrationDateDate/time type.
12sourceRegisterUniqueIdsourceRegisterUniqueIdString type.
  1. Select the Apply button.

Hidden Title

Need more help?