CLI and errors

Error reference

Every error the API returns is an RFC 9457 problem document. Its type is /problems/<slug> and its docs_url points at one of the pages below. The set is stable: slugs are added, never renamed or removed. A request our network edge refuses before it reaches the API, such as a path with an encoded NUL (%00), gets a plain 400 with an HTML body, so check Content-Type before parsing.

REST API (/v1)

Slug	Status	Summary
`bulk-not-ready`	409	Dispatch needs a ready batch; cancel needs a ready or dispatching one.
`bulk-rows-invalid`	422	One or more rows in a bulk send failed validation, so nothing was sent.
`bulk-too-many-rows`	422	A bulk send takes at most 5,000 rows.
`conflict`	409	Another change landed first.
`device-access-denied`	403	The sign-in was denied in the dashboard.
`device-authorization-pending`	400	The device-flow sign-in has not been approved yet; keep polling.
`device-code-expired`	400	The device code is unknown, past its expiry, or was already claimed.
`device-slow-down`	400	The device-flow poll came sooner than the returned interval.
`embed-origins-missing`	409	A framed embed session was requested, but the workspace lists no origins that may frame the signing page, so no page of yours could show it.
`engine-error`	500	Something failed inside SignEnvoy that was not your request's fault.
`folder-invalid`	422	A folder operation or an envelope's folder assignment was not valid for this workspace.
`http-error`	any	A generic HTTP failure that is not one of the specific problem types.
`idempotency-in-flight`	409	The first request under this key has not finished.
`idempotency-key-reused`	422	The same key arrived with a different method, path, or body.
`invalid-state`	409	The envelope is not in a state that allows this action.
`live-mode-unavailable`	402	This workspace is in the sandbox, where test keys work in full and live keys do not.
`new-workspace-send-limit`	429	For its first 7 days of live sending, a workspace can send a limited number of documents a day. This one has sent today's.
`not-found`	404	The resource does not exist, or it belongs to another workspace.
`not-your-turn`	409	Sequential signing has not reached this recipient.
`pdf-too-large`	422	The uploaded file is larger than the limit.
`polling-too-fast`	429	One API key read one document more often than it changes.
`rate-limited`	429	Too many requests in a short window.
`request-invalid`	422	The JSON or query parameters did not match the schema.
`subscription-ending-limit`	402	A workspace that has cancelled can keep sending until its minimum is used up. This one has used it.
`tenant-canceled`	403	The workspace was deleted by its owner.
`tenant-suspended`	403	Writes are refused while the workspace is suspended, for billing or for review.
`token-invalid`	404	The signing link is unknown, superseded, or no longer usable.
`unauthenticated`	401	The request carried no usable API key.
`validation-failed`	422	The input describes something the engine cannot accept.

Signing page

Slug	Status	Summary
`auth-required`	409	The recipient has to enter a one-time code before the document opens.
`consent-required`	409	The recipient tried to act before accepting electronic signing.
`copy-not-ready`	409	A cc recipient's link was opened before the document was complete.
`embed-session-expired`	410	The single-use embed URL was opened a second time, after its ten minutes, or for a document that has moved on.
`envelope-declined`	410	A recipient declined, which closed the signature request.
`envelope-expired`	410	The signing window for the whole document has passed.
`envelope-gone`	410	The document reached a state in which this link cannot be used.
`envelope-voided`	410	The sender voided the signature request.
`fields-incomplete`	422	Completion was attempted with required fields still empty.
`not-found`	404	The resource does not exist, or it belongs to another workspace.
`not-ready`	404	The sealed PDF is still being produced.
`not-your-turn`	409	Sequential signing has not reached this recipient.
`otp-attempts-exhausted`	403	Five wrong codes were entered, so this signing link has stopped working.
`otp-expired`	410	The one-time code is older than 10 minutes, or none was issued for this link.
`otp-invalid`	422	The one-time code entered does not match the one that was emailed.
`otp-undeliverable`	409	The recipient's address no longer receives our email, so no one-time code was sent.
`rate-limited`	429	Too many requests in a short window.
`token-expired`	410	The link is past its validity period.
`token-invalid`	404	The signing link is unknown, superseded, or no longer usable.
`validation-failed`	422	The input describes something the engine cannot accept.

API version 1.7.0-m9. Scheme: {DOCS_BASE_URL}/errors/{slug}.