Archive a completed envelope
Files a completed envelope away so it drops out of the default document list. Nothing else changes: the evidence, the retention clock, and the audit trail are untouched, and status stays completed.
The only allowed source state is completed. Anything still in flight answers 409 invalid_state with details.status naming the state it is actually in. Note the inconsistency with void and the inbound actions, which report a semantically similar refusal as 400 invalid_status: archive is one of the endpoints that uses 409 invalid_state, and a caller should branch on both codes.
Archiving an already-archived envelope is a success, because a retry of a filing action is not an error.
No request body. Honors Idempotency-Key.
Request
- Base URL: https://inkseal.net/api/v1
- URL: https://inkseal.net/api/v1/envelopes/{envelopeId}/archive
- Auth: HTTP bearer
Headers
Makes this mutation retry-safe. 1 to 255 printable ASCII characters (0x20 to 0x7e), trimmed before use. The key is scoped to the workspace and the credential that sent it. Reusing it with a different method, path, or payload answers 422 idempotency_key_reuse. A completed attempt replays its stored status and body with an Idempotent-Replay: true response header; 5xx, 429, and non-JSON answers leave the key retryable. A concurrent request holding the 90 second lease answers 409 idempotency_in_progress. Records are retained 24 hours.
Response
The envelope is archived. archivedAt is when it was filed.
Example response
{
"data": {
"id": "Jd3kR8sVqW2nX5cY7bLmP",
"status": "pending",
"archivedAt": "2026-08-25T14:00:00.000Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.