This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Create envelope access link

POST

https://api.signater.com/v1/ecm/envelopes/{envelopeId}/access-links

Last modified:2026-10-26 02:41:45

Creates a link that opens a completed envelope online (documents, signers and certificate) for anyone holding it, even after the access policy has closed the envelope to the link printed on the document. Several links can live at once; each has its own validity (one of the validityDays of the list endpoint), an optional label and an optional password. The URL with its secret is returned only in this response. The envelope must be final (signed, rejected, cancelled or expired) and the account needs a paid plan.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Example

{
    "name": "External audit",
    "validityDays": 7,
    "password": "correct horse battery staple"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/ecm/envelopes//access-links' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "External audit",
    "validityDays": 7,
    "password": "correct horse battery staple"
}'

Responses

🟢201Created

application/json

Access link created successfully

Bodyapplication/json

Example

{
    "id": "33d450e5-af30-4ec9-a483-7eb080eab3ce",
    "url": "https://app.signater.com/view/8f0b5bb2-41f4-4f63-9a3e-2d0f1c4e7a10#access=qJ3m9Zt0Xy2vK4Lw8Rb1Nc5Pd7Fh6Gs",
    "hasPassword": true,
    "expiresAtUtc": "2026-11-02T02:41:41.871497Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠402

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-10-26 02:41:45

Get envelope blockchain anchors

List envelope access links