Lease Annexes
Leases

Attest that mandatory annexes were handed over off-platform

Records, server-side, that the landlord certifies having given the tenant the mandatory documents that are not attached to the signed file.

French law requires certain annexes to accompany a lease. When one of them is missing from the dossier, the landlord may still be handing it over on paper: this endpoint is where that statement is captured.

Why it is an API call and not a client-side analytics event: the trace is written by the server, timestamped, and attributed to the authenticated user (sub from the JWT). A client-side event could be suppressed by the client; this one cannot. It is what evidences that the platform met its duty to inform, and that the landlord took the obligation on.

Send the list of documents actually attested. The call records the statement; it does not attach anything to the dossier and does not lift any signature blocker.

Discover what is missing first with GET /leases/{lease_id}/annexes/signature-dossier.

post/leases/{lease_id}/annexes/missing-docs-attestation

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/annexes/missing-docs-attestation
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Request body

documentsstring[] required

Identifiers or labels of the mandatory documents the landlord certifies having handed over directly.

Response

Attestation recorded.

recordedboolean

Example response

{
  "recorded": true
}

Changes

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