FIfirma
Signing Requests

Get Signing Request

Changed on

Retrieve a specific signing request by ID

get/signing-requests/{id}

Request

Path parameters

idstring uuid required

Response

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

idstring uuid required

Unique identifier for the signing request

namestring required

Signing request name

template_descriptionstring nullable

Description from the template

companies_workspaces_idstring uuid required

Workspace ID this signing request belongs to

document_urlstring uri

Pre-signed URL to the PDF document

document_url_expires_atstring date-time nullable
document_page_countinteger

Number of pages in the document

expiration_hoursinteger

Hours until signing request expires

expires_atstring date-time nullable

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_costinteger

Credits consumed when sent

use_signing_order0 | 1
allow_download0 | 1
allow_editing_before_sending0 | 1
hand_drawn_only0 | 1
attach_pdf_on_finish0 | 1
final_document_download_urlstring uri nullable

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

final_document_download_error'file_not_accessible' | 'null' nullable
document_only_download_urlstring uri nullable

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

document_only_download_error'file_not_accessible' | 'null' nullable
certificate_only_download_urlstring uri nullable

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

certificate_only_download_error'file_not_accessible' | 'null' nullable
documents_versioninteger

Version of the document set, raised by every document change (multi-document; available to every company). While multi-document editing is suspended, this key is absent on the single-document path and in list and create responses.

documents_layout_versioninteger

Version of the document layout, raised when documents are added, removed or reordered (multi-document; available to every company). Field writes on a signing request with more than one document send it back as documents_layout_version. While multi-document editing is suspended, this key is absent on the single-document path and in list and create responses.

Example response

{
  "documents": [
    {
      "document_id": null,
      "position": 1,
      "label": null,
      "original_filename": null,
      "page_count": 3,
      "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
      "document_url_kind": "stored",
      "document_only_hash": null
    }
  ]
}

Changes

  • 3a2cdde3a64fRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • bfc2b19c9c7eRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status