Use DocuSign to send envelopes for e-signature, create them from templates, inspect recipients and signing status, and download completed documents. Pending envelopes can be voided with a reason.
Sim requests these scopes when someone connects a DocuSign account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
Setting Value Redirect URI <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/docusignEnvironment variables DOCUSIGN_CLIENT_ID, DOCUSIGN_CLIENT_SECRET
Scope Description signatureSend, track, and manage envelopes with the eSignature API extendedKeep access active by extending the refresh token lifetime
Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.
Create and send a DocuSign envelope with a document for e-signature
Parameter Type Required Description emailSubjectstring Yes Email subject for the envelope emailBodystring No Email body message signerEmailstring Yes Email address of the signer signerNamestring Yes Full name of the signer ccEmailstring No Email address of carbon copy recipient ccNamestring No Full name of carbon copy recipient filefile No Document file to send for signature statusstring No Envelope status: "sent" to send immediately, "created" for draft (default: "sent")
Parameter Type Description envelopeIdstring Created envelope ID statusstring Envelope status statusDateTimestring Status change datetime uristring Envelope URI
Create and send a DocuSign envelope using a pre-built template
Parameter Type Required Description templateIdstring Yes DocuSign template ID to use emailSubjectstring No Override email subject (uses template default if not set) emailBodystring No Override email body message templateRolesstring Yes JSON array of template roles, e.g. [{"roleName":"Signer","name":"John","email":"john@example.com "}] statusstring No Envelope status: "sent" to send immediately, "created" for draft (default: "sent")
Parameter Type Description envelopeIdstring Created envelope ID statusstring Envelope status statusDateTimestring Status change datetime uristring Envelope URI
Get the details and status of a DocuSign envelope
Parameter Type Required Description envelopeIdstring Yes The envelope ID to retrieve
Parameter Type Description envelopeIdstring Envelope ID statusstring Envelope status (created, sent, delivered, completed, declined, voided) emailSubjectstring Email subject line sentDateTimestring When the envelope was sent completedDateTimestring When all recipients completed signing createdDateTimestring When the envelope was created statusChangedDateTimestring When the status last changed voidedReasonstring Reason the envelope was voided signerCountnumber Number of signers documentCountnumber Number of documents
List envelopes from your DocuSign account with optional filters
Parameter Type Required Description fromDatestring No Start date filter (ISO 8601). Defaults to 30 days ago toDatestring No End date filter (ISO 8601) envelopeStatusstring No Filter by status: created, sent, delivered, completed, declined, voided searchTextstring No Search text to filter envelopes countstring No Maximum number of envelopes to return (default: 25)
Parameter Type Description envelopesarray Array of DocuSign envelopes ↳ envelopeId string Unique envelope identifier ↳ status string Envelope status (created, sent, delivered, completed, declined, voided) ↳ emailSubject string Email subject line ↳ sentDateTime string ISO 8601 datetime when envelope was sent ↳ completedDateTime string ISO 8601 datetime when envelope was completed ↳ createdDateTime string ISO 8601 datetime when envelope was created ↳ statusChangedDateTime string ISO 8601 datetime of last status change totalSetSizenumber Total number of matching envelopes resultSetSizenumber Number of envelopes returned in this response
Void (cancel) a sent DocuSign envelope that has not yet been completed
Parameter Type Required Description envelopeIdstring Yes The envelope ID to void voidedReasonstring Yes Reason for voiding the envelope
Parameter Type Description envelopeIdstring Voided envelope ID statusstring Envelope status (voided)
Download a signed document from a completed DocuSign envelope
Parameter Type Required Description envelopeIdstring Yes The envelope ID containing the document documentIdstring No Specific document ID to download, or "combined" for all documents merged (default: "combined")
Parameter Type Description filefile Stored downloaded document file base64Contentstring Deprecated legacy inline content. New downloads return file. mimeTypestring MIME type of the document fileNamestring Original file name
List available templates in your DocuSign account
Parameter Type Required Description searchTextstring No Search text to filter templates by name countstring No Maximum number of templates to return
Parameter Type Description templatesarray Array of DocuSign templates ↳ templateId string Template identifier ↳ name string Template name ↳ description string Template description ↳ shared boolean Whether template is shared ↳ created string ISO 8601 creation date ↳ lastModified string ISO 8601 last modified date totalSetSizenumber Total number of matching templates resultSetSizenumber Number of templates returned in this response
Get the recipient status details for a DocuSign envelope
Parameter Type Required Description envelopeIdstring Yes The envelope ID to get recipients for
Parameter Type Description signersarray Array of DocuSign recipients ↳ recipientId string Recipient identifier ↳ name string Recipient name ↳ email string Recipient email address ↳ status string Recipient signing status (sent, delivered, completed, declined) ↳ signedDateTime string ISO 8601 datetime when recipient signed ↳ deliveredDateTime string ISO 8601 datetime when delivered to recipient carbonCopiesarray Array of carbon copy recipients ↳ recipientId string Recipient ID ↳ name string Recipient name ↳ email string Recipient email ↳ status string Recipient status