Pigeon
  1. E-Signature / Document Forms
Pigeon
  • Introduction
  • Authentication
  • Integrations
  • Webhooks
  • Guides
    • How To Share Files via Pigeon
    • How To Create an E-Signature Request Item
    • How To Send Emails from Organization Addresses
  • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • Delete Request
      DELETE
    • Update Request
      PATCH
    • Verify Request
      POST
    • Close Request
      POST
    • Duplicate Request
      POST
    • Reject Request (Request Changes)
      POST
    • Send Request Reminder
      POST
    • List Request Reminders
      GET
    • Get Request Activity Log
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Request Items
    • List Request Items
    • Get Request Item
    • Verify Request Item
    • Update Request Item
    • Delete Request Item
    • Create Request Item
  • Templates
    • Create Template
    • List Templates
    • Get Template
    • Delete Template
    • Update Template
    • List Organization Templates
  • Webhooks
    • Create Webhook Subscription
    • Get Webhook Subscription
    • List Webhook Subscriptions
    • Update Webhook Subscription
    • Delete Webhook Subscription
  • Files
    • Download Request Files
    • Download Request Item Files
    • Download File
    • Get Request Files
    • Get Request Item Files
    • Delete File
  • Request Attachments
    • Upload Attachment
    • List Item Attachments
    • Get Attachment
    • Download Attachment
    • Delete Attachment
  • File Sharing
    • Initialize File Sharing Session
    • Upload File
    • Share Files
    • List File Sharing Sessions
    • Get File Sharing Session
    • Update File Sharing Session
    • Delete File Sharing Session
  • E-Signature / Document Forms
    • Create New E-Signature Document
      POST
    • Update E-Signature Document
      PATCH
    • Get E-Signature Document
      GET
    • List E-Signature Documents
      GET
    • Delete E-Signature Document
      DELETE
  • Users
    • List Users
    • Get User
    • Get Current User
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  • Organization
    • Get Organization Settings
    • Update Organization Settings
  • RequestItems
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Documents
    • Get Document
    • Delete Document
    • List Request Documents
    • Delete Request Documents
    • List Request Item Documents
    • Download Document
    • Download Request Documents
    • Download Request Item Documents
  1. E-Signature / Document Forms

Create New E-Signature Document

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

Request

Body Params application/octet-stream
Uploaded File

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/contracts' \
--header 'Content-Type: application/octet-stream' \
--data-binary '@cmMtdXBsb2FkLTE3Mjc3ODY5MDU2NDgtOA==/dummy.pdf'

Responses

🟢201Created
application/json
Body
document
object (File) 
required
Document requiring e-signature
id
string 
required
ID
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
id
string 
optional
ID
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
id
string 
optional
ID
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
Modified at 2024-10-29 16:11:39
Previous
Delete File Sharing Session
Next
Update E-Signature Document