How To

Registering an App on our Sandbox

Registering An App Through The Developer Portal

1 Prepare Your Registration Payload

Your registration payload should be provided in JWT format, signed using your OBIE provided Signing Key, with the PS256 algorithm.

The registration payload should contain the claims detailed in the OBIE DCR Specification, including your Signed Software Assertion (SSA). The SSA has a limited lifetime, please ensure you have obtained a fresh SSA for your registration.

For more information on creating your Registration Payload, please see our 'Registration Payload' guide.

2 Fill Out the ‘Register New App’ Form

Ensure you are logged in to the Developer Portal and open your dashboard using the 'My Dashboard' button. Expand the Open Banking Apps drop-down displayed in the dashboard and click the ‘Register New App’ button to open the form.

Select ‘Choose file’ to upload your Transport Certificate supplied by the OBIE, in a PEM file format. This should be the public certificate that is assosociated with your App for Transport (TLS) use.

In ‘Registration request’ section, enter the Signed Payload in JWT format that we crerated in the previous step.

3 Submit Your Registration

Submit your registration using the 'Register App' button.

If your request was successful you will see a confirmation message. You should now be able to see your new App in the Open Banking Apps section of your Dashboard.

If there was a problem with your Registration request, you will see an error message. Please validate your registration payload and re-try, using the troubleshooting information provided below. If you continue to have issues, you can contact us through the 'Contact Us' page, and one of our engineers will help troubleshoot you issue.

Troubleshooting Registration Issues

If you encounter an issue when attempting to register and application through our Developer Portal. In the event an error occurs you should receive an Error Message containing a description of the Error and an associate HTTP Error code.

If you encounter an 'Internal Sever Error', usually accompanied by a 500 (5xx) HTTP code, this may indicate an issue outside of your registration request. Please contact our support through the 'Contact Us' page.

400 Errors, any 4xx code, should be accompanied by an error message that may help highlight any issues in the registration payload. Please refer to the "Registration Payload" how to guide and validate the claims provided in the payload are correct and appropriate for the App you are trying to register.

Additionally, please validate the payload has been signed using the correct private key that is verifiable by our systems, as described in the "Registration Payload" how to.