Submissions

Create submission

Send a template to one or more submitters for signing.

Quick Sign Mode: Set quick_sign_mode to enable streamlined signing flows. When using confirmation_modal, signers see a summary of pre-filled data and can confirm with a single click. Use review_and_sign to show a summary on the welcome screen.

Default behavior: If omitted, quick_sign_mode defaults to confirmation_modal. prefill_behavior defaults to:

skip_if_prefilled: true
editable_if_prefilled: false Set quick_sign_mode: normal to force legacy behavior.

Auto-Generated Signatures: When quick_sign_mode is not normal and a submitter has a name, any unfilled signature fields will be automatically populated with a typed signature image generated from the submitter’s name.

Cover Page: Pass a cover_page object to generate a branded PDF cover page prepended as page 0 of the signing package. The cover page is generated per submission with dynamic financial data (amounts, phases, company name). All monetary values are integers in whole dollars. Admin fees must be negative.

Start Screen Customization: Use template preferences to customize the signing welcome screen: disable_start_screen (skip directly to signing), start_screen_title, and start_screen_message.

POST

api

submissions

Error

A valid request URL is required to generate request examples

{
  "id": 123,
  "slug": "<string>",
  "source": "<string>",
  "status": "<string>",
  "template_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expire_at": "2023-11-07T05:31:56Z",
  "submitters": [
    {
      "id": 123,
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "role": "<string>",
      "submission_id": 123,
      "opened_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "phone": "<string>",
      "external_id": "<string>",
      "values": {},
      "metadata": {},
      "preferences": {},
      "declined_at": "2023-11-07T05:31:56Z",
      "documents": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "submission_events": [
        {}
      ],
      "template": {
        "id": 123,
        "name": "<string>"
      },
      "submission": {
        "id": 123,
        "slug": "<string>",
        "status": "<string>"
      }
    }
  ],
  "audit_log": [
    {}
  ],
  "metadata": {},
  "template": {
    "id": "<string>",
    "name": "<string>",
    "schema": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "required": true,
        "readonly": true,
        "key": "<string>",
        "default_value": "<string>",
        "placeholder": "<string>",
        "pattern": "<string>",
        "options": [
          "<string>"
        ],
        "formula": "<string>",
        "areas": [
          {
            "x": 123,
            "y": 123,
            "w": 123,
            "h": 123,
            "page": 123,
            "attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "preferences": {}
      }
    ],
    "submitters": [
      {}
    ],
    "documents": [
      {
        "id": 123,
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "filename": "<string>",
        "page_count": 123,
        "page_dimensions": [
          {
            "width": 123,
            "height": 123
          }
        ],
        "url": "<string>"
      }
    ]
  },
  "documents": [
    {
      "id": 123,
      "filename": "<string>",
      "document_type": "<string>",
      "byte_size": 123
    }
  ]
}

Authorizations

X-Auth-Token

string

header

required

API token generated at Settings > API

Headers

Idempotency-Key

string

Prevents duplicate submissions on retry. Same key + same body replays the original response.

Maximum string length: 255

Body

application/json

template_id

string

required

submitters

object[]

required

Show child attributes

send_email

boolean

default:true

Send invitation emails to submitters

send_sms

boolean

default:false

Send SMS invitations instead of email

order

enum<string>

default:preserved

Available options:

preserved,

random

expire_at

string<date-time>

metadata

object

completed_redirect_url

string

reply_to

string<email>

bcc_completed

string<email>

message

object

Show child attributes

quick_sign_mode

enum<string>

default:confirmation_modal

Submission-level quick-sign mode. Set to normal to force legacy behavior.

Available options:

normal,

review_and_sign,

auto_scroll_signature,

confirmation_modal

prefill_behavior

object

Submission-level prefill behavior. Defaults to skip prefilled fields and make them read-only.

Show child attributes

cover_page

object

Generate a dynamic cover page and prepend it as page 0 of the signing package. The cover page is rendered per submission with the provided financial data. All monetary values are integers in whole dollars (no cents). Admin fees must be negative.

Show child attributes

preferences

object

Response

Created submission with submitters

integer

slug

string

source

string

status

string

template_id

string

created_at

string<date-time>

updated_at

string<date-time>

completed_at

string<date-time> | null

expire_at

string<date-time> | null

submitters

object[]

Show child attributes

audit_log

object[]

metadata

object

template

object

Show child attributes

documents

object[]

Show child attributes

Get submission

Error

A valid request URL is required to generate request examples

{
  "id": 123,
  "slug": "<string>",
  "source": "<string>",
  "status": "<string>",
  "template_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expire_at": "2023-11-07T05:31:56Z",
  "submitters": [
    {
      "id": 123,
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "role": "<string>",
      "submission_id": 123,
      "opened_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "phone": "<string>",
      "external_id": "<string>",
      "values": {},
      "metadata": {},
      "preferences": {},
      "declined_at": "2023-11-07T05:31:56Z",
      "documents": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "submission_events": [
        {}
      ],
      "template": {
        "id": 123,
        "name": "<string>"
      },
      "submission": {
        "id": 123,
        "slug": "<string>",
        "status": "<string>"
      }
    }
  ],
  "audit_log": [
    {}
  ],
  "metadata": {},
  "template": {
    "id": "<string>",
    "name": "<string>",
    "schema": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "required": true,
        "readonly": true,
        "key": "<string>",
        "default_value": "<string>",
        "placeholder": "<string>",
        "pattern": "<string>",
        "options": [
          "<string>"
        ],
        "formula": "<string>",
        "areas": [
          {
            "x": 123,
            "y": 123,
            "w": 123,
            "h": 123,
            "page": 123,
            "attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "preferences": {}
      }
    ],
    "submitters": [
      {}
    ],
    "documents": [
      {
        "id": 123,
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "filename": "<string>",
        "page_count": 123,
        "page_dimensions": [
          {
            "width": 123,
            "height": 123
          }
        ],
        "url": "<string>"
      }
    ]
  },
  "documents": [
    {
      "id": 123,
      "filename": "<string>",
      "document_type": "<string>",
      "byte_size": 123
    }
  ]
}

Documentation Index

Authorizations

Headers

Body

Response