envelope

Prepare a document for signature

Use this to send a document for signature. Makes a draft envelope: the document's current version, the people who sign it and their signature fields. i_sign adds the person you work for as the last signer, after the others. Nothing is sent until the person taps Send on the card that shows it.

post/documents/{document_id}/envelopes

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/documents/{document_id}/envelopes
  • Auth: HTTP bearer

Path parameters

document_idstring required

From document_list or document_add.

Request body

i_signboolean

The person you work for signs too, last.

messagestring

A note in the signing email, in the person's words.

fields'detect' | 'signature_page'

detect finds the signature lines; signature_page adds a page of blocks instead.

accept_proposed_fieldsboolean

Keep the found fields that name their signer; drop the rest.

template_idstring

One of the document's templates from document_list. Signers fill its roles in order; it sets the fields.

Response

The result.

idstring required
document_idstring required
version_idstring required
titlestring required
messagestring nullable required
status'draft' | 'sent' | 'completed' | 'declined' | 'voided' | 'expired' required
orderedboolean required
pagesinteger required
signature_pageboolean required
urlstring required
codestring nullable required
result_sha256string nullable required
created_atstring date-time required
sent_atstring date-time nullable required
completed_atstring date-time nullable required
voided_atstring date-time nullable required
expires_atstring date-time nullable required
reminded_atstring date-time nullable required
needs_reviewboolean required
exclusion_overridestring nullable required
hold'funding' nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.