Get Signing Link

POST/openapi/v1/envelopes/signing-view

Generate one-time signing links for the envelope's signers.

Links are valid for 30 minutes by default; expired links require re-calling this endpoint
Multiple calls for the same signer will invalidate previous links; do not cache links
Carbon-copy recipients are not returned (they do not have signing links)

Filter Rules

When both RecipientId and RecipientEmail are provided, RecipientId takes precedence and RecipientEmail is ignored.
When only one is provided, filter by that field and return a single signer's link.
When neither is provided, return links for all signers of the envelope.

Request Parameters

Header Parameters

AuthorizationRequiredstring

Bearer <access_token>

X-Operator-User-IdOptionalstring

Operator user ID (optional; defaults to the system user ID if not provided)

Request Body

application/json

EnvelopeIdRequiredstring

Envelope ID (required)

RecipientIdOptionalstring

Signer ID (optional, used to filter a single signer)

RecipientEmailOptionalstring(email)

Signer email (optional, used to filter a single signer). When both RecipientId and RecipientEmail are provided, RecipientId takes precedence and Email is ignored.

Request Example

{
  "EnvelopeId": "SGEV1234567890",
  "RecipientId": "r1"
}

Response Parameters

Response.Data

EnvelopeIdOptionalstring

Envelope ID

EnvelopeStatusOptionalstring

Envelope current status. draft; sent; completed; voided; declined.

draftsentcompletedvoideddeclined

SignerInfosOptionalarray<object>

Signer signing-link list

⌃Sub-properties

RecipientIdOptionalstring

System-assigned recipient ID

NameOptionalstring

Name (required)

EmailOptionalstring

Email (masked, e.g. z***@example.com)

SigningOrderOptionalinteger

Signing order (0 when SigningOrderType=parallel)

SigningUrlOptionalstring

Signing link

ExpiresAtOptionalstring(date-time)

Link expiration time, RFC3339 format, e.g. 2024-01-15T11:00:00Z

Response Example

{
  "Response": {
    "RequestId": "req-abc123",
    "Error": null,
    "Data": {
      "EnvelopeId": "SGEV1234567890",
      "EnvelopeStatus": "sent",
      "SignerInfos": [
        {
          "RecipientId": "r1",
          "Name": "Alice",
          "Email": "a***@example.com",
          "SigningOrder": 1,
          "SigningUrl": "https://sign.example.com/signing/eyJhbGciOi...",
          "ExpiresAt": "2024-01-15T11:00:00Z"
        }
      ]
    }
  }
}

Error Codes

Error Code	Description
`INVALID_REQUEST`	Invalid parameters (e.g. EnvelopeId is empty)
`NOT_FOUND`	Envelope does not exist
`RECIPIENT.NOT_RECIPIENT`	The specified RecipientId / Email is not a signer of this envelope
`ENVELOPE.INVALID_STATUS`	Envelope status does not allow signing (completed, voided, draft, etc.)
`SIGNING.RECIPIENT_ALREADY_SIGNED`	The signer has already signed
`SIGNING.RECIPIENT_DECLINED`	The signer has declined
`INTERNAL_ERROR`	Internal service error

Get Envelope Detail Void Envelope