Embed

Create an embed session

Mints a scoped, short-lived signing URL for a specific document recipient. Pass the returned url to an <iframe src={url}> or to the @signvoy/react <SignvoyEmbed url={url} /> component. The document must be in sent state and the recipient must be pending.

post/v1/embed/session

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/embed/session
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer

Request body

documentIdstring uuid required

UUID of the document whose signing session to embed

documentRecipientIdstring uuid required

UUID of the specific recipient whose signing view to embed

expiresInSecondsinteger

How long (seconds) the returned signing URL should remain valid. Defaults to 1 hour. Maximum is 24 hours.

Response

Embed session created — includes the signing URL

urlstring uri required

Scoped signing URL for the specified recipient. Embed this in an <iframe> or pass it to the @signvoy/react <SignvoyEmbed /> component. The URL is single-use and expires after the requested window.

expiresAtstring date-time required

ISO 8601 timestamp when this session URL expires

documentIdstring uuid required

Document ID this session belongs to

documentRecipientIdstring uuid required

Recipient ID this session was issued for

Example response

{
  "url": "https://signvoy.com/sign/abc123?embed=1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.