Comment on page
Errors
We use a common JSON error format across all our service endpoints.
Property | Type | Description |
---|---|---|
code | A code to describe the error. | |
description | String | Technical description of the error (not intended for end-user display). |
message | String or null | For relevant errors, an optional message from the institution website or API that can be presented to an end-user. These messages usually bring details or instructions that complement the error code, but they are not translated. |
request_id | Integer or null | Unique ID of the request (which could be used for audit). |
Code | Description |
---|---|
connectionLocked | For all services in relation with a sub-connection resource, this error indicates that the connection is in a readonly state. |
missingParameter | A required parameter was omitted in the request. |
invalidValue | The request is invalid, because of an unacceptable parameter or body property. Details are provided in the description. |
methodNotAllowed | An API endpoint was called with an unsupported HTTP method. |
bug
Other codes | An internal error occurred. |
Additional codes may be used or added in the future. When implementing error handling, always fallback to a generic case for unknown codes.
Last modified 6mo ago