Signatures
Leases

Get the eIDAS proof of a designated signed document

Returns the eIDAS proof bundle for one named document of the lease.

Use this rather than /leases/{lease_id}/signature/proof whenever the lease produced more than one signed document. The unqualified route resolves "the latest document of the lease", which never designates a surety deed (acte de cautionnement): those deeds were produced and archived but unreachable through it. Pass the document_signature_id and you get the proof of exactly that document.

You obtain the identifier from GET /leases/{lease_id}/signature/status or from the response of initiate.

Same payload and same statuses as the unqualified proof route: NOT_AVAILABLE, GENERATING, AVAILABLE, ERROR.

get/leases/{lease_id}/signature/documents/{document_signature_id}/proof

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/signature/documents/{document_signature_id}/proof
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
document_signature_idstring uuid required

The signed document whose proof you want (lease, amendment, surety deed…).

Response

Proof envelope. An unknown document_signature_id also answers 200 with status: NOT_AVAILABLE rather than a 404.

status'NOT_AVAILABLE' | 'GENERATING' | 'AVAILABLE' | 'ERROR'

Status of the signature proof generation

messagestring nullable
pdf_urlstring nullable

URL to download the proof as PDF

json_urlstring nullable

URL to download the proof as JSON

Changes

No recorded changes to this operation across all 1 revision of this API.