Setting up your API access

What the API channel is, and how to use it

The Application Programming Interface (API) channel creates a real-time, secure, direct link between your business systems and the PPSR. You can conduct most PPSR transactions, including searches, registrations, renewals, amendments and discharges, directly from your organisation's software, rather than using the PPSR website.

The PPSR's API channel allows your software to send transaction data to the register and get an immediate response with details of the registered, amended, renewed or discharged financing statement, search results, or other applicable information. Your software can present the response data to your users in the way you design, and can be stored in your system for future reference.

There are several ‘off-the-shelf’ API products available from third party software providers. Alternatively, if you have the necessary software development and support capability, you can build your own interface to the PPSR. For technical specifications see the PPSR API page.

Reasons for building an API interface

The API channel offers three key advantages:

  1. The system facilitates high-volume processing for users who carry out a large number of transactions
  2. API integration can streamline your business processes. Data can be taken directly from your organisation's system, removing the need to re-enter information and the risk of data entry errors.
  3. PPSR transaction fees are lower via the API channel in comparison to website transactions. See the fee schedule.

Setting up your API access

To set up your API access, you’ll need:

  1. Suitable software to connect to the PPSR's API
  2. A PPSR organisation online services account
  3. A New Zealand bank account as fees for API transactions are deducted monthly, via direct debit
  4. Depending on the type of software you use, you may also need to subscribe to the PPSR's API. To do this you’ll need:
    1. An API subscription that is created with the same RealMe login that you used to register your PPSR online services account. See the subscription instructions for details on how to complete this process, and go to the PPSR API page to subscribe.
    2. A signed API Access Agreement. This is required before a subscription can be approved by us. If you haven’t previously supplied an agreement, it will be requested during the subscription process.

 

Software development process

If you are building or commissioning your own software, your developer can get full technical details from the PPSR API page. A fully functioning sandbox environment with test data is available during development and testing, to assist your technical team.

When you subscribe to the PPSR's API you will create production and sandbox API keys, allowing you to access either environment. Access to the sandbox environment also requires you to register an organisation online services account in the PPSR sandbox WebUI. Full instructions are detailed in the PPSR API documentation.

PPSR functions not supported by API

The PPSR API offers almost all of the functionality available via the PPSR website itself including registration, amendment, renewal, discharge and search services, as well as user provisioning. Some low-volume transaction features are not provided in the API.

These include:

  • subordinations and cancellation of subordinations
  • lodging of change demands by debtors or interested parties
  • acceptance of change demands by secured parties
  • setting up a direct debit.

Additional assistance

For technical assistance with the PPSR's API contact us via our support centre 

 

All help topics

Getting started 9 guides

To register or search on the PPSR, you or your organisation must have an online services account. Find out more about the register, how to log in, set up your account, and create a secured party group.

See all 9 guides for Getting started

Managing your online services account 5 guides

Your PPSR online services account allows you to update and manage your personal and organisation information, including contact and payment details, and passwords.

Searching the PPSR 9 guides

Registering on the PPSR 11 guides

Information for debtors and consumers 4 guides

If you’re buying valuable used goods, or have bought something on hire purchase, leased property, or taken out a loan, you should know how the PPSR works, and how it can help you.

Paying PPSR fees 2 guides

Find out the fees for the online services you use on the PPSR, and your payment options.