Developers
Errors and codes
Every failure is a JSON body with a sentence you can show and, where it helps, a code you can branch on.
json
{ "success": false, "error": "issueDate: Required", "code": "PAYLOAD_VALIDATION_FAILED", "version": "v1" }| HTTP | Code | Meaning |
|---|---|---|
| 401 | No key, or a key that is not valid. Every invalid key gets the same answer | |
| 403 | scope_required | Your key does not hold the scope; requiredScope says which |
| 403 | not_available_to_keys | A signed-in person can do this; a key cannot |
| 403 | ORGANISATION_SUSPENDED | The organisation is suspended |
| 402 | PAYMENT_REQUIRED | The wallet cannot cover the next page |
| 402 | PLAN_LIMIT_REACHED | The plan's pages are used and it has no overage |
| 404 | TEMPLATE_NOT_FOUND | No such template, or no such version |
| 409 | TEMPLATE_NOT_ACTIVE | The template is archived or has no active version |
| 422 | PAYLOAD_VALIDATION_FAILED | The data does not match the template's schema; the message names the field |
| 429 | Too many requests: 600 a minute per key |
Render failures
A document that was accepted but could not be rendered comes back with status failed and one of these on errorCode: TEMPLATE_VERSION_MISSING, TEMPLATE_COMPILE_FAILED, RENDER_TIMEOUT, ENGINE_CRASHED, STORAGE_FAILED, EMPTY_OUTPUT. The message says what the engine complained about. Failed documents are not charged.