POST /public/v1/documents/{id}/session

Creates a document session for a recipient to view and sign a document.

📘 How to create an Embedded Sign session For more information on how to create an Embedded Sign session, see the Embedded Signing documentation.

Servers

Path parameters

Name Type Required Description
id String Yes

Document ID

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
recipient String Yes

Email address of the person who will receive access to the document.

lifetime Number No

The duration in seconds for which the document link will remain valid. The link will expire and become inaccessible after this time period. For security, we recommend setting the lifetime to less than one year (e.g., "lifetime": 31535999). If not specified, the default value is 1 hour (3600 seconds).

Default value: 3600

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.