• Home
  • NZBN Lookup Premium – Help & Documentation
user guide

NZBN Lookup Premium – Help & Documentation

This guide walks you through setting up your API key, adding the PCF control, and verifying it's working — with screenshots and a live demo.

Introduction

Welcome to NZBN Lookup Premium!

To begin using real-time NZBN validation and data enrichment in your Dynamics 365 environment, you’ll need to set up your NZBN API Key and add the PCF control to your solution.

This guide walks you through:

  1. How to obtain your NZBN API Key

  2. How to install and configure the control

  3. Where to enter your API Key in Dynamics 365

Register for Your NZBN API Key

1. Visit the MBIE API Portal

Go to the NZBN API developer portal (hosted at api.business.govt.nz) — this is the official gateway to subscribe to the NZBN API and manage credentials.

2. Sign In or Create an Account

Log in using your existing credentials or create a new account if you don’t already have one. This is required before subscribing.

3. Subscribe to the NZBN API Product

Navigate to “Explore APIs” or the NZBN API product page, then click “Subscribe”. api.business.govt.nz

You may be asked for some information about your intended use—complete that as needed for approval.

4. Receive Approval

The MBIE API support team will review your subscription. Once approved, you’ll gain access to both sandbox (for testing) and production environments. 

5. Generate Your API Subscription Key
  • In your account dashboard, go to the NZBN API subscription details.
  • Click “Generate API Key”, or similar, to produce your subscription key.
  • Use the sandbox key for development and the production key when ready to go live.
  • Under Web Services Agreement, click Get an API key
  • Copy your API Key (a long alphanumeric string)

💡 Tip: Store your API Key in a secure password manager for easy access.

Add the NZBN Lookup Premium PCF Control

You can integrate the NZBN Lookup control into any of your existing solutions — you do not need to reuse the sample solution.

🛠 Steps:

  1. Go to make.powerapps.com

  2. Open the solution where you want to use the NZBN Lookup Premium tool

  3. Navigate to: Data → Tables, then select the table (e.g., Account, Contact, or a custom table)

  4. Under Columns, click your NZBN field

  5. Open the Controls tab

  6. Click + Add Control → select NZBN Lookup

  7. Click Save

Enter Your API Key in the Control

  1. Open any form where you’ve added the NZBN Lookup control

  2. Click the control, then select Edit

  3. In the Custom Properties pane, find the field:

    • API Key: ___________________________

  4. Paste the NZBN API Key you copied earlier

  5. Click Save, then Publish All Customizations

📌 Notes:

  1. You only need to enter the API key once per environment.

  2. Ensure the NZBN field uses Single Line of Text format.

  3. The control supports both NZBN number and business name search.