Skip to main content
GET
/
signing-requests
/
{id}
/
download
Download Signing Request Document
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download \
  --header 'Authorization: <api-key>'
{
  "status": "finished",
  "is_partial": true,
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "generated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.firma.dev/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
id
string<uuid>
required

Signing request ID

Response

Download URL retrieved successfully.

​
status
enum<string>
required

Signing request status. finished means all signers have completed; in_progress means signing is still ongoing and this is a partial download; cancelled, declined, expired indicate terminal states where a partial snapshot is still available.

Available options:
finished,
in_progress,
cancelled,
declined,
expired
​
is_partial
boolean
required

Whether this download URL points to a partially-signed document (not all signers have completed).

​
download_url
string<uri>
required

Pre-signed URL to download the PDF document. Expires at the time indicated by expires_at.

​
expires_at
string<date-time>
required

ISO 8601 timestamp when the download_url expires. Fetch this endpoint again for a fresh URL after expiry.

​
generated_at
string<date-time> | null

ISO 8601 timestamp when the document was last generated. For partial downloads, this is when the partial PDF was created.