v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Papersign Documents

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.

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

Path parameters

idstring required

The ID of the Papersign document.

participantKeystring required

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

Response

Successfully generated a signing link for the signer

status'ok'

Example response

{
  "results": {
    "link": {
      "participant_key": "akdj17",
      "participant_name": "Jack Smith",
      "link": "https://sign.paperform.co/sign/5d40fdaf174b4c0007043072/akdj17/view/manual_link?action=5f80fdaf174b4c0007043099&expires=1751760000&signature=8f2c1d"
    }
  }
}