v1

latestOpenAPI 3.1.02026-07-14220425.8 KB

Submissions

Create a submission from PDF

The API endpoint provides the functionality to create one-off submission request from a PDF. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="/keyring-examples/fieldtags.pdf" target="_blank" class="link font-bold">/keyring-examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.<br><b>Related Guides</b><br><a href="/keyring-guides/use-embedded-text-field-tags-in-the-pdf.html" class="link">Use embedded text field tags to create a fillable form</a>

post/submissions/pdf

Request body

namestring

Name of the document submission.

send_emailboolean

Set false to disable signature request emails sending.

send_smsboolean

Set true to send signature request via phone number and SMS.

order'preserved' | 'random'

Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.

completed_redirect_urlstring

Specify URL to redirect to after the submission completion.

bcc_completedstring

Specify BCC address to send signed documents to after the completion.

reply_tostring

Specify Reply-To address to use in the notification emails.

expire_atstring

Specify the expiration date and time after which the submission becomes unavailable for signature.

template_idsinteger[]

An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.

flattenboolean

Remove PDF form fields from the documents.

merge_documentsboolean

Set true to merge the documents into a single PDF file.

remove_tagsboolean

Pass false to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.

Example request

{
  "name": "Test Submission Document",
  "expire_at": "2024-09-01 12:00:00 UTC",
  "documents": [
    {
      "file": "base64",
      "fields": [
        {
          "areas": [
            {
              "page": 1
            }
          ],
          "options": [
            "Option A",
            "Option B"
          ]
        }
      ]
    }
  ],
  "submitters": [
    {
      "role": "First Party",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "fields": [
        {
          "name": "First Name",
          "validation": {
            "pattern": "[A-Z]{4}"
          },
          "preferences": {
            "font_size": 12,
            "format": "DD/MM/YYYY",
            "price": 99.99
          }
        }
      ]
    }
  ]
}

Response

idinteger required

Submission unique ID number.

namestring

Submission name.

source'invite' | 'bulk' | 'api' | 'embed' | 'link' required

The source of the submission.

submitters_order'random' | 'preserved' required

The order of submitters.

status'completed' | 'declined' | 'expired' | 'pending' required

The status of the submission.

expire_atstring required

Specify the expiration date and time after which the submission becomes unavailable for signature.

created_atstring required

The date and time when the submission was created.

Example response

{
  "expire_at": "2024-09-01 12:00:00 UTC"
}