The error envelope
Every error response has the same JSON shape:errorCode: a stable enum value. Branch your code on this, never onmessage. Codes are never repurposed; changed semantics always get a new code.message: human-readable detail, safe to log and to show to operators.correlationId: identifies this request across Passlet’s systems. Include it when you contact support about a failed request.
VALIDATION_ERROR) additionally include fieldErrors pinpointing the offending fields.
Common error codes
Endpoint pages list the specific statuses each operation can return.
Retry guidance
- 4xx (except 429): don’t retry unchanged; fix the request.
- 429 / 5xx: retry with exponential backoff and jitter.
- Batch endpoints report per-item outcomes. A failed item never aborts the whole batch, so check the per-item results rather than the HTTP status alone.