LElegalesign
document

Create signing document

Changed on
post/document/

Request

  • Base URL
    https://eu-api.legalesign.com/api/v1
  • URL
    https://eu-api.legalesign.com/api/v1/document/
  • Auth
    API key in header Authorization

Request body

groupstring uri required
namestring required
templatepdfstring uri required

Resource URI of templatepdf object.

signature_typeinteger

Use 4 to get your executed PDF Certified. Recommended. Defaults to 1 (uses a sha256 hash for document integrity).

append_pdfboolean

Append Legalesign validation info to final PDF. If not included uses the group default.

append_historyboolean

Append Legalesign audit log to final PDF. If not included uses the group default.

auto_archiveboolean

Send to archive soon after signing. Keeps web app clutter free

do_emailboolean

Use Legalesign email to send notification emails. If false suppresses all emails.

cc_emailsstring

Comma delimited string of email addresses that are notified of signing or rejection.

convert_sender_to_signerboolean

If any sender fields are left blank, convert them to fields for the first recipient.

footerstring

Text doc only. The footer for the final pdf. Use keyword "default" to use group default footer.

footer_heightinteger

Text based doc only. Pixel height of PDF footer, if used. 1px = 0.025cm

headerstring

Text based doc only. The header for the final pdf. Use keyword "default" to use group header footer.

header_heightinteger

Text based doc only. Pixel height of final PDF footer, if used. 1px = 0.025cm

pdf_passwordstring

Set a password. Must be ascii encode-able, you must also set signature_type to 4 and choose a pdf_password_type.

pdf_password_type1 | 2

1 to store password, 2 for to delete from our records upon final signing.

pdftextobject

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.

redirectstring

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]

remindersstring

Put 'default' if you wish to use the default reminder schedule in the group (go to web app to set default schedule)

return_signer_linksboolean

Return document links for signers in the response BODY.

signers_in_orderboolean

Notify signers in their order sequence. If false all are notified simulataneously.

signertextobject

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.

strict_fieldsboolean

pdftext fails silently for invalid field value, set to true to return an error

tagstring
tag1string
tag2string
userstring uri

Assign document another user in the group. Defaults to API

templatestring uri

Resource URI of text template object. This call must contain either one of the attributes text, templatepdf, template.

Response

Success. Document URI will be in Location header. If return_signer_links was set to true, the body will contain a JSON dict containing the signing links.

signer_1string

Changes