Create New E-Signature Document

Create a new document for e-signature by uploading a file.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

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": "f16992a7-ff87-4b00-ae64-a999f13d1403",
    "name": "SignMe.pdf",
    "mime": "application/pdf"
  },
  "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
  "annotations": [
    {
      "type": "string",
      "defaultValue": "velit",
      "layout": {
        "page": 0,
        "position": {
          "offset_x": -60539841.60988639,
          "offset_y": 3963177.9090092033,
          "anchor_point": "TOP_LEFT"
        },
        "style": {
          "width": -66756283,
          "height": 81656173
        }
      }
    },
    {
      "type": "date",
      "defaultValue": "irure",
      "layout": {
        "page": 0,
        "position": {
          "offset_x": -14777911.942147434,
          "offset_y": 10951335.703829646,
          "anchor_point": "BOTTOM_RIGHT"
        },
        "style": {
          "width": 70890502,
          "height": 67779062
        }
      }
    },
    {
      "type": "number",
      "defaultValue": "in sunt mollit et",
      "layout": {
        "page": 0,
        "position": {
          "offset_x": -36367758.28152019,
          "offset_y": 18781084.66245605,
          "anchor_point": "BOTTOM_RIGHT"
        },
        "style": {
          "width": -84969928,
          "height": 55919615
        }
      }
    }
  ],
  "fields": [
    {
      "type": "initials",
      "placeholder": "veniam Lorem cillum Excepteur",
      "assigned_to": {
        "email": "Skyla.Mann86@gmail.com",
        "firstName": "Elnora",
        "lastName": "Cummings"
      },
      "layout": {
        "page": 0,
        "position": {
          "offset_x": 83148902.07392943,
          "offset_y": -6317848.638096988,
          "anchor_point": "BOTTOM_LEFT"
        },
        "style": {
          "width": -25387274,
          "height": 22069880
        }
      }
    },
    {
      "type": "initials",
      "placeholder": "consequat culpa",
      "assigned_to": {
        "email": "Hans57@hotmail.com",
        "firstName": "Camren",
        "lastName": "Denesik"
      },
      "layout": {
        "page": 0,
        "position": {
          "offset_x": -43086032.99965745,
          "offset_y": 82797232.86581287,
          "anchor_point": "BOTTOM_LEFT"
        },
        "style": {
          "width": -58515984,
          "height": -27609452
        }
      }
    }
  ]
}

🟠400Bad Request