Skip to main content
POST
/
signature_request
/
send
Send Signature Request
curl --request POST \
  --url https://api.luminpdf.com/v1/signature_request/send \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "file_url": "https://example.com/path/to/document.pdf",
  "title": "Financial Year-End Report Authorization",
  "signers": [
    {
      "email_address": "[email protected]",
      "name": "John Doe",
      "group": 1
    },
    {
      "email_address": "[email protected]",
      "name": "Jane Doe",
      "group": 2
    }
  ],
  "viewers": [
    {
      "email_address": "[email protected]",
      "name": "Jane Doe"
    }
  ],
  "expires_at": 1927510980694,
  "use_text_tags": false,
  "signing_type": "ORDER"
}
'
{
  "signature_request": {
    "signature_request_id": "<string>",
    "created_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
signers
object[]
required

Signers of the signature request.

​
title
string
required

The title of the signature request.

Required string length: 1 - 255
​
expires_at
integer<unix-epoch>
required

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

​
file_url
string

The URL of a single file to be downloaded and signed. This field is mutually exclusive with file, files, and file_urls. Only one of these fields should be provided in the request.

​
file
file

A single uploaded file to be sent for signature. This field is mutually exclusive with file_url, files, and file_urls. Only one of these fields should be provided in the request.

​
file_urls
string[]

An array of URLs of files to be downloaded and signed. This field is mutually exclusive with file, files, and file_url. Only one of these fields should be provided in the request.

​
files
binary[]

An array of uploaded files to be sent for signature. This field is mutually exclusive with file, file_url, and file_urls. Only one of these fields should be provided in the request.

​
viewers
object[]

Viewers of the signature request.

​
use_text_tags
boolean

Set to true to enable Text Tag parsing in your document. Your Text Tags will be converted into UI components for the user to interact with. Defaults to false.

​
signing_type
enum<string>

The signing order for the signature request. Defaults to SAME_TIME.

Available options:
SAME_TIME,
ORDER
​
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.