Errors

Overview

The portierX API returns machine readable error codes to quickly identify the type of error as well as link to the docs and a req_id. Please always include the req_id in your error report.

{
  "msg": "We were unable to authorize your request. Either your key was missing, malformed or does not have the required permissions.",
  "error": {
    "code": "UNAUTHORIZED",
    "docs": "https://portierx.com/docs/errors/UNAUTHORIZED",
    "req_id": "req_1234567890"
  }
}

If you can't debug something on your own or think there is a bug, please get in touch with us on Support and provide the full error response.