SignatureRequest
One request to have a document signed: what is to be signed, how, who asked, and how far the signing has got (`state` and `signature_counts`). Visible when its document is readable by the caller. The `status` column, the hash and the DocuSign recipients and placed fields are not exposed.
idrequiredstring (uuid)- The signature request's id.
document_idrequiredstring (uuid)- The document that is to be signed.
folder_idrequiredstring | null (uuid)- The folder the request was made on, such as a deal's signatures folder, or null when it was made on the document alone.
typerequiredstring- How the document is signed: wet_ink, electronic, soft, esig_connective, esig_connective_single or esig_docusign.One of: wet_ink, electronic, soft, esig_connective, esig_connective_single, esig_docusign
strategyrequiredstring | null- one_for_all: every signatory signs. open: any one of the signatories may sign for the rest.One of: one_for_all, open
staterequiredstring- Where the request stands, worked out from its live signatures: not_started, awaiting_signatures, awaiting_review or completed. Signatures that are not_required or withdrawn are ignored; a signature with no status counts as not_initialised. not_started when none of the counted signatures is past not_initialised or initialising, or there are none; completed when every one is verified; awaiting_review when every one is signed or verified; otherwise awaiting_signatures.One of: not_started, awaiting_signatures, awaiting_review, completed
signature_countsrequiredobject- How many live signatures the request has in each status, such as {"pending":1,"signed":2}. Only statuses that occur are listed, a signature with no status counts as not_initialised, and the object is empty when the request has no signatures.
requested_byrequiredobject- Who asked for the signatures. Both parts are null when the request has no recorded requester.
originrequiredstring | null- What started the request, such as a workflow, or null when it has no recorded origin.
docusign_template_idsrequiredstring[]- The DocuSign template ids the envelope was built from. Empty unless the type is esig_docusign.
docusign_template_onlyrequiredboolean | null- Whether the DocuSign envelope uses only the templates' own recipients and fields. Null when not set.
docusign_require_2farequiredboolean | null- Whether DocuSign makes signatories confirm with two-factor authentication. Null when not set.
created_atrequiredstring (date-time)- When the request was made.
updated_atrequiredstring (date-time)- When the request last changed.