Legalesign (Preview)

Designed for compliance-focused legal and operations teams, Legalesign's connector links Microsoft power platform with the Legalesign eSignature to trigger document and recipient workflows, send reminders, fetch PDFs, and surface form data. Requires an active Legalesign subscription approved for API use.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	API support
URL	https://legalesign.com/contact/
Email	sales@legalesign.com

Connector Metadata
Publisher	Legalesign
Find out more about Legalesign	https://docs.microsoft.com/connectors/legalesign
Website	https://legalesign.com
Privacy Policy	https://legalesign.com/opn/privacy/
Categories	Content and Files;Productivity

Legalesign eSignature REST Connector

The Legalesign REST API powers eSignature workflows. This connector provides full API access and real-time triggers, enabling seamless integration with Microsoft Power Automate, Logic Apps, and related platforms.

Prerequisites

To get started, you need a Legalesign account and API key: 1. Sign up for a free trial. 2. Create a group (an individual environment — for example, one for development and another for production). 3. Request an API key by creating a support ticket. Include your use case, company, and role so Support can verify your identity. 4. Once verified, log in to the API Dashboard to retrieve your key.

Deployment

New accounts start in sandbox mode with the following limitations: • Documents can only be sent to test email addresses you configure in the API Dashboard. • Requests are throttled to 100/minute.

When you are ready to go live, create a support ticket to switch your account from sandbox to production. At that point, the restrictions will be lifted. See deployment guide for details.

Triggers

The connector supports two real-time triggers:

Document events (e.g., created, rejected, signed, final PDF created)
Recipient events (e.g., completed, rejected, email opened, bounced, reminders sent)

You can receive all document or recipients, of filter by group or event type. All associated Legalesign webhooks can be managed and monitored in the API Dashboard.

Operations

Legalesign REST API operations are supported. The most common include downloading a signed PDF, managing templates, documents, recipients, and field placement. See the full API documentation for the complete specification.

In Legalesign an uploaded document is called a 'template'. When a template is sent to one or more recipients, it becomes a 'document'. You will typically upload a template, recover its identifier, then send it to one or more recipients.

Common operations include:

Templates

Create PDF template - upload a template (any file type, such as PDF, Word, or image).
Get PDF embeddable link - a one-use link to show the template editor to a user

Documents

Location to download PDF - returns the PDF binary of a signed document
Create signing document - send a document (select a template and recipients)
Void/archive signing document - stop a document from being signed
Permanently delete signing document - remove a document forever

Recipients (signers)

Send signer reminder email - remind the recipient to complete your document
Get signer rejection reason - if document is rejected, see why

Field placement

Legalesign has an advanced form system with fields. If you have signatories, then each signatory must have at least one signature field.

There are four ways to define fields in your template:

Upload a PDF with embedded fields (auto-converted by Legalesign).
Use Legalesign text tags.
Define x/y coordinates.
Use the Legalesign form editor (via the embed link or the web app).

Click here for the guide

Queries and support

For additional support or queries, log in to your Legalesign account and create a support ticket.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
api_key	securestring	The api_key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Delete an attachment	Delete an attachment.
Download PDF	Get the draft or final PDF for a signing document, depending on its status. Note a 200 or 302 response is possible.
Download the document auditlog	PDF of only the document auditlog.
Get attachment	Get an attachment.
Get attachments	List attachments.
Get document	Return a specific document.
Get document fields	The fields from the document.
Get documents	List unarchived signing documents.
Get groups	List groups the api user belongs to.
Get PDF embeddable link	Return a one-use link to embed PDF editor.
Get PDF template	Details of a specific PDF template
Get PDF templates	List PDF templates
Get recipient	Get status and details of an individual recipient.
Get recipient form fields	Return the form fields from a specific recipient.
Get recipient link	One-use link for recipient to go to signing pages.
Get recipient rejection reason	Returns the reason signer gave for rejecting a document.
Get user	Get user details.
Member of a group	Details of a specific user within a group.
Members of groups	Listings of all the members of your groups.
Permanently delete document	Permanently deletes data and files.
Send document	Send a document for signature or approval.
Send recipient reminder email	Send a recipient a reminder email.
Upload PDF attachment	Save a pdf to attach to a recipient email.
Upload PDF template	Upload a PDF document you want to send to be signed.
Void and archive document	Sets a document with status 40 -removed- and archives it.

Delete an attachment

Operation ID:: DeleteAttachment

Delete an attachment.

Parameters

Name	Key	Required	Type	Description
Attachment Id	attachId	True	uuid	Attach Id

Download PDF

Operation ID:: GetDocumentPdf

Get the draft or final PDF for a signing document, depending on its status. Note a 200 or 302 response is possible.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document Id

Returns

response: file

Download the document auditlog

Operation ID:: GetDocumentAuditLog

PDF of only the document auditlog.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document Id

Returns

response: file

Get attachment

Operation ID:: GetAttachment

Get an attachment.

Parameters

Name	Key	Required	Type	Description
Attachment Id	attachId	True	uuid	Attachment Id

Returns

Attach item.

Body: AttachmentResponse

Get attachments

Operation ID:: GetAttachments

List attachments.

Parameters

Name	Key	Type	Description
Group Id	group	string	Filter by a specific group.
Query limit	limit	integer	Use with offset to iterate through results.
Query offset	offset	integer	Use with limit to iterate through results.

Returns

Attachment Listing

Body: AttachmentListResponse

Get document

Operation ID:: GetDocument

Return a specific document.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document id

Returns

Document detail

Body: DocumentResponseDetail

Get document fields

Operation ID:: GetDocumentFields

The fields from the document.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document id

Returns

Name	Path	Type	Description
		array of object	List of document fields
element_type	element_type	string	Element type
fieldorder	fieldorder	integer	Field order
label	label	string	Label
label_extra	label_extra	string	Extra label
signer	signer	integer	Recipient
state	state	boolean
validation	validation	integer	Validation identifier
value	value	string	Value

Get documents

Operation ID:: GetDocuments

List unarchived signing documents.

Parameters

Name	Key	Required	Type	Description
Group Id	group	True	string	Filter by a specific group, required.
Do include archived documents	archived		string	Filter on archived status, default is unarchived, use value all in this parameter to query all documents.
Filter by recipient email	email		string	Filter by recipient email.
Query limit	limit		integer	Length of dataset to return. Use with offset query to iterate through results.
Query offset	offset		integer	Offset from start of dataset. Use with the limit query to iterate through dataset.
Filter by document status	status		integer	Filter on document status.
Do remove recipients from response	nosigners		string	Add value 1 to remove recipients information for a faster query.
Filter for created after this date	created_gt		date-time	Filter for those documents created after a certain time.
Filter for modified after this date	modified_gt		date-time	Filter for those documents modified after a certain time.

Returns

Document listings

Body: DocumentListResponse

Get groups

Operation ID:: GetGroups

List groups the api user belongs to.

Parameters

Name	Key	Required	Type	Description
Query offset	offset		integer	Offset from start of dataset. Use with the limit query to iterate through dataset.
Query limit	limit		integer	Length of dataset to return. Use with offset query to iterate through results.

Returns

Groups listing

Body: GroupListResponse

Get PDF embeddable link

Operation ID:: GetPdfTemplateEditLink

Return a one-use link to embed PDF editor.

Parameters

Name	Key	Required	Type	Description
Pdf Id	pdfId	True	string	Set uploaded PDF Id.
Hide field listing from rendered page	hide_sender_fields		boolean	Hide field listing from rendered page.
Hex code excluding hash symbol for background color	css_body_backgroundcolor		string	Use hex code excluding hash symbol to change background color.

Get PDF template

Operation ID:: GetPdfTemplate

Details of a specific PDF template

Parameters

Name	Key	Required	Type	Description
Uploaded PDF Id	pdfId	True	uuid	Uploaded PDF Id

Returns

Template details

Body: TemplatePdfResponse

Get PDF templates

Operation ID:: GetPdfTemplates

List PDF templates

Parameters

Name	Key	Type	Description
Group Id	group	string	Can be full resource_uri or only id.
Query limit	limit	integer	Length of dataset to return. Use with offset query to iterate through results.
Query offset	offset	integer	Offset from start of dataset. Use with the limit query to iterate through dataset.

Returns

Template listings

Body: TemplatePdfListResponse

Get recipient

Operation ID:: GetRecipient

Get status and details of an individual recipient.

Parameters

Name	Key	Required	Type	Description
Recipient Id	recipientId	True	uuid	Recipient Id

Returns

Recipient details

Body: SignerResponse

Get recipient form fields

Operation ID:: GetSignerFields

Return the form fields from a specific recipient.

Parameters

Name	Key	Required	Type	Description
Recipient Id	recipientId	True	uuid	Recipient Id

Returns

Name	Path	Type	Description
		array of object
label	label	string	Label
label_extra	label_extra	string	Extra label
state	state	boolean	State
fieldorder	fieldorder	integer	Field order
value	value	string	If the field is a signer file this value will be a short lived download URL.

Get recipient link

Operation ID:: GetSignerLink

One-use link for recipient to go to signing pages.

Parameters

Name	Key	Required	Type	Description
Recipient Id	recipientId	True	uuid	Recipient Id

Get recipient rejection reason

Operation ID:: GetSignerRejection

Returns the reason signer gave for rejecting a document.

Parameters

Name	Key	Required	Type	Description
Recipient Id	recipientId	True	uuid	Recipient Id

Returns

Name	Path	Type	Description
status	status	integer	Recipient statues.
reason	reason	string	Reject reason.

Get user

Operation ID:: GetUser

Get user details.

Parameters

Name	Key	Required	Type	Description
User Id	userId	True	uuid	User Id

Returns

Details of the user.

Body: UserDetailResponse

Member of a group

Operation ID:: GetMember

Details of a specific user within a group.

Parameters

Name	Key	Required	Type	Description
Member Id	memberId	True	uuid	Member Id

Returns

Body: MemberResponse

Members of groups

Operation ID:: GetMembers

Listings of all the members of your groups.

Parameters

Name	Key	Type	Description
Group Id	group	string	Filter by a specific group
Query limit	limit	integer	Use with offset to iterate through results.
Query offset	offset	integer	Use with limit to iterate through results.

Returns

Body: MemberListResponse

Permanently delete document

Operation ID:: DeleteDocument

Permanently deletes data and files.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document Id

Send document

Operation ID:: PostDocument

Send a document for signature or approval.

Parameters

Name	Key	Required	Type	Description
Group	group	True	string	Group resource uri
Name	name	True	string	Specify the name of the document
PDF template	templatepdf	True	string	The uploaded PDF to send.
email	email	True	email	Email
firstname	firstname	True	string	First name
lastname	lastname	True	string	Last name
attachments	attachments		array of string	List of attachment resource uris.
expires	expires		date-time	ISO8601 formed datetime, set to TZ of sender or timezone if used
message	message		string	Your personal message for the party, entered in the centre of the group email template. Use the name of a saved email template preceeded by a hash symbol to use that template. If there is more than one template of the same name it will select the one last modified.
firstname	firstname		string	First name
lastname	lastname		string	Last name
email	email	True	email	Email
include_link	include_link		boolean	Include a link to the signing pages enabling a reviewer to sign
sms	sms		string	Use international format number to add SMS verification. Required if a witness or a witnessed signer.
subject	subject		string	Subject line for outbound email
timezone	timezone		string	TZ of the signer, must be valid TZ as per timezoneenum (see User for timezoneenum details). If blank uses tz of the sender.
Signature type	signature_type		integer	Use 4 to get your executed PDF Certified. Recommended. Defaults to 1 (uses a sha256 hash for document integrity).
Append PDF	append_pdf		boolean	Append Legalesign validation info to final PDF.
auto_archive	auto_archive		boolean	Send to archive soon after signing. Keeps web app clutter free
Use Legalesign emails	do_email		boolean	Use Legalesign email to send notification emails. If false suppresses all emails.
CC upon completion	cc_emails		string	Comma delimited string of email addresses that are notified of signing or rejection.
Convert empty sender fields to first recipient fields	convert_sender_to_signer		boolean	If any sender fields are left blank, convert them to fields for the first recipient.
PDF password	pdf_password		string	Set a password. Must be ascii encode-able, you must also set signature_type to 4 and choose a pdf_password_type.
PDF password settings	pdf_password_type		integer	1 to store password, 2 for to delete from our records upon final signing.
pdftext	pdftext		object	Assign values to PDF sender fields, use the template's field label or its uuid as object keys. See templatepdf/:id/fields/ and filter for element_type="admin", to get relevant fields with their label or uuid. See also strict_fields.
Redirect URL	redirect		string	URL to send the signer to after signing (instead of download page). Your URL will include query parameters with ID and state information as follows: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Reminder schedule	reminders		string	Put 'default' if you wish to use the default reminder schedule in the group (go to web app to set default schedule)
Return signer links	return_signer_links		boolean	Return document links for signers in the response BODY.
send sequencing	signers_in_order		boolean	Notify signers in their order sequence. If false all are notified simulataneously.
signertext	signertext		object	Add custom placeholders to signer fields. Use field labels or uuid as keys in the object (as for pdftext). See templatepdf/:id/fields/ and filter for element_type = "text" to get relevant fields with their labels or uuid.
Enforce field validation	strict_fields		boolean	Pdftext fails validation checks silently, set true to validate.
Your reference	tag		string	Tag
Your reference	tag1		string	Tag
Your reference	tag2		string	Tag
user	user		string	Assign document another user in the group.

Send recipient reminder email

Operation ID:: PostSignerReminder

Send a recipient a reminder email.

Parameters

Name	Key	Required	Type	Description
Recipient Id	recipientId	True	uuid	Recipient Id
text	text		string	Custom message text

Upload PDF attachment

Operation ID:: PostAttachment

Save a pdf to attach to a recipient email.

Parameters

Name	Key	Required	Type	Description
group	group	True	string	Group resource uri
pdf_file	pdf_file	True	byte	Base64 encoded PDF file data, max size is a group setting, 5MB by default.
filename	filename	True	string	Simple alphanumeric name ending .pdf
user	user		string	Assign to another user.
description	description		string

Returns

Upload PDF template

Operation ID:: PostPdfTemplate

Upload a PDF document you want to send to be signed.

Parameters

Name	Key	Required	Type	Description
Archive upon send	archive_upon_send		boolean	Set true if this upload will be for one-use only.
Group	group	True	string	Specify group where this will be used.
PDF file	pdf_file	True	byte	Base64 encoded PDF file data.
Process tags	process_tags		boolean	If the file contains text tags then convert them to fields.
Title	title		string	Name this record, will use file name if not used.
User	user		string	Assign to group member if not api user.

Void and archive document

Operation ID:: UpdateArchiveDocument

Sets a document with status 40 -removed- and archives it.

Parameters

Name	Key	Required	Type	Description
Document Id	docId	True	uuid	Document Id
Do notification email to recipient	email		string	If set to true or 1 the recipients are notified the document is voided.

Triggers

Document event	Trigger for a document event occurs
Recipient event	Trigger for when a recipient event occurs

Document event

Operation ID:: DocumentTrigger

Trigger for a document event occurs

Parameters

Name	Key	Required	Type	Description
eventFilter	eventFilter	True	string	Event filter
group	group		string	Group filter

Returns

Name	Path	Type	Description
version	version	string	Version
object	object	string	Object
tag1	data.tag1	string	Tag
recipients	data.recipients	array of object	Recipients
uuid	data.recipients.uuid	string	Recipient Id
email	data.recipients.email	string	Recipient email
order	data.recipients.order	integer	Recipient order number
status	data.recipients.status	integer	Recipient status
lastname	data.recipients.lastname	string	Recipient lastname
roleText	data.recipients.roleText	string	Recipient role text
firstname	data.recipients.firstname	string	Recipient first name
statusText	data.recipients.statusText	string	Recipient statusText
resourceUri	data.recipients.resourceUri	string	Recipient resource uri
rejectReason	data.recipients.rejectReason	string	rejectReason
groupResourceUri	data.groupResourceUri	string	Group resource uri
statusText	data.statusText	string	Document status text
name	data.name	string	Document name
tag	data.tag	string	Tag
resourceUri	data.resourceUri	string	Resource uri
uuid	data.uuid	string	Document Id
tag2	data.tag2	string	Tag2
group	data.group	string	Group
status	data.status	integer	Document status
created	created	integer	Created
id	id	string	Did
event	event	string	Event

Recipient event

Operation ID:: RecipientTrigger

Trigger for when a recipient event occurs

Parameters

Name	Key	Required	Type	Description
eventFilter	eventFilter	True	string	Event filter
group	group		string	Group filter

Returns

Name	Path	Type	Description
version	version	string	Version
object	object	string	Object
tag	data.tag	string	Tag
tag1	data.tag1	string	Tag1
tag2	data.tag2	string	Tag2
uuid	data.uuid	string	Recipient Id
email	data.email	string	Email
group	data.group	string	Group
order	data.order	integer	Order
status	data.status	integer	Status
document	data.document	string	Document
lastname	data.lastname	string	Last name
roleText	data.roleText	string	Role text
firstname	data.firstname	string	First name
statusText	data.statusText	string	Status text
emailBounce	data.emailBounce	integer	Email did bounce
resourceUri	data.resourceUri	string	Recipient resource uri
documentName	data.documentName	string	Document name
rejectReason	data.rejectReason	string	Reject reason
groupResourceUri	data.groupResourceUri	string	Group resource uri
emailBounceMessage	data.emailBounceMessage	string	Email bounce message
documentResourceUri	data.documentResourceUri	string	Document resource uri
created	created	integer	Created
id	id	string	ID
event	event	string	Event

Definitions

PermissionsEnum

Permission options

: integer

ListMeta

Meta information about listing.

Name	Path	Type	Description
limit	limit	integer	Maximum number of objects.
next	next	string	URL for next set of objects.
offset	offset	integer	Number of items from the start of the resultset.
previous	previous	string	URL for previous set of objects.
total_count	total_count	integer	Total number of objects.

GroupListResponse

Groups listing

Name	Path	Type	Description
meta	meta	ListMeta	Meta information about listing.
objects	objects	array of object
created	objects.created	date-time	Created
is_active	objects.is_active	boolean	Active
modified	objects.modified	date-time	Modified
name	objects.name	string	Name
public_name	objects.public_name	string	Public name
resource_uri	objects.resource_uri	string	Resource uri
slug	objects.slug	string	Unique name
user	objects.user	string	Creator resource uri
xframe_allow	objects.xframe_allow	boolean	Allow embed signing
xframe_allow_pdf_edit	objects.xframe_allow_pdf_edit	boolean	Allow embed edit

TemplatePdfListResponse

Template listings

Name	Path	Type	Description
meta	meta	ListMeta	Meta information about listing.
objects	objects	array of TemplatePdfResponse

TemplatePdfResponse

Template details

Name	Path	Type	Description
created	created	date-time	Created
group	group	string	Group uri
modified	modified	date-time	Modified
parties	parties	string	JSON stringified array of document parties.
page_count	page_count	integer	Page count
resource_uri	resource_uri	string	Resource uri
signer_count	signer_count	integer	Signer count
title	title	string	Title
user	user	string	Resource uri of creator
uuid	uuid	uuid	Pdf Id
valid	valid	boolean	Is able to be sent (if fields do not validate).

DocumentListResponse

Document listings

Name	Path	Type	Description
meta	meta	ListMeta	Meta information about listing.
objects	objects	array of object	Documents
archived	objects.archived	boolean	Archived
auto_archive	objects.auto_archive	boolean	Archive after sending.
cc_emails	objects.cc_emails	string	Comma-delimited list emails to cc upon completion.
created	objects.created	date-time	Created
do_email	objects.do_email	boolean	Use Legalesign emails.
download_final	objects.download_final	boolean	Is ready to download after completion.
group	objects.group	string	Group resource uri.
modified	objects.modified	date-time	Modified
name	objects.name	string	Document name
pdftext	objects.pdftext	string	Sender field values
redirect	objects.redirect	string	URL to redirect recipient after signing
resource_uri	objects.resource_uri	string	Resource uri
return_signer_links	objects.return_signer_links	boolean	Add recipient links to response
signers	objects.signers	array of array	Nested arrays with signer details
items	objects.signers	array of	Always contains [signer uri, first name, last name, email, sms number, has_fields, status, signer order (0-indexed)]
signers_in_order	objects.signers_in_order	integer	Email recipients simulataneously or sequentially
status	objects.status	DocumentStatusEnum	Document status options: 10 - Initial state, check signer status for sent/unsent 20 - Fields completed 30 - Signed 40 - Removed (before signing) 50 - Rejected
tag	objects.tag	string	Tag document
tag1	objects.tag1	string	Tag document
tag2	objects.tag2	string	Tag document
template	objects.template	string	Template resource uri if used
templatepdf	objects.templatepdf	string	PDF template resource uri
text	objects.text	string	Text for signing
user	objects.user	string	Creator uri
uuid	objects.uuid	uuid	Document Id

DocumentStatusEnum

Document status options:

10 - Initial state, check signer status for sent/unsent
20 - Fields completed
30 - Signed
40 - Removed (before signing)
50 - Rejected

Document status options:

10 - Initial state, check signer status for sent/unsent
20 - Fields completed
30 - Signed
40 - Removed (before signing)
50 - Rejected

: integer

SignerResponse

Recipient details

Name	Path	Type	Description
document	document	string	Document
email	email	string	Recipient email
first_name	first_name	string	Recipient first name
last_name	last_name	string	Recipient last name
has_fields	has_fields	boolean	Recipient has fields
order	order	integer	Recipient order
resource_uri	resource_uri	string	Recipient resource uri
status	status	SignerStatusEnum	Signer status options: 4 - unsent 5 - scheduled to be sent 10 - sent 15 - email opened 20 - visited 30 - fields complete 35 - fields complete ex signature 39 - waiting for witness to complete 40 - signed 50 - downloaded 60 - rejected

SignerStatusEnum

Signer status options:

4 - unsent
5 - scheduled to be sent
10 - sent
15 - email opened
20 - visited
30 - fields complete
35 - fields complete ex signature
39 - waiting for witness to complete
40 - signed
50 - downloaded
60 - rejected

Signer status options:

4 - unsent
5 - scheduled to be sent
10 - sent
15 - email opened
20 - visited
30 - fields complete
35 - fields complete ex signature
39 - waiting for witness to complete
40 - signed
50 - downloaded
60 - rejected

: integer

DocumentResponseDetail

Document detail

Name	Path	Type	Description
archived	archived	boolean	Is archived
auto_archive	auto_archive	boolean	Send document archive after signing.
cc_emails	cc_emails	string	Who will be cc'd with sender on email notification when signed
created	created	date-time	Created
do_email	do_email	boolean	Use Legalesign emails
download_final	download_final	boolean	Final PDF is available to download
footer	footer	string	HTML docs - text for footer if used
footer_height	footer_height	integer	HTMl docs - px height of footer if used
group	group	string	Resource uri of group
has_fields	has_fields	boolean	Document has fields
hash_value	hash_value	string	SHA256 checksum of final doc, use this to validate your final PDF download
header	header	string	HTML docs - text for header if used
header_height	header_height	integer	HTMl docs - px height of header if used
modified	modified	date-time	Modified
name	name	string	Document name
pdf_password	pdf_password	string	PDF password
pdf_password_type	pdf_password_type	string	If pdf password is retained
pdftext	pdftext	string	Ignore this
redirect	redirect	string	URL for recipient redirect after signing
resource_uri	resource_uri	string	Resource uri
return_signer_links	return_signer_links	boolean	Ignore
sign_mouse	sign_mouse	boolean	ignore
sign_time	sign_time	date-time	Sign time
sign_type	sign_type	boolean	legacy
sign_upload	sign_upload	boolean	legacy
signature_placement	signature_placement	integer	legacy
signature_type	signature_type	integer	legacy - always 4
signers	signers	array of array	Nested arrays with signer details
items	signers	array of	Always contains [signer uri, first name, last name, email, sms number, has_fields, status, signer order (0-indexed)]
signer_objects	signer_objects	array of object	List of recipients
email	signer_objects.email	string	Email
firstname	signer_objects.firstname	string	First name
lastname	signer_objects.lastname	string	Last name
tel	signer_objects.tel	string	Tel number
order	signer_objects.order	integer	Signing order
resource_uri	signer_objects.resource_uri	string	Resource uri
role	signer_objects.role	string	Role
status	signer_objects.status	integer	Recipient status code
uuid	signer_objects.uuid	string	Recipient Id
signers_in_order	signers_in_order	boolean	Email recipients simulataneously or sequentially
status	status	DocumentStatusEnum	Document status options: 10 - Initial state, check signer status for sent/unsent 20 - Fields completed 30 - Signed 40 - Removed (before signing) 50 - Rejected
tag	tag	string	Your reference
tag1	tag1	string	Your reference
tag2	tag2	string	Your reference
template	template	string	Resource uri for text template if used
templatepdf	templatepdf	string	Resource uri for pdf template if used
text	text	string	Text for document if used
user	user	string	User resource uri.
uuid	uuid	uuid	Document Id

MemberListResponse

Name	Path	Type	Description
meta	meta	ListMeta	Meta information about listing.
objects	objects	array of MemberResponse

MemberResponse

Name	Path	Type	Description
created	created	date-time	Created
group	group	string	Group resource uri
modified	modified	date-time	Modified
permission	permission	PermissionsEnum	Permission options
resource_uri	resource_uri	string	Resource uri
user	user	string	User resource uri.

AttachmentResponse

Attach item.

Name	Path	Type	Description
created	created	date-time	Created
description	description	string	Description
filename	filename	string	File name
group	group	string	Group
resource_uri	resource_uri	string	Attach resource uri
user	user	string	User resource uri
uuid	uuid	uuid	Attach Id

AttachmentListResponse

Attachment Listing

Name	Path	Type	Description
meta	meta	ListMeta	Meta information about listing.
objects	objects	array of object	Listing
created	objects.created	date-time	Created
description	objects.description	string	Description
filename	objects.filename	string	File name
group	objects.group	string	Group
resource_uri	objects.resource_uri	string	Resource uri
user	objects.user	string	User resource uri
uuid	objects.uuid	uuid	Attach Id

UserDetailResponse

Details of the user.

Name	Path	Type	Description
date_joined	date_joined	date-time	Date joined
email	email	email	Email
first_name	first_name	string	First name
groups	groups	array of string	List of groups this user has joined.
last_login	last_login	date-time	Last login
last_name	last_name	string	Last name
resource_uri	resource_uri	string	Resource uri
timezone	timezone	string	Timezone
username	username	string	Username

file

This is the basic data type 'file'.

Share via

Legalesign (Preview)

Legalesign eSignature REST Connector

Prerequisites

Deployment

Triggers

Operations

Templates

Documents

Recipients (signers)

Field placement

Queries and support

Creating a connection

Default

Throttling Limits

Actions

Delete an attachment

Parameters

Download PDF

Parameters

Returns

Download the document auditlog

Parameters

Returns

Get attachment

Parameters

Returns

Get attachments

Parameters

Returns

Get document

Parameters

Returns

Get document fields

Parameters

Returns

Get documents

Parameters

Returns

Get groups

Parameters

Returns

Get PDF embeddable link

Parameters

Get PDF template

Parameters

Returns

Get PDF templates

Parameters

Returns

Get recipient

Parameters

Returns

Get recipient form fields

Parameters

Returns

Get recipient link

Parameters

Get recipient rejection reason

Parameters

Returns

Get user

Parameters

Returns

Member of a group

Parameters

Returns

Members of groups

Parameters

Returns

Permanently delete document

Parameters

Send document

Parameters

Send recipient reminder email

Parameters

Upload PDF attachment

Parameters

Returns

Upload PDF template