Sign in
document

Create signing document

post/document/

Request body

groupstring uri required
namestring required
textstring

Raw html. This API call must contain either one of the attributes text, templatepdf, template.

templatepdfstring uri

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

templatestring uri

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

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.

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 field labels as keys. Requires unique fields labels. 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, using labels as keys in an object (as for pdftext). Relies on unique labelling.

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

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

Changed in 1 of the 5 revisions of this API.11

  • 02fb3694e91811See the full diff
    • ▲

      removed the media type example error report for the response with the status 400

      response-media-type-removed

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added