Send Digital Signature

Digital Signature

You specify data related to a Digital Signature destination in a subobject called digital_signature, that lives inside destinations which has the following properties:

Property	Type	Required	Description
`order`	String	No	Whether the routing of the generated document to signers is `ordered` or `unordered`.
`signers`	Object[]	Yes	An array of signers of the generated document.
`bcc`	Object[]	No	An array of people receiving a copy of the generated document.

`signers`

Property	Type	Required	Description
`signer_number`	Integer	Yes	The signer number.
`full_name`	String	Yes	The full name of the signer.
`email`	String	Yes	The email address of the signer.

`bcc`

Property	Type	Required	Description
`full_name`	String	Yes	The full name of the person receiving a copy of the generated document.
`email`	String	Yes	The email address of the person receiving a copy of the generated document.

Endpoints

Digital Signature is currently only supported for DOD, so only these two endpoints are available.

IL4: https://inkit.il4.afwerx.dso.mil/api/v1/documents/generate

IL5: https://inkit.il5.afwerx.dso.mil/api/v1/documents/generate

Body

The following is an example request body for sending a document for signature using a template.

{
  "merge_parameters": {
    "merge_key": "merge_value"
  },
  "destinations": {
    "inkit_storage": {
      "folder_id": "fold_123",
      "name": "my_signed_document"
    },
    "digital_signature": {
      "order": "ordered",
      "signers": [{
          "signer_number": 2,
          "full_name": "John Doe",
          "email": "doe@example.com",
        },
        {
          "signer_number": 1,
          "full_name": "Sally Smith",
          "email": "smith@example.com",
        }],
      "bcc": [{
        "full_name": "Tom Jones",
        "email": "jones@example.com"
      }],
    }
  }
}