Integration Overview
OpenID Connect
We use industry standard OpenID Connect (OIDC) protocol to securely transfer user attributes to our customers.
Learn more about OIDC.
Environments
OneID has two available environments for you to use, sandbox and production. Sandbox is using a mock bank as an identity provider returning a set of test data. Once you have been granted access to the production environment you will be able to connect to real banks.
The base URLs for our environments are:
Production: https://controller.myoneid.co.uk
Sandbox : https://controller.sandbox.myoneid.co.uk
Prerequisites
- Find the product that you want to use.
- Register to the OneID® Console to access to our sandbox environment.
- Once your account has been enabled you will be provided with a client id and client secret.
Return Page
OneID® supports the OpenID Connect (OIDC) Authorization Code Flow. In this flow, after authorization the user will be redirected to a predefined URL along with a code parameter that can be used to retrieve an access token.
Learn more about OIDC.
Retrieve User Data
Once you have exchanged the authorization code for an access token, you can call our APIs to retrieve the verified user data you require.
Handling Errors
As per the OIDC specification, errors are returned using the error and error_description URL parameters. In addition to these, we also return a oneid_error parameter which adds additional context.
For example, in the event that the user cancels the journey before proceeding to their bank, One ID will return the error: OneID.OIDC.Redirect.UserCancelled.
If there is no additional context to add, the oneid_error will contain the OIDC error code prefixed with OneID.OIDC.Redirect.
UX Guide
We prepare a UX guide to help you optimise your OneID service based on your use-case. You will find it under our Products Section: