Send Digital Signature

Use POST /api/v1/generate with a template that defines the intended signers and a digital_signature destination:

{
  "template_id": "tmpl_REPLACEWITHYOURTEMPLATEID",
  "merge_parameters": {},
  "destinations": {
    "digital_signature": {
      "order": "In order",
      "signers": [
        {
          "signer_number": 1,
          "signer_name": "Example Signer",
          "email": "[email protected]",
          "can_skip": false,
          "can_reassign": false
        }
      ]
    }
  }
}

Replace the example address with your intended recipient before sending. This example requires a template with signer number 1.

• order accepts In order or All at once.
• Each signer needs a unique signer_number matching the template's signers. Provide email and signer_name, or a signing group through signing_group_id or group_name.
• Do not combine email and group identifiers. If you provide both group name and ID, they must identify the same group.
• Optional signing_round is a positive integer. responsibility accepts none, concur, or approve.
• At least one signer must have can_skip set to false.
• BCC recipients must not duplicate signer or BCC emails or groups.
• Do not combine digital signatures with inkit_storage.retain_for or expire_after_n_views.

email_subject (up to 100 characters) and email_body (up to 2,000 characters) are applied only when custom signature request emails are enabled for the account. reference_field must resolve to a signer input on the template.

The response can include digital_signature_item_id. Retrieve structured signature metadata with GET /api/v1/digital-signature/metadata/{public_id}. Pass the digital_signature_item_id (dsi_...) to this operation. The response contains signers, requester, and document.

Signer-facing public links and browser signing-session endpoints are separate flows; their URLs do not establish API-key support.