Lumin
App · 12 actions
Send documents for e-signature with Lumin: send a PDF to signers, check who has signed, remind people, get signing links and signed PDFs, cancel requests, and save files as Lumin documents.
Actions
| Action | What it does |
|---|---|
| Cancel signature request | Cancel a signature request so nobody can sign it any more. |
| Create document | Save a file from a web address as a document in Lumin. |
| Get current user | Get the Lumin user the API key acts as: id, name and email. |
| Get signature request | Get a signature request: its status, due date, link to view it and each signer's progress. |
| Get signature request file | Get a short-lived link to download the request's PDF: the agreement, or once everyone has signed, its Certificate of Completion or both together. |
| Get signing link | Get a link one signer can open to view and sign the request, so you can show it in your own app instead of relying on the email. |
| Get workspace | Get the Lumin workspace the API key works in: its name, owner, your role and how many members and spaces it has. |
| List templates | List the workspace's templates (PDF and agreement templates) with their ids. |
| List workspace members | List the people in the workspace with their role and when they last used Lumin. |
| Send reminders | Email a reminder to signers who have not signed yet. |
| Send signature request | Send a PDF (or other document) from a web address to be signed. |
| Update signature request due date | Move the due date of a signature request that is still waiting for signatures. |
Cancel signature request
Cancel a signature request so nobody can sign it any more. It cannot be undone.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
Outputs
signature_request_idtext- The request cancelled
statustext- CANCELLED
Example output
{
"signature_request_id": "6af753f968dd3c7075ab5a5c",
"status": "CANCELLED"
}Create document
Save a file from a web address as a document in Lumin. It can be a PDF, Word, Excel or PowerPoint file, or a PNG or JPEG image.
Inputs
- File address
file_urltextRequired - A public web address Lumin can download the file from. The address must answer with the file's own type, such as application/pdf.
- Document name
document_nametextRequired - The name the document has in Lumin.
- Save to
locationtext - Where the document is kept. Defaults to the workspace.One of:
workspace(Workspace documents (default)),personal(My personal documents).
Outputs
documentobject- The new document
Example output
{
"document": {
"created_at": 1794593857353,
"id": "6af75441d2c7c9b3daab10ce",
"location": {
"folder_id": "",
"space_id": "",
"type": "workspace",
"workspace_id": "6af5c927bf17eccefe2c6748"
},
"mime_type": "application/pdf",
"name": "Service agreement",
"preview_url": "https://app.luminpdf.com/viewer/6af75441d2c7c9b3daab10ce",
"size": 13203,
"updated_at": 0
}
}Get current user
Get the Lumin user the API key acts as: id, name and email.
Inputs
None.
Outputs
userobject- The connected user
Example output
{
"user": {
"email": "jo@example.com",
"id": "6af5c85af314011db5aa382e",
"name": "Jo Bloggs"
}
}Get signature request
Get a signature request: its status, due date, link to view it and each signer's progress.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
Outputs
signature_requestobject- The signature request
Example output
{
"signature_request": {
"created_at": 1794593786082,
"details_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=abc",
"expires_at": 1797185785000,
"reason": "",
"signature_request_id": "6af753f968dd3c7075ab5a5c",
"signers": [
{
"email": "jo@example.com",
"group": 1,
"is_approved": false,
"name": "Jo Bloggs",
"status": "NEED_TO_SIGN"
}
],
"signing_type": "SAME_TIME",
"status": "WAITING_FOR_OTHERS",
"title": "Service agreement",
"updated_at": 1794593786157
}
}Get signature request file
Get a short-lived link to download the request's PDF: the agreement, or once everyone has signed, its Certificate of Completion or both together.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
- File
file_typetext - Which PDF to get. Defaults to the agreement.One of:
agreement(The agreement (default)),coc(Certificate of Completion (once signed)),merged(Agreement and certificate in one PDF (once signed)).
Outputs
download_urltext- Lumin's own download address for the file
expires_atnumber- When signed_url stops working, as Unix time
file_typetext- Which file was asked for
signed_urltext- Download link that works for about 15 to 30 minutes
Example output
{
"download_url": "https://api.luminpdf.com/d/file_abc",
"expires_at": 1794594699983,
"file_type": "agreement",
"signed_url": "https://files.luminpdf.com/download/agreement.pdf?expires=1"
}Get signing link
Get a link one signer can open to view and sign the request, so you can show it in your own app instead of relying on the email.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
- Signer email
signer_emailtextRequired - The email address of the signer the link is for.
Outputs
signer_emailtext- The signer it is for
statustext- The signer's status
view_urltext- The link the signer opens
Example output
{
"signer_email": "jo@example.com",
"status": "NEED_TO_SIGN",
"view_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=abc"
}Get workspace
Get the Lumin workspace the API key works in: its name, owner, your role and how many members and spaces it has.
Inputs
None.
Outputs
workspaceobject- The workspace
Example output
{
"workspace": {
"created_at": 1794492711331,
"id": "6af5c927bf17eccefe2c6748",
"name": "Acme",
"owner": "jo@example.com",
"total_members": 3,
"total_spaces": 0,
"user_role": "owner"
}
}List templates
List the workspace's templates (PDF and agreement templates) with their ids. Gets one page; to see more, run it again with the next page.
Inputs
- Page
pagenumber - Which page to get, starting at 1. Defaults to the first.At least 1.
- Page size
limittext - How many to get at once: 10, 25 or 50. Defaults to 25.One of:
10,25(25 (default)),50.
Outputs
countnumber- How many are on this page
limitnumber- The page size used
pagenumber- The page number returned
templateslist- The templates
total_countnumber- How many there are in all
Example output
{
"count": 1,
"limit": 25,
"page": 1,
"templates": [
{
"created_at": 1748456885430,
"name": "Onboarding form",
"template_id": "pdf_456789",
"type": "pdf",
"updated_at": 1748456885430
}
],
"total_count": 1
}List workspace members
List the people in the workspace with their role and when they last used Lumin. Gets one page; to see more, run it again with the next page.
Inputs
- Page
pagenumber - Which page to get, starting at 1. Defaults to the first.At least 1.
- Page size
limittext - How many to get at once: 10, 25 or 50. Defaults to 25.One of:
10,25(25 (default)),50.
Outputs
countnumber- How many are on this page
limitnumber- The page size used
memberslist- The members
pagenumber- The page number returned
total_countnumber- How many there are in all
Example output
{
"count": 1,
"limit": 25,
"members": [
{
"email": "jo@example.com",
"id": "6af5c85af314011db5aa382e",
"joined_at": 1794492711377,
"last_active_at": 1794514913401,
"name": "Jo Bloggs",
"role": "owner"
}
],
"page": 1,
"total_count": 1
}Send reminders
Email a reminder to signers who have not signed yet. Signers who already signed are skipped, and each signer gets at most 10 reminders a day. The result says what happened for each address.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
- Signer emails
emailslistRequired - The email addresses of the signers to remind.
Outputs
reminderslist- One result per address: SENT, BOUNCE (already signed or not their turn) or EXCEED_DAILY_LIMIT
signature_requestobject- The signature request
Example output
{
"reminders": [
{
"email": "jo@example.com",
"email_status": "SENT",
"signer_status": "NEED_TO_SIGN"
}
],
"signature_request": {
"created_at": 1794593786082,
"details_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=abc",
"expires_at": 1797185785000,
"reason": "",
"signature_request_id": "6af753f968dd3c7075ab5a5c",
"signers": [
{
"email": "jo@example.com",
"group": 1,
"is_approved": false,
"name": "Jo Bloggs",
"status": "NEED_TO_SIGN"
}
],
"signing_type": "SAME_TIME",
"status": "WAITING_FOR_OTHERS",
"title": "Service agreement",
"updated_at": 1794593786157
}
}Send signature request
Send a PDF (or other document) from a web address to be signed. Lumin emails each signer. It answers at once with the new request's id while it prepares the file; read the request with 'Get signature request' a moment later to see its signers.
Inputs
- File address
file_urltextRequired - A public web address Lumin can download the file from, such as a link from an earlier step.
- Title
titletextRequired - The request's title, shown to signers and in the email.
- Signers
signerslistRequired - Who has to sign. Each needs a name and an email; add a group number (1, 2, ...) only when signing in order.
- Viewers
viewerslist - People who get a copy to read but do not sign.
- Due date
expires_atdate and time - When the request expires. Must be in the future. Defaults to 30 days from now.
- Signing order
signing_typetext - Whether everyone signs at once or group by group. Group by group needs a group number on every signer.One of:
SAME_TIME(Everyone at the same time (default)),ORDER(One group after another, in order). - Read text tags in the file
use_text_tagstrue/false - Turn Lumin text tags in the document into signature boxes and form fields.Default:
false.
Outputs
signature_requestobject- The new request: its id and status
Example output
{
"signature_request": {
"created_at": 1794593785943,
"signature_request_id": "6af753f968dd3c7075ab5a5c",
"status": "WAITING_FOR_PROCESSING"
}
}Update signature request due date
Move the due date of a signature request that is still waiting for signatures. Only the person who sent it can change it.
Inputs
- Signature request ID
signature_request_idtextRequired - The signature request's id: the 'signature_request_id' that 'Send signature request' returns.
- New due date
expires_atdate and timeRequired - When the request should now expire. Must be in the future.
Outputs
signature_requestobject- The signature request
Example output
{
"signature_request": {
"created_at": 1794593786082,
"details_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=abc",
"expires_at": 1797185785000,
"reason": "",
"signature_request_id": "6af753f968dd3c7075ab5a5c",
"signers": [
{
"email": "jo@example.com",
"group": 1,
"is_approved": false,
"name": "Jo Bloggs",
"status": "NEED_TO_SIGN"
}
],
"signing_type": "SAME_TIME",
"status": "WAITING_FOR_OTHERS",
"title": "Service agreement",
"updated_at": 1794593786157
}
}