Request Client Credentials

How to get your Client ID and Client Secret

The Client ID and Client Secret are unique for each API environment (sandbox and production). In production you need unique credentials for each registered application. The credentials are required to authenticate your application each time it uses a Chorus API.

You can access your Sandbox credentials after you successfully apply for access and you do not need to register your application at this point.

You can access your Production credentials after you successfully apply to register your application, nominated two application owners, and provided other required information.

Apply for access to the API Sandbox

In the Sandbox developer portal for the API you want to use click on at the top of your screen.

  • Select New application or select the application from the drop down list.

  • Read and accept Terms and Conditions before submitting the form.

  • Click

If you cannot see a Sandbox environment in Anypoint, go to the Support page on the API Developer website and submit a request. We'll get back to you with further instructions.

Get your Client ID and Client Secret

You can get your credentials from whichever portal environment you are accessing (sandbox or production)

  • Go to Developer Portal >My Applications in Anypoint to view your client credentials.

Apply for access to Production

  • You must register your application with each Chorus API that the application uses

  • In the Production developer portal for the API click on . Do this for each API your application uses.

  • You must read and accept Terms and Conditions before submitting the form.

  • We'll send you an email with a Production Checklist that you complete and return to the team.

  • You will be advised by email as soon as you have access.

 

When you register your application for the Line Test API, the responses we provide will be assigned to the organisation name specifically registered. If you own broadband lines that were previously owned under different organisation names, you will need to complete an application for each of those old organisational names to ensure you retrieve the correct data on those lines. We are aware of this limitation and are working to resolve it over coming months for you. Thank you for your patience.

Client Secret Reset

If your Client Secret is lost, forgotten or has been compromised…

Then

after you have registered the application and you are not the application owner

contact your application owners to reset this for you.

after you have registered your application and you are an application owner (each application must have at least two)

go to Anypoint > My applications and reset it.

before you have registered your application

contact Support.