curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Contract Name",
  "expiration_hours": 72
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "document_page_count": 2,
  "status": "not_sent",
  "expiration_hours": 168,
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true
  },
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date_created": "2023-11-07T05:31:56Z",
  "date_sent": "2023-11-07T05:31:56Z",
  "date_finished": "2023-11-07T05:31:56Z",
  "date_cancelled": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "certificate": {
    "generated": true,
    "generated_on": "2023-11-07T05:31:56Z",
    "has_error": true
  },
  "final_document_download_url": "<string>",
  "final_document_download_error": "file_not_accessible"
}

Signing Requests

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.

POST

signing-requests

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Contract Name",
  "expiration_hours": 72
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "document_page_count": 2,
  "status": "not_sent",
  "expiration_hours": 168,
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true
  },
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date_created": "2023-11-07T05:31:56Z",
  "date_sent": "2023-11-07T05:31:56Z",
  "date_finished": "2023-11-07T05:31:56Z",
  "date_cancelled": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "certificate": {
    "generated": true,
    "generated_on": "2023-11-07T05:31:56Z",
    "has_error": true
  },
  "final_document_download_url": "<string>",
  "final_document_download_error": "file_not_accessible"
}

Authorizations

Authorization

string

header

required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Body

application/json

Option 1
Option 2

Create signing request from a PDF document

document

string<byte>

required

Base64-encoded PDF document. Page count will be auto-extracted.

name

string

Name for the signing request

Maximum string length: 255

description

string

Description for the signing request

expiration_hours

integer

default:168

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

Required range: x >= 1

recipients

object[]

Recipients for the signing request. Use temporary IDs (e.g., 'temp_1') in the id field to reference recipients in fields/reminders.

Show child attributes

fields

object[]

Fields to place on the document. Use recipient_id to assign fields to recipients.

Show child attributes

reminders

object[]

Reminders to send to recipients

Show child attributes

settings

object

Signing request settings

Show child attributes

Response

Signing request created successfully

string<uuid>

Unique identifier for the signing request

name

string

Signing request name

Maximum string length: 255

description

string | null

Signing request description

document_url

string<uri>

Pre-signed URL to the PDF document. This is a time-limited signed URL for secure access - see document_url_expires_at for expiration time. Initial URLs are valid for 7 days; refreshed URLs are valid for 1 hour. Request a new signing request retrieval to get a fresh URL if expired.

document_url_expires_at

string<date-time> | null

ISO 8601 timestamp when the document_url will expire. After this time, the URL will return an access denied error. Fetch the signing request again to receive a fresh signed URL.

document_page_count

integer

Number of pages in the document

Required range: x >= 1

status

enum<string>

Current status of the signing request

Available options:

not_sent,

in_progress,

finished,

cancelled,

deleted,

expired

expiration_hours

integer

default:168

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

Required range: x >= 1

settings

object

Show child attributes

template_id

string<uuid> | null

ID of template used to create this signing request

date_created

string<date-time>

Signing request creation timestamp

date_sent

string<date-time> | null

Timestamp when the signing request was sent

date_finished

string<date-time> | null

Timestamp when all signatures were completed

date_cancelled

string<date-time> | null

Timestamp when signing request was cancelled

expires_at

string<date-time> | null

Expiration timestamp

certificate

object

Certificate generation status information

Show child attributes

final_document_download_url

string<uri> | null

Signed URL to download the final signed document (PDF with certificate). Only available when signing request is finished and certificate has been generated. URL expires after 1 hour.

final_document_download_error

enum<string> | null

Error indicator if the final document exists but could not be accessed. Value is 'file_not_accessible' when the file path exists but the file is missing or inaccessible, otherwise null.

Available options:

file_not_accessible,

List Signing Requests Create and Send Signing Request (Atomic)

⌘I

Endpoints

Authorizations

Body

Response