Skip to main content

Errors

This page documents the different error types which can be returned by the DVPA-r endpoints.

ErrorResponse​

An ErrorResponse is the JSON object that is returned with a failed request, it is send togheter with a HTTP 400 Bad Request statuscode and contains at least the following fields:

  • type (string)
    A type string that identifies this error
  • title (string)
    A short, human-readable summary of the problem type.
  • status (number)
    The HTTP status code generated by the origin server for this occurrence of the problem. This will always be 400
  • detail (string)
    A human-readable explanation specific to this occurrence of the problem.

Depending on the error it tries to convey the ErrorResponse can contain more fields. Which fields those are can be found in the documentation of the corresponding error type on this page.

Errors types​

Multiple matches​

type: multiple-matches

This error is returned by an HTTP POST request to the /dvpa-r/v1/authorizations endpoint when the query parameters do not evaluate to a single authorization but to multiple authorizations. A client can search for a specific authroization by making an HTTP GET request to the /dvpa-r/v1/authorizations endpoint. This call will return a list of matching authorizations from which the desired authorization can be chosen by settings the authorizationId query parameter on the HTTP POST request to the /dvpa-r/v1/authoriztions endpoint.

See the walkthrough for more information about refining your query.

Invalid arguments​

type: invalid-arguments

This error can be returned by multiple endpoints if there are missing or invalid parameters send to the server. The details field will contain a human readable representation of what parameters are problematic.

Multiple matches​

type: invalid-auth-code

This error is returned by an HTTP POST request to the /dvpa-r/v1/authorization-codes endpoint when authorization code is invalid or if it does not belong to the provided BSN.