Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Status codes

Here is a list of the different categories of status codes returned by the Protocol API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error — this means you most likely made a mistake.
Name
5xx
Type
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Wallet App API will return an error response with a message and a list of errors. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the Wallet App API — use these to understand what you have done wrong.

Name
error
Type
appears when 500
Description
This means an error occured on the server side. This is very unlikely.
Name
errors
Type
appears when 400
Description
This means that you made an error.

Error response

{
  "message": "The selected identifier is invalid.",
  "errors": {
      "identifier": [
          "The selected identifier is invalid."
      ]
  }
}