Skip to main content
GET
@firma-dev/sdk

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

Response

Signing request retrieved successfully. Returns a detailed nested shape with status as an object and timestamps grouped together.

Detailed signing request as returned by GET /signing-requests/{id} (nested shape with status object and timestamps)

id
string<uuid>
required

Unique identifier for the signing request

name
string
required

Signing request name

companies_workspaces_id
string<uuid>
required

Workspace ID this signing request belongs to

status
object
required

Status flags (multiple can be true for terminal states)

template_description
string | null

Description from the template

document_url
string<uri>

Pre-signed URL to the PDF document

document_url_expires_at
string<date-time> | null
document_page_count
integer

Number of pages in the document

Required range: x >= 1
expiration_hours
integer

Hours until signing request expires

expires_at
string<date-time> | null

ISO 8601 timestamp when the signing request expires. Computed from sent_on + expiration_hours. Null if not sent yet or no expiration_hours set.

credit_cost
integer

Credits consumed when sent

timestamps
object

All relevant timestamps for the signing request lifecycle

settings
object

Settings returned by the signing request list and detail endpoints. Templates use the TemplateSettings schema (no identity fields).

use_signing_order
enum<integer>
deprecated
Available options:
0,
1
allow_download
enum<integer>
deprecated
Available options:
0,
1
allow_editing_before_sending
enum<integer>
deprecated
Available options:
0,
1
hand_drawn_only
enum<integer>
deprecated
Available options:
0,
1
attach_pdf_on_finish
enum<integer>
deprecated
Available options:
0,
1
certificate
object | null

Certificate generation status information

final_document_download_url
string<uri> | null

Signed URL to download the final signed document (PDF with certificate). URL expires after 1 hour.

final_document_download_error
enum<string> | null
Available options:
file_not_accessible,
null
document_only_download_url
string<uri> | null

Signed URL to download the document-only PDF. URL expires after 1 hour.

document_only_download_error
enum<string> | null
Available options:
file_not_accessible,
null
certificate_only_download_url
string<uri> | null

Signed URL to download the certificate-only PDF. URL expires after 1 hour.

certificate_only_download_error
enum<string> | null
Available options:
file_not_accessible,
null
seal_participants
object[]

Organization seal participants in the signing order. Empty when the request has no seals.

documents
object[]

The signing request's documents in position order (multi-document; present only for companies enabled for it). A parent whose document set has never been changed answers its one document, with document_id null.

documents_version
integer

Version of the document set, raised by every document change (multi-document; enabled companies only).

documents_layout_version
integer

Version of the document layout, raised when documents are added, removed or reordered (multi-document; enabled companies only). Field writes on a signing request with more than one document send it back as documents_layout_version.