Signature and Initials fields

Signature field - a type of field which can hold a signature (be signed).

Initials field - also a type of field which can hold a signature (be signed). It differs from a Signature field because it’s not legally binding. To add their Initials, Signers use the same instruments in signNow editor that they do to put a signature - draw, type, or upload.

There are two ways to add a Signature to a document: add a Signature field directly by making a PUT .../document/{document_id} request (case 1); or create a freeform invite - the signature field shows up only when the recipient opens the document (case 2).

Case 1 is described in this article. To add a Signature field, document owners should open fields array in the request body, add a field and specify its "type" parameter as "signature".

Case 2 is a part of the flow when the document owner (API user) creates a freeform invite for a document with no fields.

When the freeform invite has been created, API users get two arrays in the response: "signatures", which is empty, and "requests", which contains the details of the freeform invite.

Here’s a response example when a Signature field has been added to the document*.

*In this example we show the response to a GET .../document/{document_id} request. The response to a PUT .../document/{document_id} is only a document ID, e.g. "id": "3db38d8c1fdfca762b25d57d82b3cf327a65485e".

Response when a Signature field has been added to a document
{
  "signatures": [],
  "requests": [
    {
      "unique_id": "827a6dc8a83805f5969883304d2166b75ba19cf3",
      "id": "827a6dc8a83805f5969883304d2166b75ba19cf3",
      "user_id": "40204b3344984768bb16d61f8550f8b5edfd719a",
      "created": "1579090178",
      "originator_email": "document_owner@signnow.com",
      "signer_email": "signer1@gmail.com",
      "canceled": null,
      "redirect_uri": null
    }
  ]
}

In this example we use a document with no other fields or elements. Here, the "unique_id" and the "id" parameters stand for the object ID of the signature invite we’ve just created.

When the recipient signs this invite, the API user, a.k.a. the document owner, receives a new response. This time the "signatures" array contains a signature object and the "requests" array has the "signature_id" of the signature object.

Response when the Signer has signed and submitted the document
{
  "signatures": [
    {
      "id": "5cbcf9d0e5b0e77b78fef3202000220f01fea3cf",
      "user_id": "fdbf8063a803daa7ec0d0f6476e78c4aa445a86f",
      "signature_request_id": "827a6dc8a83805f5969883304d2166b75ba19cf3",
      "email": "signer1@gmail.com",
      "page_number": "0",
      "width": "141",
      "height": "42",
      "x": "372",
      "y": "448",
      "created": "1580125749",
      "data": "iVBORw0KGgoAAAANSUhEUg=="
    }
  ],
  "requests": [
    {
      "unique_id": "827a6dc8a83805f5969883304d2166b75ba19cf3",
      "id": "827a6dc8a83805f5969883304d2166b75ba19cf3",
      "user_id": "40204b3344984768bb16d61f8550f8b5edfd719a",
      "created": "1579090178",
      "originator_email": "document_owner@signnow.com",
      "signer_email": "signer1@gmail.com",
      "canceled": null,
      "redirect_uri": null,
      "signature_id": "5cbcf9d0e5b0e77b78fef3202000220f01fea3cf"
    }
  ]
}

Here is an example of

  • the request body when adding a Signature and an Initials field to a document;
  • the response when Signature and Initials fields have been successfully added (from GET .../document/{document_id});
  • the response when Signer has signed and filled in the Signature and Initials fields
Example with a Signature and an Initials field
{
  "fields": [
    {
      "page_number": 0,
      "type": "signature",
      "name": "SignatureName",
      "role": "Signer 1",
      "required": true,
      "height": 40,
      "width": 50,
      "x": 217,
      "y": 32
    },
    {
      "page_number": 0,
      "type": "initials",
      "name": "InitialsName",
      "role": "Signer 1",
      "label": "InitialsLabel",
      "required": true,
      "height": 52,
      "width": 33,
      "x": 300,
      "y": 443
    }
  ]
}