# FairePlace API

> FairePlace is a REST API for property management in France. It handles properties, leases, electronic signatures (eIDAS advanced level, PAdES-B-LTA), and French rental law compliance. Authentication is via API key (Bearer fp_...). Billing is credit-based (1 credit = 1 signature). Plans: Gratuit (0 EUR: unlimited lease PDFs, 5 properties, signatures at 4.90 EUR each), Starter (14.90 EUR/mo: 5 signatures, 8 properties), Pro (34.90 EUR/mo: 20 signatures, 25 properties, read API access), Business (69.90 EUR/mo: unlimited signatures, 100 properties, full API access, SSO/SAML), Sur Mesure (from 99 EUR/mo: white-label). No commitment.

## Documentation

- [Getting Started](https://developers.faireplace.com/quickstart/getting-started): Quick start guide: authenticate, create an owner, set up a property
- [Authentication](https://developers.faireplace.com/quickstart/authentication): API key authentication (Bearer fp_... token), scoped per organization (tenant)
- [API Reference](https://developers.faireplace.com/api): Interactive reference for 574 endpoints

## Core Modules

### Property Management
- [Properties Overview](https://developers.faireplace.com/properties/overview): Property hierarchy: Places > Estates > Rooms
- [Places API](https://developers.faireplace.com/properties/places): Buildings and property sites
- [Estates API](https://developers.faireplace.com/properties/estates): Individual apartments and units
- [Rooms API](https://developers.faireplace.com/properties/rooms): Room-level management
- [Equipment API](https://developers.faireplace.com/properties/equipment): Appliances and fixtures
- [Keys API](https://developers.faireplace.com/properties/keys): Key lifecycle management

### Lease Management
- [Leases Overview](https://developers.faireplace.com/leases/overview): Full lease lifecycle: draft to termination
- [Leases API](https://developers.faireplace.com/leases/leases): Create and manage rental agreements
- [Lease Types API](https://developers.faireplace.com/leases/lease-types): Legal frameworks (furnished, unfurnished, commercial)
- [Charges API](https://developers.faireplace.com/leases/charges): Rental charges and provisions
- [Documents & PDFs](https://developers.faireplace.com/leases/documents-and-pdfs): Generate lease PDFs with Typst
- [Amendments](https://developers.faireplace.com/leases/amendments): Lease amendments (avenants)

### Electronic Signatures
- [Signatures Overview](https://developers.faireplace.com/signatures/overview): eIDAS-compliant e-signatures
- [Signature Workflow](https://developers.faireplace.com/signatures/lease-workflow): Full signing flow for leases
- [OTP & Proof](https://developers.faireplace.com/signatures/otp-and-proof): OTP verification and proof archives

### People
- [Lessees API](https://developers.faireplace.com/people/lessees): Tenants, corporate lessees, guarantors
- [Owners API](https://developers.faireplace.com/people/owners): Property owners
- [Contacts API](https://developers.faireplace.com/people/contacts): Contact management

### Payments
- [Credits API](https://developers.faireplace.com/payments/credits): Credit-based billing via Stripe
- [Webhooks](https://developers.faireplace.com/payments/webhooks): Stripe webhook handling

### Compliance
- [Legislative Zones](https://developers.faireplace.com/compliance/legislative-zones): French rental law zones
- [Rent Regulation](https://developers.faireplace.com/compliance/rent-regulation): Rent control checking
- [Energy Diagnosis](https://developers.faireplace.com/compliance/energy-diagnosis): DPE energy ratings

### Core Concepts
- [Errors](https://developers.faireplace.com/core/errors): Error codes and handling
- [Pagination](https://developers.faireplace.com/core/pagination): Pagination, filtering, sorting
- [Multi-tenancy](https://developers.faireplace.com/core/multi-tenancy): Tenant isolation: every API key is scoped to one organization (tenant_id)
- [Media](https://developers.faireplace.com/core/media): File uploads and storage

### Additional API Modules (see API Reference)
- [Mandates](https://developers.faireplace.com/api): Management mandates (mandats de gestion): create, attach document, activate, revoke
- [Rent Revisions](https://developers.faireplace.com/api): IRL rent revision: simulate, record and apply annual lease rent revisions
- [Rent Indices](https://developers.faireplace.com/api): IRL / ICC / ILC / ILAT rent index values and history
- [Coupons](https://developers.faireplace.com/api): Coupon validation and redemption
- [Countries](https://developers.faireplace.com/api): Country reference data (ISO 3166 codes)
- [Guest Signature](https://developers.faireplace.com/api): Public token-based guest signing flow (no login)

### Free Tools (no API key required)
Public document generators and simulators under `https://api.faireplace.com/api/public/tools/*`: rent receipt (quittance de loyer), inventory of fixtures (état des lieux), surety deed (acte de cautionnement), notice to leave (congé), dilapidation grid (grille de vétusté), IRL simulator, rent-control (encadrement des loyers) checker, and rental-yield and security-deposit calculators.

## OpenAPI Specification
- [OpenAPI YAML](https://developers.faireplace.com/api): Full OpenAPI 3.0 spec with 574 endpoints

## Optional

- [Website](https://faireplace.com): Main website
- [App](https://app.faireplace.com): Web application