Errors

Our APIs returns standard HTTP response codes to indicate if an API request either succeeded or failed. Below is the specifications you can use to handle the responses from our APIs accordingly.

HTTP Codes

HTTP Status	Title	Description
200	OK	The request was successful
201	Created	The resource was successfully created
400	BadRequest	A failed request validation occurred
401	Unauthorized	Invalid authentication
403	Forbidden	Invalid permission to perform the request
404	NotFound	The resource does not exist
422	Unprocessable	Unable to process the request
500	InternalServerError	An internal Pouch error has occurred

Error Messages

HTTP Status	Code	Message	Details
400	BadRequest	Validation failed for schema (.*)	Contains validation details
401	Unauthorized	API Key is required
401	Unauthorized	API Key is invalid
401	Unauthorized	Signature is required
401	Unauthorized	Signature is invalid
403	Unauthorized	Invalid Access
500	InternalServerError	(.*)

Error Responses

Examples:

// 400 Bad Request
{
  "error": {
    "code": "BadRequest",
    "message": "Validation failed for schema createInvoice",
    "details": [
      "description is a required field"
    ]
  }
}

// 401 Unauthorized
{
  "error": {
    "code": "Unauthorized",
    "message": "Invalid Signature",
    "details": []
  }
}