latestOpenAPI 3.0.02026-08-081631260.8 KB

ae9d64e51a99

Documents

Send a document for signature

Sends a document in a draft state specified by ID

post/documents/{id}/send

Path parameters

idstring uuid required
Example:1e013958-867e-43fb-8210-c98ab139beb6

Document ID

Request body

autosignboolean

Whether to automatically sign the document by the sending party during sending.

This flag will work only if owner of the account which holds the API key is one of the signees and:

  1. The order of signatures on the document is set to:
    • random.
    • strict and the owner is the first signee.
    • grouped and the owner is in the first group of signees.
  2. The owner signature method is any of the following:
    • SMS (sms)
    • sign with a click (basic)

Response

Document

Example response

{
  "document": {
    "attachments": [
      {
        "original": "https://example.com/image.png",
        "preview": [
          "https://example.com/preview.png"
        ]
      }
    ],
    "comments": [
      {
        "account": {
          "profile": {
            "full_name": "Jane Doe"
          }
        }
      }
    ],
    "language": "uk",
    "ocr_status": "pending",
    "owner": {
      "full_name": "Jane Doe"
    },
    "parties": [
      {
        "address": "123 Main Street",
        "name": "Jane Doe",
        "reference": "Sender",
        "signees": [
          {
            "full_name": "Jane Doe",
            "signature_verification_methods": [
              "sms",
              "basic",
              "wet_signature"
            ],
            "title": "Software Engineer"
          }
        ]
      }
    ],
    "signing_order_mode": "grouped",
    "tags": [
      "tags"
    ],
    "visibilities": [
      {
        "full_name": "Jane Doe"
      }
    ]
  }
}