Documents

Create Document Session for Embedded Sign

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.

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

Request

Base URL
https://api.pandadoc.com
Auth
- API key in header Authorization
- or OAuth 2
  Authorization codehttps://app.pandadoc.com/oauth2/authorize
  Token URLhttps://api.pandadoc.com/oauth2/access_token
TypeScript
https://skmtc.dev/pandadoc/apis/pandadoc-public-api/docs/public/v1/documents/:id/session/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Document ID

Request body

recipientstring required

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

lifetimenumber

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).

Example request

{
  "recipient": "josh@example.com",
  "lifetime": 900
}

Response

idstring

The session ID.

expires_atstring

The date and time when the session will expire.

Example response

{
  "id": "QYCPtavst3DqqBK72ZRtbF",
  "expires_at": "2017-08-29T22:18:44.315Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.