Getting started with NZGD External API

Follow the steps below to create an account and get access to available NZGD APIs:

1. Please email support@nzgd.org.nz with the following details:

   • First Name

   • Last Name

   • Your Organisation's preferred email address for the API Developer account. Make sure this is a generic admin or developer email, as your Organisation can only have one account associated with the API portal.

     Note: Please provide an Organisation-wide email address with an accessible mailbox that can be monitored by relevant users in your Organisation who can respond to the auditor regarding matters such as review-required records, data issues, etc. This email address will be linked to the API subscription and will be listed as the "Created By" and "Modified By" contact for NZGD records. As a result, any record-related notifications, such as state change alerts or review required messages, will be sent to this address.

   • Organisation Name

   • Description of how you plan to use the NZGD External API

   • Acknowledgement that you have read and accepted the API Use Policy on behalf of your Organisation. (Y/N)

2. Our team will review your details. Please allow up to 2 business days for your request to be reviewed.

3. Once your account is approved, you will receive a link to set up your password, with the subject title: NZGD External API Notification - Account request has been approved.

4. You will be able to access the APIs by signing in with your new credentials!