Base URL
/v1/.
Authentication
All API endpoints (exceptPOST /oauth/token) require a bearer token:
Request format
- All
POSTandPATCHrequest bodies areapplication/json - All responses are
application/json(exceptGET /v1/envelopes/{id}/documentwhich returns the PDF binary)
Idempotency
POST requests accept an Idempotency-Key header. Replaying the same request within 24 hours
returns the original response without creating a duplicate.
Rate limiting
Every response includes rate limit headers:| Header | Description |
|---|---|
X-RateLimit-Limit | Requests allowed per window |
X-RateLimit-Remaining | Requests remaining in current window |
X-RateLimit-Reset | Unix timestamp when the window resets |
429 Too Many Requests.
Error format
All errors follow this shape:| Status | Meaning |
|---|---|
400 | Validation error — check errors |
401 | Missing or expired token |
403 | Token valid but unauthorized for this resource |
404 | Resource not found |
409 | Conflict (e.g. envelope already sent) |
422 | Business rule violation (e.g. voiding a completed envelope) |
429 | Rate limited |
500 | Internal server error — contact support |