There are 2 ways to connect to the application programming interface (API):
- connect your own systems directly (self-implementing)
- connect through a third-party software operator.
You can choose the way you want to connect when you register.
Self-implementing
You can connect your organisation’s systems directly to the API.
This option is suitable if you have the technical capability to:
- authenticate with the API
- call our endpoints
- process API responses
- manage errors.
You can find technical information about connecting to the API in our:
Connecting through a third-party software operator
A third-party software operator can connect to the API and submit information on your behalf.
You must still use the API registration form on our website to:
- register to use the API
- nominate the software operator that will act for your organisation. The software operator does not need to register separately.
If the software operator is already connected
If the software operator you nominate already uses the API for another provider, they can start acting on your behalf without any extra setup once your registration is complete.
If the software operator isn’t connected
If the software operator hasn’t used the API before, we’ll start the process to set them up to use it when you nominate them.