Skip to main content
POST
/
signature_request
/
send-from-template
Send Signature Request from Template
curl --request POST \
  --url https://api.luminpdf.com/v1/signature_request/send-from-template \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "template_id": "sign_123",
  "title": "Mutual NDA Agreement",
  "signers": [
    {
      "signer_role": "Tenant",
      "email_address": "[email protected]",
      "name": "Jane Smith",
      "verification": {
        "method": "vc",
        "payload": {
          "doc_type": "driver_license",
          "claims": [
            "given_name",
            "family_name",
            "issuing_country",
            "issuing_authority",
            "document_number"
          ]
        }
      }
    },
    {
      "signer_role": "Customer",
      "email_address": "[email protected]",
      "name": "John Doe"
    }
  ],
  "expires_at": 1927510980694
}
'
{
  "signature_request": {
    "signature_request_id": "<string>",
    "created_at": "<string>"
  }
}
This endpoint requires the following scopes:sign:requests and templates
The verification field on signers requires a Digital Trust license enabled at the Workspace level. If your Workspace is not licensed, the request will return a 403 verification_not_licensed error. Contact your Lumin account manager to enable Digital Trust.

Authorizations

​
X-API-Key
string
header
required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Body

application/json
​
template_id
string
required

ID of the template. ID needs to include the prefix returned by the template list endpoint.

​
title
string
required

The title of the signature request.

Required string length: 1 - 255
​
signers
object[]
required

Signers of the signature request.

​
expires_at
integer<unix-epoch>
required

When the signature request will expire. This is a unix epoch timestamp (miliseconds). Should be later than today.

​
tags
object

Key–value pairs for Merge Tags defined in the Sign template. Keys must match tag names. Values replace the corresponding tags and are rendered as plain text in the sent agreement.

​
fields
object

Key–value pairs for Form Fields defined in the template. Keys must match field names. Values prefill the corresponding fields in the sent agreement.

​
variables
object

Key–value pairs for Variables defined in the AgreementGen template. Keys must match variable names. Values prefill the corresponding variables and are rendered as plain text in the sent agreement.

​
collections
object

Map of collection name → array of record objects used to expand table-scoped row-loop markers in the template.

  • Each key must match a collection name returned by Get Template Details under collections[].name.
  • Each value is an ordered array of flat record objects; each record is a key–value map where keys match the collection's variable names and values are strings.
  • Records are rendered in array order.
  • Maximum 100 items per collection, and up to 50 collections per request.

Applies to AgreementGen templates only. Ignored silently when the resolved template type is not lumin.

​
viewers
object[]

Viewers of the signature request.

​
custom_email
object

Custom email content for the email sent to signers.

Response

Returns the information of the created signature request.

​
signature_request
object
required

Contains information about a signature request.