D4Sign icon

D4Sign

Interact with the D4Sign API

Signatory → Add Signatory

AI-generated

Summary

Add a new signatory to a document by providing the document UUID, the signatory's email, and signature role along with various optional details affecting signature requirements and authentication.

Inputs

  • Document UUID (required) — The UUID of the document to which the signatory will be added.
  • Email (required) — Email address of the signatory.
  • Action (act) (required) — Signature action or role of the signatory, such as Sign, Approve, or Acknowledge.
  • Foreign (required) — Indicates whether the signer has a Brazilian CPF (0) or is foreign without CPF (1).
  • Foreign Language — Language preference for foreign signers' flows, applicable when Foreign is set to 'No CPF (Foreign)'. Options: Portuguese, English, Spanish.
  • ICP-Brasil Certificate (required) — Whether the signer uses an ICP-Brasil certificate (1) or a standard D4Sign signature (0).
  • In-person Signature (required) — Indicates if the signature will be in-person (1) or not (0).
  • Require Document Photo (docauth) — Optionally require the signer to provide a document photo for authentication.
  • Require Document + Selfie (docauthandselfie) — Optionally require the signer to provide both a document photo and a selfie.
  • Embedded Auth Method — Authentication method for embedded signature flows: Email, Password, SMS, or WhatsApp.
  • Embedded SMS/Whats Number — Phone number used for SMS or WhatsApp authentication, required if the corresponding embedded auth method is selected.
  • Allow Uploads From Signer — Optionally allow the signer to upload additional documents.
  • Upload Instructions — Instructions to the signer regarding which documents to upload, shown if uploads are allowed.
  • WhatsApp Number — Optional WhatsApp number for signature notifications.
  • Group UUID (uuid_grupo) — Optionally specify a signature group UUID instead of individual signer settings.
  • Password Code — Optional access code for the signer.
  • Skip Email — Optionally skip sending email notifications to the signer.

Output shape

a single JSON object representing the API response to adding the signatory

Returns D4Sign API response data confirming the addition or error details. No pagination applies as it is a single operation per run.

Examples

Example 1: Adding a signatory to a document

Provide the document UUID, the signatory email, select the action role (e.g. Sign), and specify mandatory flags such as foreign status, ICP-Brasil certificate requirement, and signature type. Optionally configure authentication method, upload permissions, WhatsApp number, and email notification preferences to tailor the signatory's signing experience.

Links

Discussion