Create Signing Request

Create a new signing request either from a PDF document (document-based) or from an existing template (template-based). For document-based creation, allow_editing_before_sending is automatically set to true. For template-based creation, properties are inherited from the template and can be overridden.

Temporary ID Pattern: For document-based creation, you can reference recipients before they're created using temporary IDs (format: 'temp_X' where X is any identifier, e.g., 'temp_1', 'temp_alice'). Use these temporary IDs in recipient.id, field.recipient_id, and reminder.recipient_id. The API validates all references and automatically maps temporary IDs to real UUIDs after recipients are created. The response contains only real UUIDs.

Temporary ID Validation: Temporary IDs must start with 'temp_', be unique across all recipients in the request, and all field/reminder references must point to recipients defined in the same request. Invalid format, duplicate IDs, or missing recipient references return a 400 error with detailed validation messages.

Request body

OR

Example request

{
  "fields": [
    {
      "format_rules": {
        "dateFormat": "MMMM dd, yyyy"
      },
      "background_color": "#FFFDE7"
    }
  ],
  "anchor_tags": [
    {
      "anchor_string": "{{SIGN_HERE}}",
      "background_color": "#FFFDE7",
      "font_size": 12
    }
  ]
}

Response

Signing request created successfully. The response may include non-blocking email or anchor-tag warnings.

idstring uuid required

Unique identifier for the signing request

namestring required

Signing request name

descriptionstring nullable

Signing request description

status'draft' required

Status is always 'draft' for newly created signing requests

document_urlstring uri

Pre-signed URL to the PDF document

page_countinteger

Number of pages in the document

expiration_hoursinteger

Hours until signing request expires (default: 168 = 7 days)

template_idstring uuid nullable

Template ID if created from a template

created_datestring date-time

Creation timestamp

updated_datestring date-time

Last update timestamp

sent_datestring date-time nullable

When the signing request was sent

finished_datestring date-time nullable

When all signatures were completed

cancelled_datestring date-time nullable

When the signing request was cancelled

warningsstring[]

Optional non-blocking warnings, including unusual recipient email formats, unknown anchor-tag properties during the compatibility window, and anchor-processing warnings.

Create Signing Request

Request body

Example request

Response

Changes