Lease Management

Copy page

Documents & PDFs

Generate, download, and manage lease documents. FairePlace uses Typst to render lease PDFs that comply with French rental law formatting requirements.

Generate a lease PDF

Code
 
curl -X POST https://api.faireplace.com/api/leases/{lease_id}/pdf \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "template_type": "StandardLease",
    "include_amendments": false,
    "include_tenant_info": true
  }'

Code
 
{
  "pdf_id": "pdf-6f789012-abcd-ef12-3456-7890abcdef34",
  "status": "Generated",
  "download_url": "/api/leases/pdf/pdf-6f789012-abcd-ef12-3456-7890abcdef34",
  "pages": 12,
  "created_at": "2026-02-20T10:00:00Z"
}

Template types

Template	Description
StandardLease	Standard residential lease (bail d'habitation)
FurnishedLease	Furnished residential lease (bail meuble)
StudentLease	Student mobility lease (bail mobilite)
CommercialLease	Commercial lease (bail commercial)

What's included in the PDF

The generated document includes all legally required sections:

1. Parties — Owner and tenant identification
2. Property description — Address, type, area, rooms, equipment
3. Lease terms — Duration, rent, charges, deposit, payment terms
4. Rent regulation — Reference rent, rent cap information (if applicable)
5. Special conditions — Custom clauses
6. Annexes — Energy diagnosis, lead assessment, asbestos report references
7. Signature pages — Blank signature areas for each signer

Download a PDF

Code
 
curl https://api.faireplace.com/api/leases/pdf/{pdf_id} \
  -H "Authorization: Bearer $TOKEN" \
  -o lease-document.pdf

List documents for a lease

Code
 
curl https://api.faireplace.com/api/leases/{lease_id}/documents \
  -H "Authorization: Bearer $TOKEN"

Code
 
{
  "data": [
    {
      "id": "doc-aabb1122-3344-5566-7788-99aabbccddee",
      "type": "lease_pdf",
      "name": "BAIL-2026-001.pdf",
      "status": "Generated",
      "pages": 12,
      "created_at": "2026-02-20T10:00:00Z"
    },
    {
      "id": "doc-ccdd3344-5566-7788-99aa-bbccddeeff00",
      "type": "signed_pdf",
      "name": "BAIL-2026-001-signed.pdf",
      "status": "Completed",
      "pages": 12,
      "created_at": "2026-02-20T16:45:00Z"
    }
  ]
}

Attach documents

Upload supplementary documents to a lease (energy diagnosis, insurance, etc.):

Code
 
curl -X POST https://api.faireplace.com/api/leases/{lease_id}/documents \
  -H "Authorization: Bearer $TOKEN" \
  -F "[email protected]" \
  -F "type=energy_diagnosis" \
  -F "name=DPE 2026"

Document types

Type	Description
lease_pdf	Generated lease document
signed_pdf	Signed lease document (after e-signature)
energy_diagnosis	Energy performance diagnosis (DPE)
lead_assessment	Lead risk assessment (CREP)
asbestos_report	Asbestos technical diagnosis
natural_risks	Natural and technological risks statement (ERNMT)
insurance	Tenant or owner insurance certificate
inventory	Entry/exit inventory (etat des lieux)
amendment	Lease amendment (avenant)
other	Other document

Re-generate a PDF

If the lease data changes (charges added, tenant updated), generate a new PDF. The previous version remains accessible.

Code
 
# Generate a new version
curl -X POST https://api.faireplace.com/api/leases/{lease_id}/pdf \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"template_type": "StandardLease", "include_amendments": true}'

Note: Once a signature is initiated on a PDF, that PDF version is locked. Any changes require generating a new PDF and starting a new signature process.

Storage

Documents are stored securely with:

• AES-256 encryption at rest
• Tenant-scoped access (multi-tenant isolation)
• Automatic retention per French legal requirements

---

Related

• Lease Overview — Lease lifecycle
• Electronic Signatures — Sign the generated PDF
• Leases API — Full endpoint reference
• Media API — General file management