/papersign/documents/{id}/participants/{participantKey}/link

post

https://api.paperform.co/v1/papersign/documents/{id}/participants/{participantKey}/link

This endpoint generates a signing link for a signer, which you can share with them directly instead of having Paperform email them a notification.

The link is returned only in this response and cannot be retrieved again, so store it when you receive it. Generating a link invalidates any link previously generated for the same signer — only the most recently generated link will work. The link is valid for one week.

The document must have been sent (be in progress) and the signer must be pending a signature.
Please note that this feature is exclusively available as part of the Papersign API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the Papersign document.

participantKey

string

required

The key of the signer (participant) on the document.

Body Params

Both fields are optional. When set, the signer briefly sees a notice naming the destination, then is redirected. Only completion and an explicit decline redirect; an expired or superseded link, a cancelled document, or a nomination never does.

redirect_url

uri

length ≤ 2048

Optional absolute https URL to send the signer to after they complete signing through this link.

decline_redirect_url

uri

length ≤ 2048

Optional absolute https URL to send the signer to if they decline to sign through this link.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully generated a signing link for the signer

400Invalid Request

401Unauthorized

403Not Permitted

404Not Found

422Validation Error

429Too Many Requests

5XXUnexpected Error