...
The API is typically invoked before and after the User has authenticated at the LFI and authorised the consent. The sequence diagram below provides an excerpt of the API Hub Sequence Diagrams that describe the end-to-end flow, focusing on the Heimdall API.
3. Success Response
When validation of the redirection is successful the properties of Pushed Authorization Request and the TPP who sent the Pushed Authorization Request are available in the response. The values returned in the success response, indicated by the a 200 HTTP status code, include the login_hint parameter, which allows the Emirates ID or Trade License Number to be sent as a JWE.
Please refer to the OpenAPI description for further details.
4. Error Handling
The error scenarios described above are summarised in the table below.
...
The following sections expand on each error type.
...
4.1 Client Validation Error
Client Validation Errors are returned by Heimdall when the Client belonging to a given TPP cannot be successfully validated.
...
Description | Error Code ( | Error Description ( | |
|---|---|---|---|
| 1 | The |
| The |
| 2 | The Client or TPP who owns the Client is no longer in a valid state in the Trust Framework, and therefore cannot be successfully validated. |
| The status of the Client is no longer valid. The Authorization Request can no longer be completed. |
| 3 | An internal error has stopped validation of the Client. The validation of the Client cannot therefore be completed authoritatively. |
| The Client cannot be validated due to an internal error. |
4.2 Authorization Request Error
Authorization Request Errors are returned by Heimdall when the Authorization Request is invalid or cannot be processed.
...
Description | Error Code ( | Error Description ( | |
|---|---|---|---|
| 1 | The Authorization Request has expired as the number of seconds since the |
| The Authorization Request has expired. |
| 2 | An internal error has stopped validation of the Authorization Request. The validation of the Authorization Request cannot therefore completed. |
| Error description will be dependent on the error condition experience at Heimdall. |
...
4.3 User Validation Error
User Validation Errors are returned by Heimdall when the LFI signals that User authentication and authorisation of consent has failed.
...