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",
"tags": {
"ClientName": "ACME Corp",
"EffectiveDate": "2026-01-01",
"ContractValue": "$50,000"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": true,
"ContractDuration": 12
},
"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"
}
],
"viewers": [
{
"email_address": "[email protected]",
"name": "Legal Team"
}
],
"expires_at": 1927510980694,
"custom_email": {
"sender_email": "[email protected]",
"subject_name": "Mutual NDA Agreement from ACME Corp",
"title": "Mutual NDA Agreement from ACME Corp"
}
}
'import requests
url = "https://api.luminpdf.com/v1/signature_request/send-from-template"
payload = {
"template_id": "sign_123",
"title": "Mutual NDA Agreement",
"tags": {
"ClientName": "ACME Corp",
"EffectiveDate": "2026-01-01",
"ContractValue": "$50,000"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": True,
"ContractDuration": 12
},
"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"
}
],
"viewers": [
{
"email_address": "[email protected]",
"name": "Legal Team"
}
],
"expires_at": 1927510980694,
"custom_email": {
"sender_email": "[email protected]",
"subject_name": "Mutual NDA Agreement from ACME Corp",
"title": "Mutual NDA Agreement from ACME Corp"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template_id: 'sign_123',
title: 'Mutual NDA Agreement',
tags: {ClientName: 'ACME Corp', EffectiveDate: '2026-01-01', ContractValue: '$50,000'},
fields: {CustomerName: 'John Doe', AgreeToTerms: true, ContractDuration: 12},
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'
}
],
viewers: [{email_address: '[email protected]', name: 'Legal Team'}],
expires_at: 1927510980694,
custom_email: {
sender_email: '[email protected]',
subject_name: 'Mutual NDA Agreement from ACME Corp',
title: 'Mutual NDA Agreement from ACME Corp'
}
})
};
fetch('https://api.luminpdf.com/v1/signature_request/send-from-template', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.luminpdf.com/v1/signature_request/send-from-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template_id' => 'sign_123',
'title' => 'Mutual NDA Agreement',
'tags' => [
'ClientName' => 'ACME Corp',
'EffectiveDate' => '2026-01-01',
'ContractValue' => '$50,000'
],
'fields' => [
'CustomerName' => 'John Doe',
'AgreeToTerms' => true,
'ContractDuration' => 12
],
'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'
]
],
'viewers' => [
[
'email_address' => '[email protected]',
'name' => 'Legal Team'
]
],
'expires_at' => 1927510980694,
'custom_email' => [
'sender_email' => '[email protected]',
'subject_name' => 'Mutual NDA Agreement from ACME Corp',
'title' => 'Mutual NDA Agreement from ACME Corp'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.luminpdf.com/v1/signature_request/send-from-template"
payload := strings.NewReader("{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/signature_request/send-from-template")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.luminpdf.com/v1/signature_request/send-from-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}"
response = http.request(request)
puts response.read_body{
"signature_request": {
"signature_request_id": "<string>",
"created_at": "<string>"
}
}{
"error_code": "<string>",
"error_message": "<string>"
}Signature requests
Send Signature Request from Template
Creates and sends a new signature request from a template with the submitted template data.
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",
"tags": {
"ClientName": "ACME Corp",
"EffectiveDate": "2026-01-01",
"ContractValue": "$50,000"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": true,
"ContractDuration": 12
},
"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"
}
],
"viewers": [
{
"email_address": "[email protected]",
"name": "Legal Team"
}
],
"expires_at": 1927510980694,
"custom_email": {
"sender_email": "[email protected]",
"subject_name": "Mutual NDA Agreement from ACME Corp",
"title": "Mutual NDA Agreement from ACME Corp"
}
}
'import requests
url = "https://api.luminpdf.com/v1/signature_request/send-from-template"
payload = {
"template_id": "sign_123",
"title": "Mutual NDA Agreement",
"tags": {
"ClientName": "ACME Corp",
"EffectiveDate": "2026-01-01",
"ContractValue": "$50,000"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": True,
"ContractDuration": 12
},
"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"
}
],
"viewers": [
{
"email_address": "[email protected]",
"name": "Legal Team"
}
],
"expires_at": 1927510980694,
"custom_email": {
"sender_email": "[email protected]",
"subject_name": "Mutual NDA Agreement from ACME Corp",
"title": "Mutual NDA Agreement from ACME Corp"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template_id: 'sign_123',
title: 'Mutual NDA Agreement',
tags: {ClientName: 'ACME Corp', EffectiveDate: '2026-01-01', ContractValue: '$50,000'},
fields: {CustomerName: 'John Doe', AgreeToTerms: true, ContractDuration: 12},
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'
}
],
viewers: [{email_address: '[email protected]', name: 'Legal Team'}],
expires_at: 1927510980694,
custom_email: {
sender_email: '[email protected]',
subject_name: 'Mutual NDA Agreement from ACME Corp',
title: 'Mutual NDA Agreement from ACME Corp'
}
})
};
fetch('https://api.luminpdf.com/v1/signature_request/send-from-template', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.luminpdf.com/v1/signature_request/send-from-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template_id' => 'sign_123',
'title' => 'Mutual NDA Agreement',
'tags' => [
'ClientName' => 'ACME Corp',
'EffectiveDate' => '2026-01-01',
'ContractValue' => '$50,000'
],
'fields' => [
'CustomerName' => 'John Doe',
'AgreeToTerms' => true,
'ContractDuration' => 12
],
'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'
]
],
'viewers' => [
[
'email_address' => '[email protected]',
'name' => 'Legal Team'
]
],
'expires_at' => 1927510980694,
'custom_email' => [
'sender_email' => '[email protected]',
'subject_name' => 'Mutual NDA Agreement from ACME Corp',
'title' => 'Mutual NDA Agreement from ACME Corp'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.luminpdf.com/v1/signature_request/send-from-template"
payload := strings.NewReader("{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/signature_request/send-from-template")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.luminpdf.com/v1/signature_request/send-from-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template_id\": \"sign_123\",\n \"title\": \"Mutual NDA Agreement\",\n \"tags\": {\n \"ClientName\": \"ACME Corp\",\n \"EffectiveDate\": \"2026-01-01\",\n \"ContractValue\": \"$50,000\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true,\n \"ContractDuration\": 12\n },\n \"signers\": [\n {\n \"signer_role\": \"Tenant\",\n \"email_address\": \"[email protected]\",\n \"name\": \"Jane Smith\",\n \"verification\": {\n \"method\": \"vc\",\n \"payload\": {\n \"doc_type\": \"driver_license\",\n \"claims\": [\n \"given_name\",\n \"family_name\",\n \"issuing_country\",\n \"issuing_authority\",\n \"document_number\"\n ]\n }\n }\n },\n {\n \"signer_role\": \"Customer\",\n \"email_address\": \"[email protected]\",\n \"name\": \"John Doe\"\n }\n ],\n \"viewers\": [\n {\n \"email_address\": \"[email protected]\",\n \"name\": \"Legal Team\"\n }\n ],\n \"expires_at\": 1927510980694,\n \"custom_email\": {\n \"sender_email\": \"[email protected]\",\n \"subject_name\": \"Mutual NDA Agreement from ACME Corp\",\n \"title\": \"Mutual NDA Agreement from ACME Corp\"\n }\n}"
response = http.request(request)
puts response.read_body{
"signature_request": {
"signature_request_id": "<string>",
"created_at": "<string>"
}
}{
"error_code": "<string>",
"error_message": "<string>"
}Required scopes (OAuth 2.0)
Required scopes (OAuth 2.0)
This endpoint requires the following scopes:
sign:requests and templatesThe
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
ApiKeyBearerAuth
Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.
Body
application/json
ID of the template. ID needs to include the prefix returned by the template list endpoint.
The title of the signature request.
Required string length:
1 - 255Signers of the signature request.
Hide child attributes
Hide child attributes
Email address of the signer.
Name of the signer.
The name of the signer role defined in the template. Must match a signer role in the template. Required when the template has defined signer roles.
Defines the identity verification method for a signer before they can complete the signing process. This allows stronger assurance of signer authenticity.
Requires a Digital Trust license enabled at the Workspace level. If your Workspace is not licensed, including this field will return a 403 verification_not_licensed error. Contact your Lumin account manager to enable Digital Trust.
Hide child attributes
Hide child attributes
The verification method used. Required when the verification object is present.
Possible values: vc – Verifiable Credential (via mDocs)
Available options:
vc Payload parameters required by the verification method. Required when the verification object is present.
Hide child attributes
Hide child attributes
The type of credential requested from the signer.
- If defined → VC verification is required for this signer.
- If omitted → VC verification is optional for this signer.
Must be in the Workspace's enabled_doc_types list.
Available options:
driver_license, photo_id, nz_business_passport The specific attributes requested from the credential. Required when the verification object is present.
Required claims (always):
given_name– Signer's given name, validated against the verified credentialfamily_name– Signer's family name, validated against the verified credential
Optional claims:
issuing_country– Country where the credential was issuedissuing_authority– The issuing authority tied to the root certificatedocument_number– The ID/number of the credential
The provided list must be a subset of the Workspace's required_claims.
Available options:
given_name, family_name, issuing_country, issuing_authority, document_number When the signature request will expire. This is a unix epoch timestamp (miliseconds). Should be later than today.
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.
Key–value pairs for Form Fields defined in the template. Keys must match field names. Values prefill the corresponding fields in the sent agreement.
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.
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.
Response
Returns the information of the created signature request.
Contains information about a signature request.
Hide child attributes
Hide child attributes
The unique identifier for the signature request.
The time the signature request was created.
The status of the signature request.
Available options:
WAITING_FOR_PROCESSING, FAILED ⌘I