activate_signature_request | Activate a draft signature request: it moves to “ongoing” and signers are notified according to its delivery mode. Arguments: signatureRequestId (UUID string, in the path), sender_id (UUID string of an active user of the request’s workspace, optional — only when the request’s e-mail sender type is “user”). |
add_signer | Add a signer to a draft signature request. Arguments: signatureRequestId (UUID string, in the path), info (object {first_name: string, last_name: string, email: string, locale: string enum en|fr|de|it|nl|es|pl|pt|ro — all four required; phone_number: string in E.164 such as “+33612345678”, optional}), signature_level (string enum: “electronic_signature” | “advanced_electronic_signature” | “qualified_electronic_signature”), signature_authentication_mode (string enum: “otp_email” | “otp_sms” | “no_otp”, optional), delivery_mode (string enum: “email” | “none”, optional, overrides the request’s), fields (array of objects, optional — signature field {document_id: UUID string, type: “signature”, page: integer ≥ 1, x: integer, y: integer, width?: integer ≥ 85, height?: integer ≥ 37, reason?: string} or mention field {document_id, type: “mention”, page, x, y, mention: string, width?, height?, name?}), redirect_urls (object {success?: string URL, error?: string URL, decline?: string URL}, optional), insert_after_id (UUID string of the recipient this one must follow when ordered_signers is enabled, optional). |
cancel_signature_request | Cancel an ongoing signature request. Arguments: signatureRequestId (UUID string, in the path), reason (string enum, required: “contractualization_aborted” | “errors_in_document” | “other”), custom_note (string, max 500, Safe String, optional). |
create_signature_request | Create a signature request in draft status. Arguments: name (string, 1–128, Safe String: no leading/trailing space, no HTML tag, no URL, no e-mail), delivery_mode (string enum: “email” | “none”), template_id (UUID string, optional), timezone (tz database string, e.g. “Europe/Paris”, optional), expiration_date (string “yyyy-mm-dd”, optional), ordered_signers (boolean, optional), signers_allowed_to_decline (boolean, optional), reminder_settings (object {interval_in_days: integer 1|2|7|14, max_occurrences: integer 1–10}, both required when present, optional), audit_trail_locale (string enum: de|en|es|fr|it|pt|ro, optional), custom_experience_id (UUID string, optional), workspace_id (UUID string, optional), external_id (string, max 255, characters [A-Za-z0-9_-@.%+], optional). Documents and signers are added afterwards, then activate_signature_request sends it. |
send_reminder | Send a manual reminder e-mail to one signer of an ongoing signature request. Arguments: signatureRequestId (UUID string, in the path), signerId (UUID string, in the path). |
