Products /

SuperGold - High Availability

1.2.2

APIs

    • SuperGold Verification - High Availability
      1.2.2

      The SuperGold Verification API enables you to confirm whether an individual is a current holder of a SuperGold Card based on their Ministry of Social Development client number and date of birth.

      When a client number and date of birth are submitted, the API will return a 'true' or 'false' response.

      This API could be used to enable the granting of SuperGold discounts to SuperGold Card holders as part of an online transaction, or within a point of sale transaction.

      The SuperGold Verification API is a RESTful service that performs a single GET operation and

      REST
      Online

Plans

In order to subscribe, you must sign in or contact us to request access.

locked

SuperGold Plan

2 rate limits *

Select

Production-level rate limiting for External API calls invoked by external parties
  • SuperGold Verification - High Availability 1.2.2
View details
Description

Seamlessly integrate a SuperGold eligibility check into your website or digital application.

Our SuperGold Verification API makes it possible for organisations to offer SuperGold discounts and concessions to SuperGold Card holders by integrating a SuperGold eligibility check into their website or digital application.

The SuperGold Card is a discounts and concessions card for seniors and veterans, in recognition of their contribution to New Zealand society. 

Currently there are over 850,000 eligible SuperGold Card holders. Research indicates the total value of expenditure by seniors (inclusive of GST) is projected to rise from around $20.7 billion per year in 2016 to around $42.4 billion in 2031. This means SuperGold Card holders are a group with significant buying power.

Access requirements

Sandbox - Our Sandbox environment allows you to trial this API using mock data. You will need to contact us in order for you to create an account on our Sandbox Portal. After your account is created, you will need to agree to our Terms of Use to access this API in our Sandbox environment.

Production - When you are ready to request Production access to this API, you will need to contact us in order for you to create an account on our Production Portal. After your account is created, you will need to meet the criteria for Production access to the SuperGold Verification API. For example, organisations consuming this API need to be SuperGold Business Partner and we will need to be satisfied that your proposed use of the API meets MSD's privacy and security requirements.

Access to this API in both the Sandbox and Production environments is subject to MSD approval.

Plans & Support

The SuperGold Verification API plan is available free of charge and is rate limited. See the Plan information below for details for this API. Please contact us if you would like to request a different rate limit.

Support for this API is available Monday to Friday, 9.00am to 5.00pm NZDT/NZST. See the Support section for FAQs and support contact details.

Please note, this API will be subject to scheduled outages from time to time. We expect the API will be available 97% of the time during NZ business hours (Monday to Friday, 9.00am-5.00pm NZDT/NZST) excluding planned outages. A calendar of planned outages will be published in the System Updates section in Support.