autessa.eSignature
E-signature envelopes, templates, and signer flows.
autessa.eSignature.companyMembersREAD
autessa.eSignature.companyMembers({ search, limit })Search company members to use as share targets or template-role recipients.
Returns members of your current company matching search, capped at limit. Useful for resolving a userId to grant access, or an email/name for a recipient. Read-only despite the POST shape.
Request fields
- Name
search- Type
- string
- Description
- Name
limit- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
members- Type
- CompanyMemberDto[]
- Description
autessa.eSignature.envelope.createMUTATE
autessa.eSignature.envelope.create({ title, s3Uri })Create a DRAFT envelope from an uploaded PDF.
Ingests the PDF at s3Uri (upload it first via eSignature.generateFileUploadLink) into a new DRAFT envelope owned by you, with signingOrder PARALLEL. s3Uri is effectively required (a failed ingest returns an error); title is optional and defaults to "Untitled document". Next add recipients and fields, then send.
Request fields
- Name
title- Type
- string
- Description
- Name
s3Uri- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.deleteMUTATE
autessa.eSignature.envelope.delete({ envelopeId })Permanently delete a DRAFT or VOIDED envelope.
Irreversible. Only DRAFT or VOIDED envelopes can be deleted (a SENT/COMPLETED envelope must be voided first). Requires ADMIN access.
Request fields
- Name
envelopeId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
autessa.eSignature.envelope.downloadMUTATE
autessa.eSignature.envelope.download({ envelopeId })Get a presigned download URL for an envelope's document (sealed PDF when completed, else an in-progress copy).
When the envelope is COMPLETED and sealed, returns the sealed PDF; otherwise renders an in-progress copy with a signing-status report page. Requires READ access; rejects DRAFT envelopes (not yet sent). The URL expires in 900 seconds.
Request fields
- Name
envelopeId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
url- Type
- string
- Description
- Name
expiresInSeconds- Type
- number
- Description
- Name
filename- Type
- string
- Description
autessa.eSignature.envelope.fieldsMUTATE
autessa.eSignature.envelope.fields({ envelopeId, fields })Set an envelope's fields, assigning each signer field to a recipient (DRAFT only).
Replaces the envelope's fields. Each SIGNER field (fillSource SIGNER) must carry a recipientId of an existing recipient; PREFILL fields carry no recipient and are filled by the owner before send. Field geometry is page-relative (xPct/yPct/widthPct/heightPct in 0..1). Requires WRITE access; envelope must be DRAFT. Assign at least one field to every SIGNER here: send validation requires that fields have a valid recipient AND that every signer has at least one field, so a signer left field-less here will block eSignature.envelope.send until you assign them a field or change their role to viewer.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
fields- Type
- FieldInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.getREAD
autessa.eSignature.envelope.get({ envelopeId })Fetch an envelope's full state: recipients, fields, audit trail, sharing, and your access level.
Requires READ access. This is the primary way to poll progress: watch the envelope status (SENT to COMPLETED/REJECTED) and each recipient's status and signedAt. viewPdfUrl is a short-lived presigned URL of the current-state PDF.
Request fields
- Name
envelopeId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.listREAD
autessa.eSignature.envelope.list({ statusFilter, search, sortBy, sortDir, page, pageSize })List envelopes you can access in the company, filterable by status and search, with pagination and sorting.
Returns lightweight envelope summaries with cheap progress counters (requiredSignatureCount/collectedSignatureCount, recipientCount/completedRecipientCount). statusFilter narrows by status; page is 0-based. sortBy/sortDir control ordering (default sort is by lastActivityAt).
Request fields
- Name
statusFilter- Type
- "DRAFT" | "SENT" | "COMPLETED" | "REJECTED" | "VOIDED" | "EXPIRED"[]
- Description
- Name
search- Type
- string
- Description
- Name
sortBy- Type
- string
- Description
- Name
sortDir- Type
- string
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelopes- Type
- EnvelopeSummaryDto[]
- Description
- Name
total- Type
- number
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
autessa.eSignature.envelope.prefillMUTATE
autessa.eSignature.envelope.prefill({ envelopeId, values })Set the values of an envelope's PREFILL fields before sending (DRAFT only).
Sets value (and/or valueImageS3Key for IMAGE_STATIC fields, uploaded via eSignature.generateFileUploadLink) on the referenced fields. Only fields whose fillSource is PREFILL are updated; others are ignored. At send, prefilled values are burned into the PDF. Requires WRITE access; envelope must be DRAFT.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
values- Type
- PrefillValueInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.recipientsMUTATE
autessa.eSignature.envelope.recipients({ envelopeId, signingOrder, completionPolicy, recipients })Set an envelope's recipients, signing order, and completion policy (DRAFT only).
Replaces the envelope's recipient list. Each recipient is a SIGNER or VIEWER; VIEWERs are CC'd and never sign. recipients sharing a signingGroup are alternates for one signing slot. signingOrder is PARALLEL or SEQUENTIAL; completionPolicy is ALL (every slot must sign) or ANY_ONE (any single slot completes it) — ANY_ONE is incompatible with SEQUENTIAL. Requires WRITE access; envelope must be DRAFT. After setting recipients, assign at least one field to every SIGNER via eSignature.envelope.fields — eSignature.envelope.send rejects any envelope with a field-less signer.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
signingOrder- Type
- "PARALLEL" | "SEQUENTIAL"
- Description
- Name
completionPolicy- Type
- "ALL" | "ANY_ONE"
- Description
- Name
recipients- Type
- RecipientInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.remindMUTATE
autessa.eSignature.envelope.remind({ envelopeId, recipientIds })Email reminders to an envelope's pending signers (SENT only).
Sends a reminder to each still-awaiting-signature recipient, rotating their signing token (older links stop working). recipientIds narrows to specific recipients; omit for all pending. Under SEQUENTIAL only the current-turn slot is reminded. VIEWERs are excluded. Requires PUBLISH access; envelope must be SENT.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
recipientIds- Type
- string[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.resendLinkMUTATE
autessa.eSignature.envelope.resendLink({ envelopeId, recipientId })Re-send the signing link email to one recipient (SENT only).
Re-issues the signing invitation to the given recipient. Requires PUBLISH access; envelope must be SENT.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
recipientId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.sealMUTATE
autessa.eSignature.envelope.seal({ envelopeId })Seal a SENT envelope with the signatures collected so far, completing it early.
Declares the envelope executed: remaining awaiting-signature recipients become NOT_REQUIRED, the sealed PDF (with a certificate of completion) is finalized, and status becomes COMPLETED. Requires PUBLISH access; the envelope must be SENT and at least one recipient must already have signed. Retrieve the sealed PDF via eSignature.envelope.download.
Request fields
- Name
envelopeId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.sendMUTATE
autessa.eSignature.envelope.send({ envelopeId, linkTtlDays })Send a DRAFT envelope: render the prefilled PDF, mint signer links, and email invitations.
Moves the envelope DRAFT to SENT, sets expiresAt from linkTtlDays (or the configured default). PARALLEL emails all signers at once; SEQUENTIAL emails only the current slot; VIEWERs are CC'd immediately. Requires PUBLISH access. Send validation requires: at least one signer recipient, at least one SIGNER field, every SIGNER field assigned to a valid recipient, every PREFILL field to have a value, and every signer to have at least one field (a field on any member of a signer slot covers the whole slot; viewers are exempt). If any signer is field-less the send is rejected and the error names them — assign them a field or change their role to viewer, then retry. After sending, poll eSignature.envelope.get for status.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
linkTtlDays- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.envelope.viewMUTATE
autessa.eSignature.envelope.view({ envelopeId })Get a short-lived presigned URL to view an envelope's current-state PDF.
Returns a presigned URL of the current-state document (sealed if completed, else prefilled, else original). Requires READ access. The URL expires in 900 seconds.
Request fields
- Name
envelopeId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
pdfUrl- Type
- string
- Description
- Name
expiresInSeconds- Type
- number
- Description
autessa.eSignature.envelope.voidMUTATE
autessa.eSignature.envelope.void({ envelopeId, reason })Void a SENT envelope, invalidating all signing links.
Cancels the envelope (status VOIDED); signers can no longer sign and are notified. reason is recorded on the audit trail. Requires PUBLISH access; envelope must be SENT.
Request fields
- Name
envelopeId- Type
- string
- Description
- Name
reason- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.generateFileUploadLinkMUTATE
autessa.eSignature.generateFileUploadLink({ fileExtension })Generate a presigned S3 PUT URL for uploading a source PDF (or a field image); PUT the bytes, then pass the returned s3Uri into create/prefill.
Send fileExtension (e.g. pdf for a source document, png for an IMAGE_STATIC field). PUT the bytes to uploadUrl, then reference s3Uri in eSignature.envelope.create (source PDF), eSignature.template.create, or eSignature.envelope.prefill (field image). The URL expires shortly.
Request fields
- Name
fileExtension- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
uploadUrl- Type
- string
- Description
- Name
s3Uri- Type
- string
- Description
- Name
mimeType- Type
- string
- Description
- Name
expiresInSeconds- Type
- number
- Description
autessa.eSignature.inbox.listREAD
autessa.eSignature.inbox.list({ statusFilter, page, pageSize })List envelopes in which you are a recipient (your signing inbox), paginated.
Returns envelope summaries where your email is a recipient in the current company. statusFilter narrows by status; page is 0-based.
Request fields
- Name
statusFilter- Type
- "DRAFT" | "SENT" | "COMPLETED" | "REJECTED" | "VOIDED" | "EXPIRED"[]
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelopes- Type
- EnvelopeSummaryDto[]
- Description
- Name
total- Type
- number
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
autessa.eSignature.template.createMUTATE
autessa.eSignature.template.create({ title, description, s3Uri, signingOrder, completionPolicy })Create a reusable signing template from an uploaded PDF.
Creates a template owned by you from the PDF at s3Uri (upload via eSignature.generateFileUploadLink). signingOrder and completionPolicy become the defaults for envelopes instantiated from it. Next define roles with eSignature.template.roles and role-assigned fields with eSignature.template.fields.
Request fields
- Name
title- Type
- string
- Description
- Name
description- Type
- string
- Description
- Name
s3Uri- Type
- string
- Description
- Name
signingOrder- Type
- "PARALLEL" | "SEQUENTIAL"
- Description
- Name
completionPolicy- Type
- "ALL" | "ANY_ONE"
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
template- Type
- TemplateDto
- Description
autessa.eSignature.template.createEnvelopeMUTATE
autessa.eSignature.template.createEnvelope({ templateId, title, roleAssignments })Instantiate a DRAFT envelope from a template by mapping each role to real recipients.
Clones the template PDF, roles, and fields into a new DRAFT envelope, wiring each role's fields to its primary recipient. Every role must be assigned at least one recipient with a non-blank email. Only READ access on the template is needed. The result is a normal DRAFT envelope you then send with eSignature.envelope.send.
Request fields
- Name
templateId- Type
- string
- Description
- Name
title- Type
- string
- Description
- Name
roleAssignments- Type
- RoleAssignmentInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
envelope- Type
- EnvelopeDto
- Description
autessa.eSignature.template.deleteMUTATE
autessa.eSignature.template.delete({ templateId })Permanently delete a template.
Irreversible. Requires ADMIN access. Envelopes already created from the template are unaffected.
Request fields
- Name
templateId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
autessa.eSignature.template.fieldsMUTATE
autessa.eSignature.template.fields({ templateId, fields })Set a template's fields, assigning each signer field to a role.
Replaces the template's fields. Each SIGNER field carries a roleId of an existing template role; a SIGNER field with a missing/invalid roleId is rejected. Give every role at least one field: an instantiated envelope routes through the same send validation, so a role with no fields becomes a field-less signer that eSignature.envelope.send will reject. Requires WRITE access.
Request fields
- Name
templateId- Type
- string
- Description
- Name
fields- Type
- TemplateFieldInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
template- Type
- TemplateDto
- Description
autessa.eSignature.template.getREAD
autessa.eSignature.template.get({ templateId })Fetch a template's full definition: roles, fields, sharing, and your access level.
Requires READ access. Returns the template's roles and role-assigned fields, ready to instantiate with eSignature.template.createEnvelope.
Request fields
- Name
templateId- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
template- Type
- TemplateDto
- Description
autessa.eSignature.template.listREAD
autessa.eSignature.template.list({ search, page, pageSize })List templates you can access in the company, with search and pagination.
Returns template summaries (role/field counts, sharing). search narrows by title; page is 0-based.
Request fields
- Name
search- Type
- string
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
templates- Type
- TemplateSummaryDto[]
- Description
- Name
total- Type
- number
- Description
- Name
page- Type
- number
- Description
- Name
pageSize- Type
- number
- Description
autessa.eSignature.template.rolesMUTATE
autessa.eSignature.template.roles({ templateId, roles })Set a template's signer roles (the named slots recipients are assigned to at instantiation).
Replaces the template's roles. Each role is a named signing slot; roles sharing a signingGroup are alternates. Template fields are assigned to roles (not people), and eSignature.template.createEnvelope maps each role to real recipients. Requires WRITE access.
Request fields
- Name
templateId- Type
- string
- Description
- Name
roles- Type
- TemplateRoleInput[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
template- Type
- TemplateDto
- Description