How to gain access to our APIs and digital services

To gain access to our APIs and digital services, we require you to provide information about your identity, purpose for accessing the data and how you intend to use it.  This helps us comply with legal obligations, meet health consumer expectations and maintain the security and integrity of the information leading to improved outcomes for New Zealand health consumers.  

Outlined below are the steps you must take in order to gain production access to our APIs or digital services.

  1. Step 1: Register your organisation

    The designated business representative from your organisation must register the organisation on the developer portal and manage additional user accounts.  They will have the 'delegate authority' profile for the organisation.  This representative serves as the primary point of contact for any developers wanting to gain access to our Developer Portal and associate with their organisation and for us to establish and maintain a lasting relationship. 

    During this registration process, they can nominate other delegated authorities and/or developers to be associated with their organisation.  Once the information provided has been validated and approved by Health New Zealand, invites to our Developer Portal will be sent to all people nominated in the form.

    Register now

  2. Step 2: Login to the Developer Portal

    Once you receive the invitation to register as a user to our Developer Portal, you will need to create a My Health Account Workforce that you will use to log into the portal.  When creating the account, you will need to provide information from an official document (such as a driver's licence or passport) to help confirm your identity.  More information about My Health Account Workforce can be found here.

    Please note - the email address you register to Developer Portal with must be the same email address you register with My Health Account Workforce. 

    To streamline the process, you can register for a My Health Account Workforce account prior to receiving an invitation email to the Developer Portal.

If you have already created a login to My Health Account Workforce and would like to log in to the developer portal, click the button below.

  1. Step 3: Request access to test APIs

    Once you have registered for developer portal, you will be able to request access to our APIs and digital services. To gain test access to APIs that you're interested in, you will need to fill in our form and provide some information about your application and use case. 

    When your test API request is approved, we will provide you with credentials to the test API so you can build and test your integration with our test environment.

  2. Step 4: Request access to production

    When your development is underway, you can begin the process to onboard to the production API and data. This is a comprehensive process to provide assurance that your software complies with various security privacy, clinical safety and identity laws and regulations. 

    It can take some time, so we recommend you plan ahead. 

    You can find out more about the compliance requirements by checking the risk scores of the API and the controls that must be in place based on our risk framework.