The Doctavian API uses standard HTTP status codes for all responses. Error responses include a body with additional detail about what went wrong and which part of the request caused the failure.
| Code | Name | When it occurs |
|---|---|---|
200 | OK | The request succeeded and the response body contains the result |
201 | Created | The resource was successfully created |
202 | Accepted | The async request was accepted and is being processed |
204 | No Content | The request succeeded with no response body |
400 | Bad Request | The request was malformed, missing required fields, or contained invalid values |
401 | Unauthorized | Authentication failed — see specific error codes below |
404 | Not Found | The requested resource does not exist or was not found |
500 | Internal Server Error | An unexpected server-side error occurred — contact support if it persists |
Authentication errors return 401 Unauthorized with a specific error code in the response body that identifies which header is at fault.
| Error Code | Header | Cause |
|---|---|---|
ApiKeyInvalid | x-api-key | The key is missing, invalid, or does not match the API area being called |
X_CLIENT_AUTH_ERROR | x-client-authorization | The token is malformed, or the header is missing on an async operation |
The most common
401isApiKeyInvalidcaused by using the invalid key for the calling environemnt and version.
A 400 response indicates the request body was invalid. The response body includes details about which field or condition caused the failure. Common causes:
documents, recipients, fields, or envelope on envelope create)type value on a signature fieldA 404 response indicates the resource does not exist. Common causes:
| Context | Cause |
|---|---|
| Envelope operations | No envelope found with the provided ID |
| Document operations | No document found with the provided ID in storage or in the envelope |
| Signature operations | No signature field found with the provided ID |
| Template operations | No template found with the provided ID |
| Attachment operations | No attachments found in the envelope with the provided ID |
| Audit trail | No audit trail found for the envelope with the provided ID |
A 500 response indicates an unexpected error on Doctavian's side. This typically occurs when:
If a 500 error persists across retries, contact support via the Support Portal with the request details and timestamp.