Skip to main content

​
Errors

The Developer API returns consistent response envelopes for both success and failure cases.

​
Error shape

{
  "status": false,
  "message": "Human-readable explanation",
  "data": null
}

​
Common categories

  • Authentication errors (invalid or missing X-API-Key)
  • Authorization/scope errors (key lacks required scope)
  • Validation errors (request payload does not match expected schema)
  • Rate-limit errors (per-minute or per-hour limit exceeded)
  • Resource errors (record not found)
When handling failures, log the full request id and endpoint path to speed up troubleshooting.