Journey
If at some point during the OneID® journey any error occurs, the user will be redirected to the redirect_uri provided during authorization with three query parameters error , error_oneid and state .
As the OneID journey follows OIDC, you should handle the errors mentioned in the specification:
error | Description |
|---|---|
invalid_request | The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. |
unauthorized_client | The client is not authorized to request an authorization code using this method. |
access_denied | The resource owner or authorization server denied the request. |
unsupported_response_type | The authorization server does not support obtaining an authorization code using this method. |
invalid_scope | The requested scope is invalid, unknown, or malformed. |
server_error | The authorization server encountered an unexpected condition that prevented it from fulfilling the request. |
temporarily_unavailable | The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server. |
The error_oneid parameter is complimentary to the error and aims to further define the error that has occurred.
error | error_oneid | Description |
|---|---|---|
access_denied | OneID.OIDC.Redirect.UserCancelled | User cancelled the journey. |
access_denied | OneID.OIDC.Redirect.SpamGuardBlocked | The user has been temporarily blocked because too many requests were made. |
access_denied | OneID.OIDC.Redirect.IDScanDocumentNotFound | No documents were uploaded by the user. |
access_denied | OneID.OIDC.Redirect.IDScanFlagged | An issue has been flagged with the document scan process. |
Data Service
Errors that can be returned from our data service APIs are document in the Data Service API ReferenceAPI.