Public Tools

Unauthenticated free-tool widgets (no API key) powering the SEO calculators and document generators on faireplace.com. JSON endpoints return DTOs; the /generate and /bordereau endpoints stream a PDF (application/pdf).

Simulate a rent revision (explicit IRL values)

POST

https://api.faireplace.com/api

/public/tools/irl/simulate

Computes the revised rent from a current rent and two explicit IRL quarter values supplied by the caller (Art. 17-1 Loi 89-462).

Public, unauthenticated tool — no Authorization header required.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/irl/simulate \
  -H "Content-Type: application/json" \
  -d '{
    "current_rent": 850.00,
    "old_irl_quarter": "T2-2023",
    "old_irl_value": 136.27,
    "new_irl_quarter": "T2-2024",
    "new_irl_value": 143.46,
    "effective_date": "2024-07-01"
  }'

Response:


Code
{
  "previous_rent": 850.00,
  "new_rent": 894.85,
  "old_irl_quarter": "T2-2023",
  "new_irl_quarter": "T2-2024",
  "variation_percentage": 5.27,
  "monthly_increase": 44.85,
  "annual_increase": 538.20,
  "effective_date": "2024-07-01"
}

Simulate a rent revision (explicit IRL values) › Request Body

Rent revision simulation using two explicit IRL quarter values supplied by the caller. Use `IrlSimulateByQuartersRequest` to let the server look up the trusted IRL values instead (no typo risk).

IrlSimulateRequest

current_rent

number · required

Current monthly rent excluding charges.

Example: 850

old_irl_quarter

string · pattern: ^T[1-4]-\d{4}$ · required

Reference quarter of the current rent (format T[1-4]-YYYY).

Example: T2-2023

old_irl_value

number · required

new_irl_quarter

string · pattern: ^T[1-4]-\d{4}$ · required

new_irl_value

number · required

effective_date

string · date · required

Date the revised rent takes effect.

Example: 2024-07-01

Simulate a rent revision (explicit IRL values) › Responses

Rent revision computed.

IrlSimulateResponse

previous_rent

number · required

new_rent

number · required

old_irl_quarter

string · required

old_irl_value

number · required

new_irl_quarter

string · required

new_irl_value

number · required

variation_percentage

number · required

effective_date

string · date · required

monthly_increase

number · required

annual_increase

number · required

12 × monthly increase, rounded to 2 decimals.

Example: 538.2

POST/public/tools/irl/simulate

curl https://api.faireplace.com/api/public/tools/irl/simulate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "current_rent": 850,
  "old_irl_quarter": "T2-2023",
  "old_irl_value": 136.27,
  "new_irl_quarter": "T2-2024",
  "new_irl_value": 143.46,
  "effective_date": "2024-07-01"
}'

Example Request Body

{
  "current_rent": 850,
  "old_irl_quarter": "T2-2023",
  "old_irl_value": 136.27,
  "new_irl_quarter": "T2-2024",
  "new_irl_value": 143.46,
  "effective_date": "2024-07-01"
}

json

Example Responses

{
  "previous_rent": 850,
  "new_rent": 894.85,
  "old_irl_quarter": "T2-2023",
  "old_irl_value": 136.27,
  "new_irl_quarter": "T2-2024",
  "new_irl_value": 143.46,
  "variation_percentage": 5.27,
  "effective_date": "2024-07-01",
  "monthly_increase": 44.85,
  "annual_increase": 538.2
}

json

application/json

Simulate a rent revision (server-resolved IRL values)

POST

https://api.faireplace.com/api

/public/tools/irl/simulate-by-quarters

Stricter variant of /irl/simulate: the caller provides only the rent, the two quarter labels and the region; the server resolves the trusted INSEE IRL values (no typo risk).

Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/irl/simulate-by-quarters \
  -H "Content-Type: application/json" \
  -d '{
    "current_rent": 850.00,
    "old_irl_quarter": "T2-2023",
    "new_irl_quarter": "T2-2024",
    "effective_date": "2024-07-01",
    "region": "metropole"
  }'

Simulate a rent revision (server-resolved IRL values) › Request Body

Stricter rent revision: the caller provides only the rent, the two quarter labels and the region. The server resolves the IRL values from its trusted INSEE-backed store.

IrlSimulateByQuartersRequest

current_rent

number · required

old_irl_quarter

string · pattern: ^T[1-4]-\d{4}$ · required

new_irl_quarter

string · pattern: ^T[1-4]-\d{4}$ · required

effective_date

string · date · required

region

string · enum

Regional variant. Default metropole.

Enum values:

metropole

corse

outre_mer

Example: metropole

Simulate a rent revision (server-resolved IRL values) › Responses

Rent revision computed.

IrlSimulateResponse

previous_rent

number · required

new_rent

number · required

old_irl_quarter

string · required

old_irl_value

number · required

new_irl_quarter

string · required

new_irl_value

number · required

variation_percentage

number · required

effective_date

string · date · required

monthly_increase

number · required

annual_increase

number · required

12 × monthly increase, rounded to 2 decimals.

Example: 538.2

POST/public/tools/irl/simulate-by-quarters

curl https://api.faireplace.com/api/public/tools/irl/simulate-by-quarters \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "current_rent": 850,
  "old_irl_quarter": "T2-2023",
  "new_irl_quarter": "T2-2024",
  "effective_date": "2024-07-01",
  "region": "metropole"
}'

Example Request Body

{
  "current_rent": 850,
  "old_irl_quarter": "T2-2023",
  "new_irl_quarter": "T2-2024",
  "effective_date": "2024-07-01",
  "region": "metropole"
}

json

Example Responses

{
  "previous_rent": 850,
  "new_rent": 894.85,
  "old_irl_quarter": "T2-2023",
  "old_irl_value": 136.27,
  "new_irl_quarter": "T2-2024",
  "new_irl_value": 143.46,
  "variation_percentage": 5.27,
  "effective_date": "2024-07-01",
  "monthly_increase": 44.85,
  "annual_increase": 538.2
}

json

application/json

List IRL quarter values

GET

https://api.faireplace.com/api

/public/tools/irl/values

Returns the published IRL values per quarter for a region, with source metadata. Public, unauthenticated tool. Cacheable.

Example

Code
curl "https://api.faireplace.com/api/public/tools/irl/values?from=2020&to=2024&region=metropole"

List IRL quarter values › query Parameters

from

integer · int32 · min: 2000 · max: 2100

Start year (inclusive).

to

integer · int32 · min: 2000 · max: 2100

End year (inclusive).

region

string · enum

Regional variant. Aliases outre-mer and dom are accepted.

Enum values:

metropole

corse

outre_mer

Default: metropole

List IRL quarter values › Responses

IRL values for the region.

IrlValuesResponse

code

string · required

region

string · required

region_label

string · required

IrlRegionInfo[] · required

source

string · required

IrlQuarterValue[] · required

source_url

string | null

last_updated

string | null · date

Get the latest published IRL value

GET

https://api.faireplace.com/api

/public/tools/irl/latest

Returns the most recent published IRL value for a region. Public, unauthenticated tool. Cacheable.

Example

Code
curl "https://api.faireplace.com/api/public/tools/irl/latest?region=metropole"

Get the latest published IRL value › query Parameters

region

string · enum

Enum values:

metropole

corse

outre_mer

Default: metropole

Get the latest published IRL value › Responses

Latest IRL value.

IrlLatestResponse

quarter

string · required

value

number · required

published_at

string · date · required

region

string · required

region_label

string · required

source

string · required

source_url

string | null

Calculate a security-deposit restitution

POST

https://api.faireplace.com/api

/public/tools/depot-garantie/calculate

Computes the legal deposit cap, restitution deadline, allowed retentions and any late penalty (Art. 22 Loi 89-462). Returns JSON.

Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/depot-garantie/calculate \
  -H "Content-Type: application/json" \
  -d '{
    "lease_type": "vide",
    "monthly_rent_hc": 750.00,
    "deposit_amount": 750.00,
    "lease_end_date": "2026-03-31",
    "exit_inspection_conformity": true
  }'

Calculate a security-deposit restitution › Request Body

Inputs for the security-deposit calculator (Art. 22 Loi 89-462): legal cap, restitution deadline, allowed retentions and late penalty.

DepotGarantieCalculateRequest

lease_type

string · required

Lease type, drives the legal cap: vide (1× rent HC), meuble (2× rent HC), mobilite (deposit forbidden).

Example: vide

monthly_rent_hc

number · required

Monthly rent excluding charges. Used for the late penalty.

Example: 750

deposit_amount

number · required

Deposit actually collected at signature.

Example: 750

lease_end_date

string · date · required

Effective end date of the lease (move-out).

Example: 2026-03-31

exit_inspection_conformity

boolean | null

Exit inspection conform to the entry one? true → 1-month restitution deadline; false → 2 months. Defaults to true if omitted.

Example: true

retained_for_charges

number | null

Optional retention for co-ownership charge provisions (EUR).

retained_for_damages

number | null

Optional retention for damages (EUR).

retained_for_unpaid_rent

number | null

Optional retention for unpaid rent (EUR).

actual_return_date

string | null · date

Actual restitution date (if known) — enables late-penalty calc.

Calculate a security-deposit restitution › Responses

Restitution computed.

DepotGarantieCalculateResponse

lease_type

string · required

monthly_rent_hc

number · required

deposit_amount

number · required

deposit_exceeds_cap

boolean · required

exit_inspection_conformity

boolean · required

restitution_deadline_months

integer · int32 · required

restitution_due_date

string · date · required

max_charge_retention

number · required

Max 20% retention allowed for charge provisions.

Example: 150

retained_for_charges

number · required

retained_for_damages

number · required

retained_for_unpaid_rent

number · required

total_retained

number · required

amount_before_penalty

number · required

Amount remaining after retentions, before any penalty.

Example: 750

late_penalty

number · required

Late penalty owed by the landlord (10% rent HC × months late).

Example: 0

net_to_return_to_tenant

number · required

Total the landlord must return (amount_before_penalty + late_penalty).

Example: 750

legal_basis

string · required

warnings

string[] · required

legal_deposit_cap

number | null

Legal cap of the exigible deposit (null for mobility = forbidden).

Example: 750

POST/public/tools/depot-garantie/calculate

curl https://api.faireplace.com/api/public/tools/depot-garantie/calculate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "lease_end_date": "2026-03-31",
  "exit_inspection_conformity": true,
  "retained_for_charges": 0,
  "retained_for_damages": 0,
  "retained_for_unpaid_rent": 0,
  "actual_return_date": "2024-08-25"
}'

Example Request Body

{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "lease_end_date": "2026-03-31",
  "exit_inspection_conformity": true,
  "retained_for_charges": 0,
  "retained_for_damages": 0,
  "retained_for_unpaid_rent": 0,
  "actual_return_date": "2024-08-25"
}

json

Example Responses

{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "legal_deposit_cap": 750,
  "deposit_exceeds_cap": false,
  "exit_inspection_conformity": true,
  "restitution_deadline_months": 1,
  "restitution_due_date": "2026-04-30",
  "max_charge_retention": 150,
  "retained_for_charges": 0,
  "retained_for_damages": 0,
  "retained_for_unpaid_rent": 0,
  "total_retained": 0,
  "amount_before_penalty": 750,
  "late_penalty": 0,
  "net_to_return_to_tenant": 750,
  "legal_basis": "Art. 22 Loi n° 89-462 du 6 juillet 1989",
  "warnings": []
}

json

application/json

Generate a security-deposit restitution receipt (PDF)

POST

https://api.faireplace.com/api

/public/tools/depot-garantie/bordereau

Renders the restitution receipt (bordereau) as a PDF. Same computation inputs as /depot-garantie/calculate plus the parties, signature place and rendering options.

Public, unauthenticated tool. Returns application/pdf.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/depot-garantie/bordereau \
  -H "Content-Type: application/json" \
  -d '{ ... }' --output bordereau.pdf

Generate a security-deposit restitution receipt (PDF) › Request Body

Inputs to render the restitution receipt (bordereau) PDF. Includes all the `DepotGarantieCalculateRequest` fields plus the parties and rendering options.

DepotGarantieBordereauRequest

lease_type

string · required

monthly_rent_hc

number · required

deposit_amount

number · required

lease_end_date

string · date · required

FrPartyDto · required

A party (landlord or tenant) with a French postal address. Used by the quittance and security-deposit bordereau tools.

FrPartyDto · required

A party (landlord or tenant) with a French postal address. Used by the quittance and security-deposit bordereau tools.

FrPropertyDto · required

A rented dwelling with a French postal address.

lieu_signature

string · minLength: 1 · maxLength: 80 · required

Place where the receipt is signed.

Example: Lyon

exit_inspection_conformity

boolean | null

retained_for_charges

number | null

retained_for_damages

number | null

retained_for_unpaid_rent

number | null

actual_return_date

string | null · date

deposit_paid_date

string | null · date

Date the deposit was paid at lease signature (shown on the receipt).

restitution_mode

string | null · enum

Restitution mode shown on the receipt. Default virement.

Enum values:

virement

cheque

especes

Example: virement

justification_charges

string | null

Optional free-text justification for the charges retention.

justification_damages

string | null

justification_unpaid_rent

string | null

Generate a security-deposit restitution receipt (PDF) › Responses

The generated restitution receipt PDF.

string

POST/public/tools/depot-garantie/bordereau

curl https://api.faireplace.com/api/public/tools/depot-garantie/bordereau \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "lease_end_date": "2026-03-31",
  "exit_inspection_conformity": true,
  "retained_for_charges": 0,
  "retained_for_damages": 0,
  "retained_for_unpaid_rent": 0,
  "actual_return_date": "2024-08-25",
  "bailleur": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "locataire": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "logement": {
    "adresse": "34 rue de la République",
    "code_postal": "69002",
    "ville": "Lyon",
    "nom": "Appartement T3"
  },
  "lieu_signature": "Lyon",
  "deposit_paid_date": "2024-08-25",
  "restitution_mode": "virement",
  "justification_charges": "justification_charges",
  "justification_damages": "justification_damages",
  "justification_unpaid_rent": "justification_unpaid_rent"
}'

Example Request Body

{
  "lease_type": "vide",
  "monthly_rent_hc": 750,
  "deposit_amount": 750,
  "lease_end_date": "2026-03-31",
  "exit_inspection_conformity": true,
  "retained_for_charges": 0,
  "retained_for_damages": 0,
  "retained_for_unpaid_rent": 0,
  "actual_return_date": "2024-08-25",
  "bailleur": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "locataire": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "logement": {
    "adresse": "34 rue de la République",
    "code_postal": "69002",
    "ville": "Lyon",
    "nom": "Appartement T3"
  },
  "lieu_signature": "Lyon",
  "deposit_paid_date": "2024-08-25",
  "restitution_mode": "virement",
  "justification_charges": "justification_charges",
  "justification_damages": "justification_damages",
  "justification_unpaid_rent": "justification_unpaid_rent"
}

json

Example Responses

string

text

application/pdf

List rent-control territories

GET

https://api.faireplace.com/api

/public/tools/rent-control/territories

Returns the supported rent-control territories and their postal codes (Paris, Lyon, Lille, Bordeaux, Montpellier, etc.). Public, unauthenticated tool. Cacheable.

Example

Code
curl https://api.faireplace.com/api/public/tools/rent-control/territories

List rent-control territories › Responses

Supported territories.

TerritoriesResponse

TerritoryInfo[] · required

Resolve the administrative quarter for an address

GET

https://api.faireplace.com/api

/public/tools/rent-control/quarter

Resolves the rent-control administrative quarter for a French address. Public, unauthenticated tool.

Example

Code
curl "https://api.faireplace.com/api/public/tools/rent-control/quarter?address=1%20rue%20de%20Rivoli&postal_code=75001"

Resolve the administrative quarter for an address › query Parameters

address

string · minLength: 3 · maxLength: 200 · required

postal_code

string · minLength: 5 · maxLength: 5 · required

Resolve the administrative quarter for an address › Responses

Resolved administrative quarter.

Administrative quarter resolved for an address (rent-control zoning).

QuarterResponse

quarter_id

integer · int32 · required

quarter_name

string · required

coordinates

number[] · minItems: 2 · maxItems: 2 · required

[longitude, latitude] tuple.

Example: [2.3522,48.8566]

Get the reference rent for a quarter

GET

https://api.faireplace.com/api

/public/tools/rent-control/reference-rent

Returns the reference rent (€/m²), its increased and decreased bounds and the data freshness for a given quarter, room count, construction period and furnishing. Public, unauthenticated tool. Cacheable.

Example

Code
curl "https://api.faireplace.com/api/public/tools/rent-control/reference-rent?quarter=Halles&room_count=2&construction_period=1971-1990&is_furnished=false&year=2024"

Get the reference rent for a quarter › query Parameters

quarter

string · minLength: 1 · maxLength: 200 · required

room_count

integer · int32 · min: 1 · max: 20 · required

construction_period

public-tools_ConstructionPeriod · enum · required

Construction period bracket of the dwelling.

Enum values:

avant 1946

1946-1970

1971-1990

1991-2005

après 2005

Example: 1971-1990

is_furnished

boolean · required

year

string · minLength: 4 · maxLength: 4 · required

Get the reference rent for a quarter › Responses

Reference rent for the quarter.

ReferenceRentResponse

reference_rent

number · required

Reference rent per m² (€/m²).

Example: 28.4

reference_rent_increased

number · required

Increased reference rent per m² (legal ceiling, €/m²).

Example: 34.1

reference_rent_decreased

number · required

year

string · required

DataFreshness · required

Check a proposed rent against rent control

POST

https://api.faireplace.com/api

/public/tools/rent-control/check

Checks a proposed rent against the rent-control ceiling for the address. Returns one of two shapes, discriminated by regulated:

regulated: true → full verdict (RentControlCheckResponse)
regulated: false → the commune is not regulated, rent is free (RentControlNotRegulatedResponse)

Both are returned with HTTP 200. Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/rent-control/check \
  -H "Content-Type: application/json" \
  -d '{
    "address": "1 rue de Rivoli",
    "postal_code": "75001",
    "room_count": 2,
    "surface_area": 45.0,
    "construction_period": "1971-1990",
    "is_furnished": false,
    "proposed_rent": 1500.0
  }'

Check a proposed rent against rent control › Request Body

RentControlCheckRequest

address

string · minLength: 3 · maxLength: 200 · required

postal_code

string · pattern: ^\d{5}$ · required

room_count

integer · int32 · min: 1 · max: 20 · required

surface_area

number · double · min: 5 · max: 2000 · required

Surface area in m².

Example: 45

construction_period

public-tools_ConstructionPeriod · enum · required

Construction period bracket of the dwelling.

Enum values:

avant 1946

1946-1970

1971-1990

1991-2005

après 2005

Example: 1971-1990

is_furnished

boolean · required

proposed_rent

number · double · min: 10 · max: 100000 · required

Proposed monthly rent (EUR).

Example: 1500

Check a proposed rent against rent control › Responses

Rent-control verdict (regulated) or "rent is free" information (not regulated). Discriminated by the regulated boolean.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: regulated, territory, territory_label +13 more
	type = object · requires: regulated, postal_code, message

Properties for Variant 1:

Verdict when the dwelling is in a regulated zone. The `regulated: true` discriminator distinguishes it from `RentControlNotRegulatedResponse`.

RentControlCheckResponse

regulated

boolean · required

Always true for this shape.

Example: true

territory

string · required

territory_label

string · required

address

string · required

administrative_quarter

string · required

ReferenceRentResponse · required

proposed_rent_per_sqm

number · double · required

is_compliant

boolean · required

compliance_status

string · enum · required

Enum values:

compliant

exceeds_reference

exceeds_increased_reference

below_decreased_reference

Example: compliant

overage_amount

number · double · required

Amount the proposed rent exceeds the legal ceiling (EUR; negative if compliant).

Example: -34.5

overage_percentage

number · double · required

max_legal_rent

number · double · required

Maximum legal rent = increased reference rent × surface.

Example: 1534.5

public-tools_RegulationRule[] · required

data_source

string · required

last_update

string · required

DataFreshness · required

quarter_id

integer | null · int32

POST/public/tools/rent-control/check

curl https://api.faireplace.com/api/public/tools/rent-control/check \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "1 rue de Rivoli",
  "postal_code": "75001",
  "room_count": 2,
  "surface_area": 45,
  "construction_period": "1971-1990",
  "is_furnished": false,
  "proposed_rent": 1500
}'

Example Request Body

{
  "address": "1 rue de Rivoli",
  "postal_code": "75001",
  "room_count": 2,
  "surface_area": 45,
  "construction_period": "1971-1990",
  "is_furnished": false,
  "proposed_rent": 1500
}

json

Example Responses

{
  "regulated": true,
  "territory": "paris",
  "territory_label": "Paris",
  "address": "1 rue de Rivoli",
  "administrative_quarter": "Saint-Germain-l'Auxerrois",
  "quarter_id": 1,
  "reference_rent": {
    "reference_rent": 28.4,
    "reference_rent_increased": 34.1,
    "reference_rent_decreased": 19.9,
    "year": "2024",
    "data_freshness": {
      "data_year": "2024",
      "is_stale": false,
      "warning": "warning"
    }
  },
  "proposed_rent_per_sqm": 33.33,
  "is_compliant": true,
  "compliance_status": "compliant",
  "overage_amount": -34.5,
  "overage_percentage": -2.25,
  "max_legal_rent": 1534.5,
  "applicable_regulations": [
    {
      "name": "Encadrement des loyers",
      "description": "Le loyer ne peut excéder le loyer de référence majoré.",
      "reference_url": "reference_url"
    }
  ],
  "data_source": "data.gouv.fr",
  "last_update": "2024-07-01",
  "data_freshness": {
    "data_year": "2024",
    "is_stale": false,
    "warning": "warning"
  }
}

json

application/json

Check property risks for an address

POST

https://api.faireplace.com/api

/public/tools/risks/check

Geocodes a free-text address (BAN) and returns an indicative synthesis of the commune's natural and technological risks (Géorisques), plus a link to the official ERRIAL tool. Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/risks/check \
  -H "Content-Type: application/json" \
  -d '{ "address": "1 rue de Rivoli, 75001 Paris" }'

Check property risks for an address › Request Body

RiskCheckRequest

address

string · minLength: 5 · maxLength: 200 · required

Free-text French address (geocoded via BAN).

Example: 12 rue de la République, 75001 Paris

Check property risks for an address › Responses

Risk synthesis for the commune of the geocoded address.

Indicative synthesis of natural and technological risks for the commune of the geocoded address, plus a link to the official ERRIAL tool. FairePlace informs; ERRIAL certifies the regulated État des Risques.

RiskReport

commune

string · required

code_insee

string · required

address_label

string · required

latitude

number · double · required

longitude

number · double · required

RiskItem[] · required

errial_url

string · required

Link to the official ERRIAL tool (regulated État des Risques).

Example: https://errial.georisques.gouv.fr/#/

postal_code

string | null

seismic_zone

string | null

Seismic zone (1 to 5) if the commune is concerned.

Example: 1

Simulate rental yield across tax regimes

POST

https://api.faireplace.com/api

/public/tools/rendement-locatif/simulate

Computes gross/net yield, per-regime tax breakdown, cashflow and the recommended fiscal regime for a rental investment. Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/rendement-locatif/simulate \
  -H "Content-Type: application/json" \
  -d '{
    "purchase_price": 200000,
    "notary_fees": 16000,
    "monthly_rent": 800,
    "annual_charges": 2000,
    "furnishing": "furnished_long_term",
    "tmi_percent": 30
  }'

Simulate rental yield across tax regimes › Request Body

RendementSimulateRequest

purchase_price

number · required

notary_fees

number · required

monthly_rent

number · required

annual_charges

number · required

furnishing

FurnishingKind · enum · required

Lease/furnishing type for the rental-yield simulation. The legacy alias furnished is also accepted and maps to furnished_long_term.

Enum values:

unfurnished

furnished_long_term

furnished_tourism_classified

furnished_tourism_unclassified

Example: furnished_long_term

tmi_percent

number · required

Marginal income-tax rate (%).

Example: 30

renovation_cost

number

Default 0.

Example: 0

annual_deductible_works

number

Annual deductible works in the réel foncier regime. Default 0.

Example: 0

is_energy_renovation

boolean

Works eligible for the energy-renovation deficit ceiling (21 400€). Default false.

Example: false

vacancy_weeks_per_year

integer · int32 · min: 0 · max: 52

Rental vacancy in weeks per year. Default 0.

Example: 0

prelevements_sociaux_percent

number

Social levies rate (%). Default 17.2.

Example: 17.2

object

Optional mortgage financing parameters.

Simulate rental yield across tax regimes › Responses

Yield simulation result.

RendementSimulateResponse

total_investment

number · required

annual_rent_gross

number · required

annual_rent_effective

number · required

gross_yield_percent

number · required

net_yield_percent

number · required

RegimeBreakdown[] · required

recommended_regime

string · enum · required

Enum values:

micro_foncier

reel_foncier

micro_bic

reel_lmnp

Example: micro_bic

recommended_regime_label

string · required

is_likely_lmp

boolean · required

The landlord may qualify for the LMP (professional furnished) status.

Example: false

legal_sources

string[] · required

loan_monthly_payment

number | null

loan_first_year_interest

number | null

lmp_warning

string

LMP warning message, present only when applicable.

POST/public/tools/rendement-locatif/simulate

curl https://api.faireplace.com/api/public/tools/rendement-locatif/simulate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "purchase_price": 200000,
  "notary_fees": 16000,
  "renovation_cost": 0,
  "monthly_rent": 800,
  "annual_charges": 2000,
  "annual_deductible_works": 0,
  "is_energy_renovation": false,
  "vacancy_weeks_per_year": 0,
  "furnishing": "furnished_long_term",
  "tmi_percent": 30,
  "prelevements_sociaux_percent": 17.2,
  "financing": {
    "loan_amount": 150000,
    "annual_rate_percent": 3.5,
    "duration_years": 20
  }
}'

Example Request Body

{
  "purchase_price": 200000,
  "notary_fees": 16000,
  "renovation_cost": 0,
  "monthly_rent": 800,
  "annual_charges": 2000,
  "annual_deductible_works": 0,
  "is_energy_renovation": false,
  "vacancy_weeks_per_year": 0,
  "furnishing": "furnished_long_term",
  "tmi_percent": 30,
  "prelevements_sociaux_percent": 17.2,
  "financing": {
    "loan_amount": 150000,
    "annual_rate_percent": 3.5,
    "duration_years": 20
  }
}

json

Example Responses

{
  "total_investment": 216000,
  "annual_rent_gross": 9600,
  "annual_rent_effective": 9600,
  "gross_yield_percent": 4.44,
  "net_yield_percent": 3.52,
  "loan_monthly_payment": 0,
  "loan_first_year_interest": 0,
  "regimes": [
    {
      "regime": "micro_bic",
      "regime_label": "Micro-BIC",
      "taxable_base": 4800,
      "annual_tax": 2266,
      "deficit_foncier_imputed_on_global_income": 0,
      "annual_cashflow": 5200,
      "monthly_cashflow": 433.33,
      "net_net_yield_percent": 2.45,
      "is_eligible": true,
      "ineligibility_reason": "ineligibility_reason"
    }
  ],
  "recommended_regime": "micro_bic",
  "recommended_regime_label": "Micro-BIC",
  "is_likely_lmp": false,
  "lmp_warning": "lmp_warning",
  "legal_sources": [
    "string"
  ]
}

json

application/json

Get default referentials for the landing wizard

GET

https://api.faireplace.com/api

/public/tools/referentials

Returns the default global referentials (stable UUIDs): lease types, estate types and place types, plus the default place type and country. Consumed by the landing wizard. Public, unauthenticated tool. Cacheable.

Example

Code
curl https://api.faireplace.com/api/public/tools/referentials

Get default referentials for the landing wizard › Responses

Default referentials.

Default global referentials (stable UUIDs) consumed by the landing wizard: lease types, estate types and place types, plus the default place type and country used when depositing a bail draft.

ReferentialsResponse

LeaseTypeRef[] · required

EstateTypeRef[] · required

PlaceTypeRef[] · required

default_place_type_id

string | null · uuid

Default global place_type UUID (null if not seeded).

default_country_id

string | null · uuid

Default country UUID (France; null if absent).

Get the default lease template for a lease type

GET

https://api.faireplace.com/api

/public/tools/bail-template/{lease_type_id}

Returns the default Typst lease template (client-rendered) for a lease type. Public, unauthenticated tool. Cacheable.

Example

Code
curl https://api.faireplace.com/api/public/tools/bail-template/00000000-0000-0000-0000-000000000001

Get the default lease template for a lease type › path Parameters

lease_type_id

string · uuid · required

UUID of the lease type.

Get the default lease template for a lease type › Responses

The default lease template.

BailTemplate

content

string · required

Typst source of the default lease template (client-rendered).

version

string · required

Deposit an anonymous lease draft

POST

https://api.faireplace.com/api

/public/tools/bail-draft

Stores an opaque lease-draft payload (FP2-T1 contract) and returns a short-lived draft_token (TTL 30 minutes). The landing carries the token in a .faireplace.com cookie and exchanges it at authenticated ingestion.

The body must be a JSON object containing at least owner, logement and lease. Public, unauthenticated tool.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/bail-draft \
  -H "Content-Type: application/json" \
  -d '{
    "owner": { "last_name": "Dupont" },
    "logement": { "name": "T2" },
    "lease": { "rent_amount": 850.0 }
  }'

Response (201):


Code
{
  "draft_token": "f47ac10b58cc4372a5670e02b2c3d479",
  "expires_at": "2026-06-20T10:30:00+00:00"
}

Deposit an anonymous lease draft › Request Body

Opaque lease-draft payload (FP2-T1 contract). Validated lightly here: it must be a JSON object containing at least `owner`, `logement` and `lease`. Strict typed validation happens at authenticated ingestion.

BailDraftRequest

owner

object · required

Landlord block (free-form draft).

logement

object · required

Dwelling block (free-form draft).

lease

object · required

Lease block (free-form draft).

lessee

object | null

schema_version

integer

Deposit an anonymous lease draft › Responses

Draft stored; opaque token returned.

BailDraftResponse

draft_token

string · required

Opaque token to carry in a .faireplace.com cookie, then exchanged at authenticated ingestion. Valid for 30 minutes.

Example: f47ac10b58cc4372a5670e02b2c3d479

expires_at

string · date-time · required

Expiry timestamp (ISO 8601, now + TTL).

Example: 2026-06-20T10:30:00+00:00

Generate a rent receipt (PDF)

POST

https://api.faireplace.com/api

/public/tools/quittance/generate

Generates a rent receipt PDF. If the amount paid covers the total due the document is a "Quittance"; otherwise a "Reçu".

Accepts the structured payload below, or a simplified payload for AI agents (fields like landlord_name, landlord_address, tenant_name, property_address, month such as "avril 2026", rent, charges, paid); the handler auto-detects and converts it.

Public, unauthenticated tool. Returns application/pdf.

Example

Code
curl -X POST https://api.faireplace.com/api/public/tools/quittance/generate \
  -H "Content-Type: application/json" \
  -d '{ ... }' --output quittance.pdf

Generate a rent receipt (PDF) › Request Body

Rent-receipt generator (structured form used by the web form). If the amount paid covers the total due the PDF is a "Quittance"; otherwise a "Reçu". The endpoint also accepts a simplified payload (for AI agents) with fields such as `landlord_name`, `landlord_address`, `tenant_name`, `property_address`, `month` ("avril 2026"), `rent`, `charges`, `paid`; the handler auto-detects and converts it. The structured form below is the primary contract.

QuittanceGenerateRequest

FrPartyDto · required

A party (landlord or tenant) with a French postal address. Used by the quittance and security-deposit bordereau tools.

FrPartyDto · required

A party (landlord or tenant) with a French postal address. Used by the quittance and security-deposit bordereau tools.

FrPropertyDto · required

A rented dwelling with a French postal address.

QuittancePeriodDto · required

loyer_hc

number · required

Monthly rent excluding charges (0–100 000 EUR).

Example: 850

amount_paid

number · required

Amount actually paid (0–100 000 EUR).

Example: 925

lieu_signature

string · minLength: 1 · maxLength: 80 · required

QuittanceChargeLineDto[] · maxItems: 10

Itemised rental charges (decree 87-713).

payment_date

string | null · date

Generate a rent receipt (PDF) › Responses

The generated rent receipt PDF.

string

POST/public/tools/quittance/generate

curl https://api.faireplace.com/api/public/tools/quittance/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "bailleur": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "locataire": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "logement": {
    "adresse": "34 rue de la République",
    "code_postal": "69002",
    "ville": "Lyon",
    "nom": "Appartement T3"
  },
  "periode": {
    "debut": "2026-04-01",
    "fin": "2026-04-30"
  },
  "loyer_hc": 850,
  "charges": [
    {
      "libelle": "Provisions charges",
      "montant": 75
    }
  ],
  "amount_paid": 925,
  "payment_date": "2024-08-25",
  "lieu_signature": "Lyon"
}'

Example Request Body

{
  "bailleur": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "locataire": {
    "nom_prenom": "Camille Richard",
    "adresse": "12 rue de la République",
    "code_postal": "75001",
    "ville": "Paris"
  },
  "logement": {
    "adresse": "34 rue de la République",
    "code_postal": "69002",
    "ville": "Lyon",
    "nom": "Appartement T3"
  },
  "periode": {
    "debut": "2026-04-01",
    "fin": "2026-04-30"
  },
  "loyer_hc": 850,
  "charges": [
    {
      "libelle": "Provisions charges",
      "montant": 75
    }
  ],
  "amount_paid": 925,
  "payment_date": "2024-08-25",
  "lieu_signature": "Lyon"
}

json

Example Responses

string

text

application/pdf

Generate an inspection report (PDF)

POST

https://api.faireplace.com/api

/public/tools/etat-des-lieux/generate

Generates a semi-filled, print-and-complete inspection report (état des lieux) PDF, conform to decree 2016-382.

Accepts the structured payload below, or a simplified payload for AI agents (fields like landlord_name, property_type, tenant_names, rooms); the handler auto-detects and converts it.

Public, unauthenticated tool. Returns application/pdf.

Generate an inspection report (PDF) › Request Body

Inspection report (état des lieux) generator. Produces a semi-filled, print-and-complete document (decree 2016-382). The endpoint also accepts a simplified payload (for AI agents) with fields such as `landlord_name`, `property_type`, `tenant_names`, `rooms`; the handler auto-detects and converts it. The structured form below is the primary contract.

EdlGenerateRequest

edl_type

string · enum · required

"entree" (or "entrée") or "sortie".

Enum values:

entree

sortie

Example: entree

generation_date

string · date · required

Generation date (= physical visit date).

Example: 2026-04-18

EdlPartyDto · required

EdlPartyDto[] · minItems: 1 · maxItems: 4 · required

EdlPropertyDto · required

EdlRoomDto[] · minItems: 1 · maxItems: 15 · required

lieu_signature

string · minLength: 1 · maxLength: 80 · required

is_meuble

boolean

When true, the per-room furniture inventory is rendered.

Default: false

bail_debut

string | null · date

bail_fin

string | null · date

EdlKeyDto[] · maxItems: 10

Generate an inspection report (PDF) › Responses

The generated inspection report PDF.

string

POST/public/tools/etat-des-lieux/generate

curl https://api.faireplace.com/api/public/tools/etat-des-lieux/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "edl_type": "entree",
  "generation_date": "2026-04-18",
  "bailleur": {
    "nom_prenom": "nom_prenom",
    "adresse": "adresse",
    "code_postal": "code_postal",
    "ville": "ville",
    "telephone": "telephone",
    "email": "email"
  },
  "locataires": [
    {
      "nom_prenom": "nom_prenom",
      "adresse": "adresse",
      "code_postal": "code_postal",
      "ville": "ville",
      "telephone": "telephone",
      "email": "email"
    }
  ],
  "logement": {
    "adresse": "adresse",
    "code_postal": "code_postal",
    "ville": "ville",
    "nom": "nom",
    "surface": "surface",
    "type_bien": "type_bien",
    "etage": "etage",
    "batiment": "batiment",
    "numero_lot": "numero_lot"
  },
  "is_meuble": false,
  "bail_debut": "2024-08-25",
  "bail_fin": "2024-08-25",
  "pieces": [
    {
      "nom": "Séjour",
      "surface": "surface",
      "elements": [
        {
          "element_type": "FLOOR",
          "condition": "good",
          "comment": "comment"
        }
      ],
      "mobilier": [
        {
          "nom": "nom",
          "quantite": 1,
          "condition": "condition",
          "notes": "notes"
        }
      ]
    }
  ],
  "clefs": [
    {
      "libelle": "Porte palière",
      "quantite": 2,
      "etat": "etat"
    }
  ],
  "lieu_signature": "Lyon"
}'

Example Request Body

{
  "edl_type": "entree",
  "generation_date": "2026-04-18",
  "bailleur": {
    "nom_prenom": "nom_prenom",
    "adresse": "adresse",
    "code_postal": "code_postal",
    "ville": "ville",
    "telephone": "telephone",
    "email": "email"
  },
  "locataires": [
    {
      "nom_prenom": "nom_prenom",
      "adresse": "adresse",
      "code_postal": "code_postal",
      "ville": "ville",
      "telephone": "telephone",
      "email": "email"
    }
  ],
  "logement": {
    "adresse": "adresse",
    "code_postal": "code_postal",
    "ville": "ville",
    "nom": "nom",
    "surface": "surface",
    "type_bien": "type_bien",
    "etage": "etage",
    "batiment": "batiment",
    "numero_lot": "numero_lot"
  },
  "is_meuble": false,
  "bail_debut": "2024-08-25",
  "bail_fin": "2024-08-25",
  "pieces": [
    {
      "nom": "Séjour",
      "surface": "surface",
      "elements": [
        {
          "element_type": "FLOOR",
          "condition": "good",
          "comment": "comment"
        }
      ],
      "mobilier": [
        {
          "nom": "nom",
          "quantite": 1,
          "condition": "condition",
          "notes": "notes"
        }
      ]
    }
  ],
  "clefs": [
    {
      "libelle": "Porte palière",
      "quantite": 2,
      "etat": "etat"
    }
  ],
  "lieu_signature": "Lyon"
}

json

Example Responses

string

text

application/pdf

Generate a lease amendment (PDF)

POST

https://api.faireplace.com/api

/public/tools/avenant/generate

Generates a lease amendment (avenant) PDF. amendment_type selects the template: GENERIC, RENT, DURATION or TENANT.

Public, unauthenticated tool. Returns application/pdf.

Generate a lease amendment (PDF) › Request Body

Lease amendment generator. `amendment_type` selects the template: `GENERIC` (free amendment), `RENT` (rent revision, Art. 17-1), `DURATION` (duration change) or `TENANT` (tenant change).

AvenantGenerateRequest

amendment_type

string · enum · required

Enum values:

GENERIC

RENT

DURATION

TENANT

Example: RENT

effective_date

string · date · required

DocOwnerDto · required

Landlord identity for a generated document.

DocLesseeDto[] · minItems: 1 · maxItems: 6 · required

DocPropertyDto · required

Rented dwelling for a generated document.

signature_date

string | null · date

lease_id

string | null · maxLength: 40

lease_start_date

string | null · date

lease_end_date

string | null · date

lease_type

string | null · maxLength: 60

description

string | null · maxLength: 2000

Free description (GENERIC / TENANT).

conditions

string | null · maxLength: 2000

previous_amount

string | null · maxLength: 30

RENT — previous rent (formatted string).

new_amount

string | null · maxLength: 30

RENT — new rent (formatted string).

increase_percentage

string | null · maxLength: 20

calculation_method

string | null · maxLength: 120

calculation_details

string | null · maxLength: 300

previous_end_date

string | null · date

DURATION — previous end date.

new_end_date

string | null · date

DURATION — new end date.

extension_type

string | null · maxLength: 60

reason_details

string | null · maxLength: 300

Generate a lease amendment (PDF) › Responses

The generated amendment PDF.

string

POST/public/tools/avenant/generate

curl https://api.faireplace.com/api/public/tools/avenant/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "amendment_type": "RENT",
  "effective_date": "2026-07-01",
  "signature_date": "2024-08-25",
  "lease_id": "lease_id",
  "lease_start_date": "2024-08-25",
  "lease_end_date": "2024-08-25",
  "lease_type": "lease_type",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "description": "description",
  "conditions": "conditions",
  "previous_amount": "previous_amount",
  "new_amount": "new_amount",
  "increase_percentage": "increase_percentage",
  "calculation_method": "calculation_method",
  "calculation_details": "calculation_details",
  "previous_end_date": "2024-08-25",
  "new_end_date": "2024-08-25",
  "extension_type": "extension_type",
  "reason_details": "reason_details"
}'

Example Request Body

{
  "amendment_type": "RENT",
  "effective_date": "2026-07-01",
  "signature_date": "2024-08-25",
  "lease_id": "lease_id",
  "lease_start_date": "2024-08-25",
  "lease_end_date": "2024-08-25",
  "lease_type": "lease_type",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "description": "description",
  "conditions": "conditions",
  "previous_amount": "previous_amount",
  "new_amount": "new_amount",
  "increase_percentage": "increase_percentage",
  "calculation_method": "calculation_method",
  "calculation_details": "calculation_details",
  "previous_end_date": "2024-08-25",
  "new_end_date": "2024-08-25",
  "extension_type": "extension_type",
  "reason_details": "reason_details"
}

json

Example Responses

string

text

application/pdf

Generate a guarantor act (PDF)

POST

https://api.faireplace.com/api

/public/tools/cautionnement/generate

Generates a guarantor act (acte de cautionnement) PDF. Art. 22-1 Loi 89-462 and Art. 2297 Code civil (the maximum guaranteed amount must be given in figures AND words).

Public, unauthenticated tool. Returns application/pdf.

Generate a guarantor act (PDF) › Request Body

Guarantor act (acte de cautionnement) generator. Art. 22-1 Loi 89-462 and Art. 2297 Code civil (amount in figures AND words is mandatory).

CautionnementGenerateRequest

CautionDto · required

DocLesseeDto · required

Tenant identity (name only) for a generated document.

DocOwnerDto · required

Landlord identity for a generated document.

DocPropertyDto · required

Rented dwelling for a generated document.

engagement_type

string · enum · required

Enum values:

SIMPLE

SOLIDAIRE

Example: SOLIDAIRE

duration_type

string · enum · required

Enum values:

DETERMINEE

INDETERMINEE

Example: DETERMINEE

max_amount

string · minLength: 1 · maxLength: 30 · required

Maximum guaranteed amount in figures (mandatory, Art. 2297 CC).

Example: 33 300,00

max_amount_letters

string · minLength: 1 · maxLength: 200 · required

Maximum guaranteed amount in words (mandatory, Art. 2297 CC).

Example: Trente-trois mille trois cents

rent_amount

string · minLength: 1 · maxLength: 30 · required

duration_end

string | null · date

charges_amount

string | null · maxLength: 30

revision

string | null · maxLength: 40

lease_start_date

string | null · date

lease_type

string | null · maxLength: 60

signature_date

string | null · date

signature_city

string | null · maxLength: 80

Generate a guarantor act (PDF) › Responses

The generated guarantor act PDF.

string

POST/public/tools/cautionnement/generate

curl https://api.faireplace.com/api/public/tools/cautionnement/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "caution": {
    "title": "title",
    "first_name": "first_name",
    "last_name": "Durand",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "birth_date": "2024-08-25",
    "birth_place": "birth_place"
  },
  "tenant": {
    "title": "Mme",
    "first_name": "Alice",
    "last_name": "Martin"
  },
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "engagement_type": "SOLIDAIRE",
  "duration_type": "DETERMINEE",
  "duration_end": "2024-08-25",
  "max_amount": "33 300,00",
  "max_amount_letters": "Trente-trois mille trois cents",
  "rent_amount": "850,00",
  "charges_amount": "charges_amount",
  "revision": "revision",
  "lease_start_date": "2024-08-25",
  "lease_type": "lease_type",
  "signature_date": "2024-08-25",
  "signature_city": "signature_city"
}'

Example Request Body

{
  "caution": {
    "title": "title",
    "first_name": "first_name",
    "last_name": "Durand",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "birth_date": "2024-08-25",
    "birth_place": "birth_place"
  },
  "tenant": {
    "title": "Mme",
    "first_name": "Alice",
    "last_name": "Martin"
  },
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "engagement_type": "SOLIDAIRE",
  "duration_type": "DETERMINEE",
  "duration_end": "2024-08-25",
  "max_amount": "33 300,00",
  "max_amount_letters": "Trente-trois mille trois cents",
  "rent_amount": "850,00",
  "charges_amount": "charges_amount",
  "revision": "revision",
  "lease_start_date": "2024-08-25",
  "lease_type": "lease_type",
  "signature_date": "2024-08-25",
  "signature_city": "signature_city"
}

json

Example Responses

string

text

application/pdf

Generate a notice / termination letter (PDF)

POST

https://api.faireplace.com/api

/public/tools/conge/generate

Generates a notice / termination letter PDF. party = locataire (tenant notice) or bailleur (landlord notice). The notice reason and lease kind drive the legal mentions and notice period.

Public, unauthenticated tool. Returns application/pdf.

Generate a notice / termination letter (PDF) › Request Body

Notice / termination letter generator. `party` = `locataire` (tenant notice, Art. 12/15) or `bailleur` (landlord notice, Art. 15 II/III). Notice period is computed client-side; the backend maps the DTO to the Typst template.

CongeGenerateRequest

party

string · enum · required

Enum values:

locataire

bailleur

Example: locataire

notice_reason

string · maxLength: 40 · required

Reason code. Tenant: TENANT_STANDARD, TENSE_ZONE, FIRST_EMPLOYMENT, PROFESSIONAL_TRANSFER, JOB_LOSS, NEW_JOB_AFTER_JOB_LOSS, RSA_BENEFICIARY, AAH_BENEFICIARY, HEALTH_CONDITION, DOMESTIC_VIOLENCE, SOCIAL_HOUSING_ATTRIBUTION. Landlord: SALE, PERSONAL_USE, LEGITIMATE_REASON.

Example: TENANT_STANDARD

lease_kind

string · enum · required

Lease type, drives the notice-period computation.

Enum values:

vide

meuble

etudiant

mobilite

Example: vide

notice_date

string · date · required

Tenant — LRAR reception date. Landlord — letter drafting date.

Example: 2026-06-01

DocOwnerDto · required

Landlord identity for a generated document.

DocLesseeDto[] · minItems: 1 · maxItems: 6 · required

DocPropertyDto · required

Rented dwelling for a generated document.

lease_end_date

string | null · date

Landlord only — lease term (notice effective date).

delivery_method

string | null · maxLength: 120

tracking_number

string | null · maxLength: 80

reduced_notice_justification

string | null · maxLength: 500

sale_price

string | null · maxLength: 40

Landlord, sale notice (Art. 15 II).

sale_conditions

string | null · maxLength: 500

tenant_preemption_expires_at

string | null · maxLength: 40

beneficiary_name

string | null · maxLength: 120

Landlord, repossession (Art. 15 I).

beneficiary_address

string | null · maxLength: 200

beneficiary_relationship

string | null · maxLength: 80

reprise_justification

string | null · maxLength: 500

legitimate_reason_detail

string | null · maxLength: 500

tenant_income_eligible

boolean | null

Landlord — elderly-tenant protection (Art. 15 III).

rehousing_offer

string | null · maxLength: 300

Generate a notice / termination letter (PDF) › Responses

The generated notice letter PDF.

string

POST/public/tools/conge/generate

curl https://api.faireplace.com/api/public/tools/conge/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "party": "locataire",
  "notice_reason": "TENANT_STANDARD",
  "lease_kind": "vide",
  "notice_date": "2026-06-01",
  "lease_end_date": "2024-08-25",
  "delivery_method": "delivery_method",
  "tracking_number": "tracking_number",
  "reduced_notice_justification": "reduced_notice_justification",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "sale_price": "sale_price",
  "sale_conditions": "sale_conditions",
  "tenant_preemption_expires_at": "tenant_preemption_expires_at",
  "beneficiary_name": "beneficiary_name",
  "beneficiary_address": "beneficiary_address",
  "beneficiary_relationship": "beneficiary_relationship",
  "reprise_justification": "reprise_justification",
  "legitimate_reason_detail": "legitimate_reason_detail",
  "tenant_income_eligible": true,
  "rehousing_offer": "rehousing_offer"
}'

Example Request Body

{
  "party": "locataire",
  "notice_reason": "TENANT_STANDARD",
  "lease_kind": "vide",
  "notice_date": "2026-06-01",
  "lease_end_date": "2024-08-25",
  "delivery_method": "delivery_method",
  "tracking_number": "tracking_number",
  "reduced_notice_justification": "reduced_notice_justification",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "sale_price": "sale_price",
  "sale_conditions": "sale_conditions",
  "tenant_preemption_expires_at": "tenant_preemption_expires_at",
  "beneficiary_name": "beneficiary_name",
  "beneficiary_address": "beneficiary_address",
  "beneficiary_relationship": "beneficiary_relationship",
  "reprise_justification": "reprise_justification",
  "legitimate_reason_detail": "legitimate_reason_detail",
  "tenant_income_eligible": true,
  "rehousing_offer": "rehousing_offer"
}

json

Example Responses

string

text

application/pdf

Generate a furniture inventory (PDF)

POST

https://api.faireplace.com/api

/public/tools/inventaire-mobilier/generate

Generates the furniture & equipment inventory PDF (mandatory annex of a furnished lease, decree 2015-981, Art. 25-4 Loi 89-462).

Public, unauthenticated tool. Returns application/pdf.

Generate a furniture inventory (PDF) › Request Body

Furniture & equipment inventory generator (mandatory annex of a furnished lease, decree 2015-981, Art. 25-4 Loi 89-462).

InventaireGenerateRequest

InventaireEstateDto · required

InventaireOwnerDto · required

InventaireLesseeDto[] · minItems: 1 · maxItems: 6 · required

InventaireItemDto[] · minItems: 1 · maxItems: 200 · required

lease_start_date

string | null · date

lease_end_date

string | null · date

Generate a furniture inventory (PDF) › Responses

The generated furniture inventory PDF.

string

POST/public/tools/inventaire-mobilier/generate

curl https://api.faireplace.com/api/public/tools/inventaire-mobilier/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "estate": {
    "name": "name",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "estate_type": "estate_type"
  },
  "owner": {
    "title": "title",
    "first_name": "first_name",
    "last_name": "last_name",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "phone": "phone",
    "email": "email"
  },
  "lessees": [
    {
      "title": "title",
      "first_name": "first_name",
      "last_name": "last_name",
      "phone": "phone",
      "email": "email"
    }
  ],
  "lease_start_date": "2024-08-25",
  "lease_end_date": "2024-08-25",
  "inventory_items": [
    {
      "room_name": "Salon",
      "name": "Canapé 3 places",
      "brand": "brand",
      "model": "model",
      "type_name": "type_name",
      "category_name": "category_name",
      "quantity": 1,
      "condition": "Bon état",
      "condition_notes": "condition_notes"
    }
  ]
}'

Example Request Body

{
  "estate": {
    "name": "name",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "estate_type": "estate_type"
  },
  "owner": {
    "title": "title",
    "first_name": "first_name",
    "last_name": "last_name",
    "address": "address",
    "postal_code": "postal_code",
    "city": "city",
    "phone": "phone",
    "email": "email"
  },
  "lessees": [
    {
      "title": "title",
      "first_name": "first_name",
      "last_name": "last_name",
      "phone": "phone",
      "email": "email"
    }
  ],
  "lease_start_date": "2024-08-25",
  "lease_end_date": "2024-08-25",
  "inventory_items": [
    {
      "room_name": "Salon",
      "name": "Canapé 3 places",
      "brand": "brand",
      "model": "model",
      "type_name": "type_name",
      "category_name": "category_name",
      "quantity": 1,
      "condition": "Bon état",
      "condition_notes": "condition_notes"
    }
  ]
}

json

Example Responses

string

text

application/pdf

Generate an unpaid-rent reminder (PDF)

POST

https://api.faireplace.com/api

/public/tools/relance-impaye/generate

Generates an unpaid-rent reminder / formal notice PDF (Art. 7a & 24 Loi 89-462). reminder_type: FRIENDLY, FORMAL_NOTICE or PAYMENT_ORDER.

Public, unauthenticated tool. Returns application/pdf.

Generate an unpaid-rent reminder (PDF) › Request Body

Unpaid-rent reminder / formal notice generator (Art. 7a & 24 Loi 89-462). `reminder_type`: FRIENDLY (amicable), FORMAL_NOTICE (mise en demeure) or PAYMENT_ORDER (commandement — bailiff act).

RelanceImpayeGenerateRequest

reminder_type

string · enum · required

Enum values:

FRIENDLY

FORMAL_NOTICE

PAYMENT_ORDER

Example: FORMAL_NOTICE

DocOwnerDto · required

Landlord identity for a generated document.

RelanceLesseeDto[] · minItems: 1 · maxItems: 6 · required

DocPropertyDto · required

Rented dwelling for a generated document.

RelancePeriodDto[] · minItems: 1 · maxItems: 24 · required

due_amount

string · minLength: 1 · maxLength: 30 · required

Total amount due, pre-formatted client-side (the template adds €).

Example: 1 700,00

delivery_method

string | null · maxLength: 20

tracking_number

string | null · maxLength: 80

notes

string | null · maxLength: 600

Generate an unpaid-rent reminder (PDF) › Responses

The generated reminder PDF.

string

POST/public/tools/relance-impaye/generate

curl https://api.faireplace.com/api/public/tools/relance-impaye/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "reminder_type": "FORMAL_NOTICE",
  "delivery_method": "delivery_method",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "title",
      "first_name": "first_name",
      "last_name": "last_name",
      "address": "address",
      "postal_code": "postal_code",
      "city": "city"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "periods": [
    {
      "start": "2026-04-01",
      "end": "2026-04-30"
    }
  ],
  "due_amount": "1 700,00",
  "tracking_number": "tracking_number",
  "notes": "notes"
}'

Example Request Body

{
  "reminder_type": "FORMAL_NOTICE",
  "delivery_method": "delivery_method",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "title",
      "first_name": "first_name",
      "last_name": "last_name",
      "address": "address",
      "postal_code": "postal_code",
      "city": "city"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "periods": [
    {
      "start": "2026-04-01",
      "end": "2026-04-30"
    }
  ],
  "due_amount": "1 700,00",
  "tracking_number": "tracking_number",
  "notes": "notes"
}

json

Example Responses

string

text

application/pdf

Generate a mutual lease-termination agreement (PDF)

POST

https://api.faireplace.com/api

/public/tools/resiliation-amiable/generate

Generates a mutual lease-termination agreement PDF (Art. 1193 Code civil), recalling the legal move-out obligations.

Public, unauthenticated tool. Returns application/pdf.

Generate a mutual lease-termination agreement (PDF) › Request Body

Mutual lease-termination agreement generator (Art. 1193 Code civil), recalling the legal move-out obligations (Loi 89-462 Art. 3-2, 22, 23).

ResiliationGenerateRequest

effective_date

string · date · required

Termination effective date (move-out).

Example: 2026-08-31

DocOwnerDto · required

Landlord identity for a generated document.

DocLesseeDto[] · minItems: 1 · maxItems: 6 · required

DocPropertyDto · required

Rented dwelling for a generated document.

notice_date

string | null · date

Agreement signature date. Defaults to today.

notes

string | null · maxLength: 1500

Particular provisions (Article 4 of the agreement).

Generate a mutual lease-termination agreement (PDF) › Responses

The generated termination agreement PDF.

string

POST/public/tools/resiliation-amiable/generate

curl https://api.faireplace.com/api/public/tools/resiliation-amiable/generate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "effective_date": "2026-08-31",
  "notice_date": "2024-08-25",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "notes": "notes"
}'

Example Request Body

{
  "effective_date": "2026-08-31",
  "notice_date": "2024-08-25",
  "owner": {
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SCI Les Tilleuls",
    "address": "12 rue de la République",
    "postal_code": "75001",
    "city": "Paris"
  },
  "lessees": [
    {
      "title": "Mme",
      "first_name": "Alice",
      "last_name": "Martin"
    }
  ],
  "property": {
    "address": "34 rue de la République",
    "postal_code": "69002",
    "city": "Lyon"
  },
  "notes": "notes"
}

json

Example Responses

string

text

application/pdf

Generate the tenant information notice (PDF)

POST

https://api.faireplace.com/api

/public/tools/notice-information/generate

Generates the standard tenant information notice (notice d'information) PDF. No request body. Public, unauthenticated tool. Returns application/pdf.

Generate the tenant information notice (PDF) › Responses

The tenant information notice PDF.

string

Generate the tenant repairs list (PDF)

POST

https://api.faireplace.com/api

/public/tools/reparations-locatives/generate

Generates the standard tenant-repairs list (réparations locatives) PDF. No request body. Public, unauthenticated tool. Returns application/pdf.

Generate the tenant repairs list (PDF) › Responses

The tenant repairs list PDF.

string

Generate the wear-and-tear grid (PDF)

POST

https://api.faireplace.com/api

/public/tools/grille-vetuste/generate

Generates the standard wear-and-tear grid (grille de vétusté) PDF. No request body. Public, unauthenticated tool. Returns application/pdf.

Generate the wear-and-tear grid (PDF) › Responses

The wear-and-tear grid PDF.

string

Generate the recoverable charges list (PDF)

POST

https://api.faireplace.com/api

/public/tools/charges-recuperables/generate

Generates the standard recoverable charges list (charges récupérables, decree 87-713) PDF. No request body. Public, unauthenticated tool. Returns application/pdf.

Generate the recoverable charges list (PDF) › Responses

The recoverable charges list PDF.

string

Rent Revisions Guest Signature