List E-Signature Documents

Retrives a list of e-signature documents

Responses

🟢200Success

application/json

Body

array of:

document

object (File)

required

Document requiring e-signature

string

required

name

string

required

File name

mime

string

required

File MIME type

annotationUrl

string <uri>

required

Open this URL in a browser to load an interactive session for adding/updating fields and annotations to document.

annotations

array[object (ContractAnnotation) {4}]

optional

Dynamic fields to be displayed in document during signing session

string

optional

type

enum<string>

required

Type of annotation

Allowed values:

stringnumberdate

defaultValue

string

optional

Default value to be displayed if annotation not overwritten.

layout

object (ContractItemLayout)

optional

Layout details for annotation placement in document.

fields

array[object (ContractFields) {5}]

optional

Fields that need to be filled in by signer

string

optional

type

enum<string>

required

Field/input type

Allowed values:

textsignaturecheckboxradioinitialsdate

placeholder

string

optional

Placeholder value to be displayed until field receives input.

assigned_to

object (Assignee)

optional

Recipient who the field is assigned to

layout

object (ContractItemLayout)

optional

Layout details for field placement in document.

Example

[
  {
    "document": {
      "id": "85254039-ee3a-40fa-81a1-17352349e29d",
      "name": "Contract1.pdf",
      "mime": "application/pdf"
    },
    "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
    "annotations": [
      {
        "type": "string",
        "defaultValue": "culpa dolore Ut",
        "layout": {
          "page": 0,
          "position": {
            "offset_x": -73994373.93888465,
            "offset_y": -31088295.653169945,
            "anchor_point": "TOP_LEFT"
          },
          "style": {
            "width": -94472045,
            "height": -24449689
          }
        }
      },
      {
        "type": "date",
        "defaultValue": "sed adipisicing officia occaecat sunt",
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 38843961.543317735,
            "offset_y": -7780903.133622095,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": 16046832,
            "height": 15070951
          }
        }
      }
    ],
    "fields": [
      {
        "type": "date",
        "placeholder": "ea",
        "assigned_to": {
          "email": "Susan_Hegmann78@yahoo.com",
          "firstName": "Nona",
          "lastName": "Borer"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 38265520.515842855,
            "offset_y": 19960268.751786098,
            "anchor_point": "TOP_RIGHT"
          },
          "style": {
            "width": -19328795,
            "height": 37937136
          }
        }
      }
    ]
  },
  {
    "document": {
      "id": "e552c62e-88dc-472e-8169-e32edfea2c99",
      "name": "acsi stillicidium tamquam",
      "mime": "video/ogg"
    },
    "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
    "annotations": [
      {
        "type": "number",
        "defaultValue": "et sunt quis",
        "layout": {
          "page": 0,
          "position": {
            "offset_x": -56973559.678806975,
            "offset_y": -47695922.56525152,
            "anchor_point": "TOP_RIGHT"
          },
          "style": {
            "width": -736468,
            "height": -87786077
          }
        }
      }
    ],
    "fields": [
      {
        "type": "signature",
        "placeholder": "reprehenderit labore et",
        "assigned_to": {
          "email": "Bud_Ondricka@gmail.com",
          "firstName": "Brock",
          "lastName": "Adams"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 51763752.15388176,
            "offset_y": 509791.1066867858,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": -87863581,
            "height": 91299564
          }
        }
      },
      {
        "type": "radio",
        "placeholder": "ut ea eu",
        "assigned_to": {
          "email": "Toby.Reichert2@yahoo.com",
          "firstName": "Lavern",
          "lastName": "Kiehn"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 24851335.357309476,
            "offset_y": -33713777.0182002,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": 82919657,
            "height": -94915948
          }
        }
      },
      {
        "type": "date",
        "placeholder": "irure anim in deserunt",
        "assigned_to": {
          "email": "Lionel_Kassulke@yahoo.com",
          "firstName": "Bruce",
          "lastName": "Pouros"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 70611552.28405055,
            "offset_y": -93751679.99568559,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": -96304753,
            "height": -52806417
          }
        }
      }
    ]
  },
  {
    "document": {
      "id": "e320d7e3-13ab-45ee-98dd-eb960a19a490",
      "name": "Contract2.pdf",
      "mime": "application/pdf"
    },
    "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
    "annotations": [
      {
        "type": "date",
        "defaultValue": "proident velit",
        "layout": {
          "page": 0,
          "position": {
            "offset_x": -33980401.660871975,
            "offset_y": -38871429.48270945,
            "anchor_point": "TOP_LEFT"
          },
          "style": {
            "width": -38905962,
            "height": 998483
          }
        }
      }
    ],
    "fields": [
      {
        "type": "signature",
        "placeholder": "reprehenderit ut Lorem adipisicing",
        "assigned_to": {
          "email": "Osborne.Tromp44@gmail.com",
          "firstName": "Ena",
          "lastName": "Kuhn"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": -17742159.428952456,
            "offset_y": -19504204.764516726,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": -6134430,
            "height": -28455325
          }
        }
      },
      {
        "type": "date",
        "placeholder": "Ut quis id et",
        "assigned_to": {
          "email": "Kaylee_McLaughlin39@gmail.com",
          "firstName": "Minnie",
          "lastName": "Hintz"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": -26103435.980970874,
            "offset_y": 98288925.9994848,
            "anchor_point": "BOTTOM_LEFT"
          },
          "style": {
            "width": -63000837,
            "height": -74144623
          }
        }
      },
      {
        "type": "initials",
        "placeholder": "culpa dolore eiusmod ut",
        "assigned_to": {
          "email": "Patrick92@yahoo.com",
          "firstName": "Lucious",
          "lastName": "Tromp-Wilkinson"
        },
        "layout": {
          "page": 0,
          "position": {
            "offset_x": 49086729.71309164,
            "offset_y": -83220811.97192195,
            "anchor_point": "TOP_RIGHT"
          },
          "style": {
            "width": -26465129,
            "height": 63223012
          }
        }
      }
    ]
  }
]

List E-Signature Documents

Request

Request samples

Responses