Developer reference
Errors and Rate Limits
Use this guide to implement resilient client behavior for failures, throttling, and audit-safe operations.
Common HTTP Status Codes
| Code | Meaning |
|---|---|
| 400 | Invalid input payload or request format. |
| 401 | Authentication required or missing organization context. |
| 402 | The organization lacks a required product entitlement. |
| 403 | Required scope, permission, or feature access is missing. |
| 404 | Route is disabled, unavailable, or resource not found. |
| 429 | Request exceeded rate limits for this route class. |
| 500 | Unexpected server failure. Check the operation outcome before retrying a mutation. |
Rate Limit Headers
These headers are returned by some routes. Also check the JSON error code and details; do not assume every 429 includes them.
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
- Retry-After (where returned by the endpoint)
Before Retrying
Header availability varies by endpoint. A retry example does not guarantee server-side idempotency. Do not automatically repeat a check-in or decision after an ambiguous failure.
- Read error.code and details before choosing a recovery action.
- For RATE_LIMITED, use the returned retry window where provided, with capped backoff.
- For QUOTA_EXCEEDED, wait for the quota reset or contact SecurePoint; repeated immediate retries will not help.
- For a failed mutation, check whether the visit or decision was recorded before sending it again. Contact support with the request ID if the outcome is unclear.
Retention and Audit Downloads
Treat all exported logs and evidence files as controlled audit records. Keep retention decisions aligned with your compliance policy and verify file integrity checks when evidence is moved between systems.
Operational checklist
- Store exported records in an access-controlled location.
- Track export job ids and request ids in change tickets.
- Document retention windows in your customer runbook.
Need Endpoint-Specific Details?
Continue to API Reference for path-level coverage and request/response examples.
Open API Reference