Error reference

Every error response 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.

REST API (/v1)

Slug	Status	Summary
`auth-level-unavailable`	422	A recipient asked for the account or passkey level; only link and otp exist today.
`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, or the workspace cannot hold API keys.
`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.
`engine-error`	500	Something failed inside SignEnvoy that was not your request's fault.
`envelope-allowance-exhausted`	402	The workspace sent every signature request its plan allows this month.
`folder-invalid`	422	A folder operation or a document'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 document is not in a state that allows this action.
`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.
`plan-no-api`	403	This workspace's plan has no API entitlement.
`rate-limited`	429	Too many requests in a short window.
`request-invalid`	422	The JSON or query parameters did not match the schema.
`tenant-canceled`	403	The workspace's subscription has ended.
`tenant-suspended`	403	Writes are refused while the subscription is suspended.
`token-invalid`	404	The signing link is unknown, superseded, or no longer usable.
`unauthenticated`	401	The request carried no usable API key.
`upload-expired`	410	The draft waited too long for its PDF.
`upload-finalized`	409	The upload step was repeated after the draft was finalized.
`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.
`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.
`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.3.0-m4. Scheme: {DOCS_BASE_URL}/errors/{slug}.