General Error Handling

The consent process can be interrupted at different points during the process. In all cases where no direct communication between your application and Caruso is established, an error code, as well as a short description, is returned in the redirectUrl. It means for all steps, except the activation API call (Step 5) the redirect of the end user is used to provide information about the occurred error.

Here are some example error scenarios:

  • The end user terminates the provisioning process at one point by rejecting consent either to Caruso or to the vehicle manufacturer.
  • The communication is lost between the systems (vehicle manufacturer to Caruso, Caruso to Consumer)
  • The user rejects consent at the Caruso Consent Portal or at the vehicle manufacturers’ authorization server.
  • The user gives consent for a VIN that is not matching the requested VIN.

Caruso will send the errors via the redirectUrl.

Error Notification

redirectUrl?error=<error_code>&error_description=<error_description>&consent_id=<consentId>

As soon as the user gives consent in the Caruso Consent Portal, there will always be a consent id sent in all error and success cases. If the user does not give consent to Caruso, there won’t be any data stored by the Caruso Consent Portal and therefore no consent Id exists. As a result, this attribute is optional and not always included in the response. The following table describes the most common error scenarios, but other errors may also occur.

Error Code Description
scope_mismatch Provided scope does not match the requested scope. If the user does not give consent for all required data items to the vehicle manufacturer, the process will fail with this error code.
rejected In case the user rejects giving consent to Caruso to proceed with the consent provisioning process this error code will be returned.
invalid_request This error might happen in e.g. in case the VIN the user has given consent for in the vehicle manufacturers’ authorisation server does not match the VIN given to Caruso.
conflict This error is returned if the consent process is in a wrong state because of an error during the consent provisioning process.
connection_error The connection to the vehicle manufacturers’ authorization server failed.
communication_timeout The connection to the vehicle manufacturers’ authorization timed out.

In any error cases, you just need to re-initiate the process.