Quickstart
Guides
API Reference
faireplace.com
Information
Health
Health check
get
Contacts
List contacts
get
Create contact
post
Get contact
get
Update contact
put
Delete contact
delete
Search contacts
get
Filter contacts
post
Get contacts by category
get
Get contacts by type
get
Create contacts in bulk
post
Delete contacts in bulk
delete
List contact roles
get
Get contact entities
get
Get contact by role
get
List contacts linked to a place
get
Link a contact to a place
post
Unlink a contact from a place
delete
List contacts linked to an estate
get
Link a contact to an estate
post
Unlink a contact from an estate
delete
Estates
List estates for place
get
Create estate for place
post
Get estate by ID
get
Update estate
put
Delete estate
delete
List all estates
get
Get estate by ID
get
Update estate
put
Delete estate
delete
Leases
List all leases where the user is a tenant
get
List leases pending signature for the tenant
get
Get details of a specific lease for the tenant
get
Get signature status of a lease for the tenant
get
Sign a lease as a tenant
post
Download the signed lease (PDF)
get
List lessees associated with a lease
get
Associate a lessee with a lease
post
List active lessees for a lease
get
Get a lease-lessee association
get
Update a lease-lessee association
put
Delete a lease-lessee association
delete
End a lessee's term
put
List all leases
get
Create a lease
post
Get lease
get
Update lease
put
Delete lease
delete
Change lease status
put
Update lease rent
put
Check legal compliance of a lease
get
List leases for a property
get
Check and apply legal compliance
post
Expose Typst template data
get
List lease documents
get
Add a document to a lease
post
Get lease document
get
Update lease document
put
Delete a document associated with a lease
delete
List lease amendments
get
Create a lease amendment
post
Get a lease amendment
get
Update a lease amendment
put
Delete a lease amendment
delete
Change amendment status
put
Generate amendment PDF
post
Initiate amendment electronic signature
post
Finalize amendment signature
post
Get security deposit details
get
Record a security deposit
post
Delete a security deposit
delete
Return a security deposit
post
Generate rent receipts
post
List rent receipts
get
Get a rent receipt
get
Delete a rent receipt
delete
Download rent receipt PDF
get
List charges of a lease
get
Create a lease charge
post
Get lease charge
get
Update lease charge
put
Delete a lease charge
delete
Regularize charge
post
Bulk end-of-lease charge regularization
post
List charge reviews
get
Create a charge review
post
Get a charge review
get
Update a charge review
put
Delete a charge review
delete
Transition review status
post
List review details
get
Create a review detail
post
Get a review detail
get
Update a review detail
put
Delete a review detail
delete
List charge legal documents
get
Create a charge legal document
post
Get a charge legal document
get
Update a charge legal document
put
Delete a charge legal document
delete
List charge notifications
get
Create a charge notification
post
Get a charge notification
get
Update a charge notification
put
Delete a charge notification
delete
List charge regulations
get
Create a charge regulation
post
Get a charge regulation
get
Update a charge regulation
put
Delete a charge regulation
delete
List charge audit log entries
get
List charge meters
get
Create a charge meter
post
Get a charge meter
get
Update a charge meter
put
Delete a charge meter
delete
Calculate meter-based charge
post
List lease meters
get
Create a lease meter
post
Get a lease meter
get
Update a lease meter
put
Delete a lease meter
delete
Generate a lease PDF
post
List lease PDFs
get
Download a lease PDF
get
Delete a lease PDF
delete
Initiate electronic signature (global level)
post
Get signature status (global route - deprecated)
get
Status of a specific document
get
List all contracts pending signature
get
Signature contract details
get
Request a signature (send OTP) - Global route
post
Reset a signature (global route)
delete
Cancel a signature (global route)
delete
Resend signature request (global route)
post
Process a signature event
post
Initiate signature for a specific lease
post
Signature status of a lease
get
Status of a specific signature document
get
Request a signature - Send an OTP via SMS
post
Validate OTP and apply electronic signature
post
Process a signature event for a lease
post
Cancel a signature request
delete
Fully reset a signature
delete
Resend signature request for a signer
post
Get eIDAS signature proof
get
Create a payment intent for a lease
post
Create Stripe Checkout session
post
Confirm payment with Stripe session
post
Payment status for lease signing
get
Ingest a public bail draft
post
Signatures
List leases pending signature for the tenant
get
Get signature status of a lease for the tenant
get
Sign a lease as a tenant
post
Download the signed lease (PDF)
get
Get eIDAS signature proof (tenant)
get
Initiate electronic signature (global level)
post
Get signature status (global route - deprecated)
get
Status of a specific document
get
List all contracts pending signature
get
Signature contract details
get
Request a signature (send OTP) - Global route
post
Reset a signature (global route)
delete
Cancel a signature (global route)
delete
Resend signature request (global route)
post
Process a signature event
post
Initiate signature for a specific lease
post
Signature status of a lease
get
Status of a specific signature document
get
Request a signature - Send an OTP via SMS
post
Validate OTP and apply electronic signature
post
Process a signature event for a lease
post
Cancel a signature request
delete
Fully reset a signature
delete
Resend signature request for a signer
post
Get eIDAS signature proof
get
Complete an individual signature (Worker)
post
Finalize a signature document (Worker)
post
Workers
Complete an individual signature (Worker)
post
Finalize a signature document (Worker)
post
Lessees
List all lessees
get
Create a new lessee
post
Get lessee by ID
get
Update lessee
put
Delete lessee
delete
Get lessees by type
get
Create multiple lessees
post
Delete multiple lessees
delete
List all leases where the user is a tenant
get
List leases pending signature for the tenant
get
Get details of a specific lease for the tenant
get
Get signature status of a lease for the tenant
get
Sign a lease as a tenant
post
Download the signed lease (PDF)
get
Get eIDAS signature proof (tenant)
get
Update lessee profile
put
List lessees associated with a lease
get
Associate a lessee with a lease
post
List active lessees for a lease
get
Get a lease-lessee association
get
Update a lease-lessee association
put
Delete a lease-lessee association
delete
End a lessee's term
put
Owners
List owners
get
Create owner
post
Get owner
get
Update owner
put
Delete owner
delete
Delete owners in bulk
delete
Get owner by place
get
Get owner by estate
get
Start an owner claim
post
Places
List places
get
Create place
post
Get place
get
Update place
put
Delete place
delete
List place services
get
Remove service from place
delete
Rooms
List rooms for estate
get
Create room for estate
post
Get room by ID
get
Update room
put
Delete room
delete
Equipment
List all equipment
get
Create equipment
post
Get equipment by ID
get
Update equipment
put
Delete equipment
delete
List equipment for place
get
Add equipment to place
post
Remove equipment from place
delete
List equipment for estate
get
Add equipment to estate
post
Remove equipment from estate
delete
List equipment for room
get
Add equipment to room
post
Remove equipment from room
delete
Inventory
List all inventory items
get
Create a new inventory item
post
Get inventory item by ID
get
Update inventory item
put
Delete inventory item
delete
List inventory items with details
get
Get inventory item with details
get
List inventory items needing maintenance
get
List inventory items by type
get
List inventory items by condition
get
Search inventory items
get
List inventory categories
get
Create a new inventory category
post
Get inventory category by ID
get
Update inventory category
put
Delete inventory category
delete
List inventory types
get
Create a new inventory type
post
Get inventory type by ID
get
Update inventory type
put
Delete inventory type
delete
List room inventory
get
Add an inventory item to a room
post
Create inventory and link it to a room
post
List room inventory with details
get
Update an inventory item in a room
put
Remove an inventory item from a room
delete
List rooms containing an inventory item
get
List rooms containing an inventory item with details
get
List active inventory types
get
List inventory types by category
get
List inventory types
get
Create an inventory type
post
Get an inventory type
get
Update an inventory type
put
Delete an inventory type
delete
Keys
List keys for a property
get
Create a new key
post
Get key by ID
get
Update key
put
Delete key
delete
Hand over a key
post
Return a key
post
Mark a key as lost
post
Mark a key as found
post
Mark a key as damaged
post
Archive a key
post
Types
List place types
get
Create a new place type
post
List property types
get
Create a new property type
post
List room types
get
Create a new room type
post
List equipment types
get
Create a new equipment type
post
List active inventory types
get
List inventory types by category
get
List inventory types
get
Create an inventory type
post
Get an inventory type
get
Update an inventory type
put
Delete an inventory type
delete
Media
Upload media and attach to entity
post
List media attached to an entity
get
Search media by tags (optionally scoped to an entity)
get
Replace media tags
put
Assign a unique role to a media for an entity
put
Get media by role for an entity
get
Clear role assignment for an entity
delete
Serve media (JSON for unencrypted, binary for encrypted)
get
Download media as a binary stream
get
Delete media (S3 object and DB record)
delete
Serve media for workers (Base64 JSON)
get
Upload signed PDF from worker
post
Rent Regulation & Rent Control
Check rent regulation by postal code
post
Get rent regulation data by INSEE code
get
Check rent control compliance
post
Get administrative quarter from address
get
Get reference rent for a quarter and parameters
get
List supported territories for rent control
get
List rent indices
get
Create a rent index
post
Get latest rent index value
get
Get a rent index
get
Update a rent index
put
Delete a rent index
delete
List rent index values
get
Create a rent index value
post
Lease Types
List all lease types
get
Create a new lease type
post
Get lease type by ID
get
Update lease type
put
Delete lease type
delete
List templates for a lease type
get
Create a template for a lease type
post
List templates by type
get
Get active template by type
get
Get default template by type
get
Get specific template
get
Update template
put
Delete template
delete
Get charge configuration
get
Update charge configuration
put
Create charge configuration
post
Delete charge configuration
delete
Get a lease type charge configuration
get
Update a lease type charge configuration
put
Delete a lease type charge configuration
delete
Energy Diagnosis
List all energy performance diagnoses
get
Create an energy performance diagnosis
post
Get energy performance diagnosis by ID
get
Update energy performance diagnosis
put
Delete energy performance diagnosis
delete
List energy performance diagnoses for a place
get
List energy performance diagnoses for a property
get
Estate Diagnostics
List diagnostics for an estate
get
Create an estate diagnostic
post
Get estate diagnostic by ID
get
Update estate diagnostic
put
Delete estate diagnostic
delete
Meters
List meters
get
Create a meter
post
Get a meter
get
Update a meter
put
Delete a meter
delete
List sub-meters
get
List meter readings
get
Create a meter reading
post
Get latest meter reading
get
Get a meter reading
get
Update a meter reading
put
Delete a meter reading
delete
List meters for a place
get
List meters for an estate
get
List meters for a place-estate combination
get
Charges
List all freeze periods
get
Create a freeze period
post
Get a freeze period
get
Update a freeze period
put
Delete a freeze period
delete
List distribution references
get
Create a distribution reference
post
Get a distribution reference
get
Update a distribution reference
put
Delete a distribution reference
delete
List all charge readings
get
Create a global charge reading
post
Get a charge reading
get
Update a charge reading
put
Delete a charge reading
delete
Validate a charge reading
get
List charge readings
get
Create charge reading
post
Get charge reading
get
Update charge reading
put
Delete charge reading
delete
Validate charge reading
post
List regularization installments
get
Create installment schedule
post
Delete all installments for lease
delete
Get installment
get
Update installment
put
List distribution references for a lease
get
Create a distribution reference for a lease
post
Get a lease distribution reference
get
Update a lease distribution reference
put
Delete a lease distribution reference
delete
Calculate meter-based charge
post
Calculate a charge distribution
post
Services
List service charge categories
get
Create service charge category
post
Get service charge category
get
Update service charge category
put
Delete service charge category
delete
List charge distribution keys
get
Create a charge distribution key
post
Get charge distribution key
get
Update charge distribution key
put
Delete charge distribution key
delete
List filtered distribution keys
get
Calculate charge distribution
post
Check distribution key name uniqueness
get
Credits
Create a payment intent for a lease
post
Create Stripe Checkout session
post
Confirm payment with Stripe session
post
Payment status for lease signing
get
Verify a 3DS payment
post
Purchase credits
post
Get credit balance
get
Get transaction history
get
List available credit packages
get
Lease Annexes
List annexes du catalogue
get
Recuperer une annexe systeme
get
Telecharger le fichier d'une annexe systeme
get
List annexes d'un bail
get
Attacher une annexe a un bail
post
Reorganiser l'ordre des annexes
put
Attacher les annexes obligatoires
post
Verifier la conformite des annexes
get
Recuperer une annexe de bail
get
Mettre a jour une annexe de bail
put
Delete annexe de bail
delete
Telecharger le PDF d'une annexe
get
Review the signature dossier
get
Webhooks
Stripe Webhook - Event reception
post
Mandates
List mandates
get
Create a mandate
post
Get a mandate
get
Attach a document to a mandate
post
Activate a mandate
post
Revoke a mandate
post
Countries
List countries
get
Get a country by ID
get
Get a country by ISO code
get
Coupons
Validate a coupon
post
Redeem a coupon
post
Usage
Get usage summary
get
Rent Revisions
Simulate a rent revision
post
List rent revisions
get
Record a rent revision
post
Get a rent revision
get
Apply a rent revision
put
Public Tools
Simulate a rent revision (explicit IRL values)
post
Simulate a rent revision (server-resolved IRL values)
post
List IRL quarter values
get
Get the latest published IRL value
get
Calculate a security-deposit restitution
post
Generate a security-deposit restitution receipt (PDF)
post
List rent-control territories
get
Resolve the administrative quarter for an address
get
Get the reference rent for a quarter
get
Check a proposed rent against rent control
post
Check property risks for an address
post
Simulate rental yield across tax regimes
post
Get default referentials for the landing wizard
get
Get the default lease template for a lease type
get
Deposit an anonymous lease draft
post
Generate a rent receipt (PDF)
post
Generate an inspection report (PDF)
post
Generate a lease amendment (PDF)
post
Generate a guarantor act (PDF)
post
Generate a notice / termination letter (PDF)
post
Generate a furniture inventory (PDF)
post
Generate an unpaid-rent reminder (PDF)
post
Generate a mutual lease-termination agreement (PDF)
post
Generate the tenant information notice (PDF)
post
Generate the tenant repairs list (PDF)
post
Generate the wear-and-tear grid (PDF)
post
Generate the recoverable charges list (PDF)
post
Guest Signature
View a guest signature session
get
Download the guest signature PDF
get
Request an OTP for the guest signature
post
Submit OTP and apply the guest signature
post
Owner Claim
View owner claim details
get
Confirm an owner claim
post
Start an owner claim
post
Syndic Management
List all syndics
get
Get a syndic by ID
get
Update a syndic
put
Delete a syndic
delete
Get syndic for an estate
get
Create a syndic for an estate
post
Syndic Fund Calls
List fund calls for a syndic
get
Create a fund call with lines
post
Get a fund call with its lines
get
Delete a fund call
delete
Record a payment for a fund call
post
Syndic Fund Allocations
Allocate fund call to leases
post
List allocations for a fund call
get
Link syndic allocations to lease charges
post
List syndic allocations for a lease
get
Templates
List templates for a lease type
get
Create a template for a lease type
post
List templates by type
get
Get active template by type
get
Get default template by type
get
Get specific template
get
Update template
put
Delete template
delete
Charge Configuration
Get charge configuration
get
Update charge configuration
put
Create charge configuration
post
Delete charge configuration
delete
Amendment Validations
List all validations for an amendment
get
Create a validation entry
post
Compute aggregate validation status
get
Get a specific validation entry
get
Update a validation entry (approve/reject)
put
Delete a validation entry
delete
Amendment Rent Details
Get rent modification details
get
Update rent modification details
put
Create rent modification details
post
Delete rent modification details
delete
Amendment Duration Details
Get duration modification details
get
Update duration modification details
put
Create duration modification details
post
Delete duration modification details
delete
Amendment Documents
List amendment documents
get
Attach a document to an amendment
post
Get a specific document
get
Update an amendment document
put
Delete an amendment document
delete
Validate an amendment document
put
Amendment History
List amendment history
get
Get a specific history entry
get
Amendment Notifications
List notifications for an amendment
get
Get a specific notification
get
Update notification status
put
Delete a notification
delete
Documents
Generate a lease PDF
post
List lease PDFs
get
Download a lease PDF
get
Delete a lease PDF
delete
PDF
Generate a lease PDF
post
List lease PDFs
get
Download a lease PDF
get
Delete a lease PDF
delete
Rent Payments
List rent payments
get
Record a rent payment
post
Get tenant balance
get
Generate payment schedule
post
Get a rent payment
get
Update a rent payment
put
Delete a rent payment
delete
Condition Reports
List condition reports
get
Create a condition report
post
Compare entry vs exit reports
get
Get condition report details
get
Update condition report metadata
put
Delete condition report
delete
Mark condition report as completed
put
Batch upsert room element conditions
put
Record meter snapshots
post
Record key handover snapshots
post
Generate condition report PDF
post
Initiate eIDAS signature
post
Finalize signature
post
Lease Notices
List lease notices
get
Create a lease notice
post
Compute notice dates
get
Get a lease notice
get
Update a lease notice
put
Delete a lease notice
delete
Generate notice letter PDF
post
Mark notice as sent
put
Mark notice as received
put
Lease Termination
Get termination status
get
Initiate lease termination from notice
post
Initiate termination from natural expiration
post
Transition to finalisation phase
put
Register exit condition report
put
Check a checklist item
put
Uncheck a checklist item
delete
Calculate deposit settlement
put
Complete the termination process
put
Force terminate a lease
put
Archive a lease
put
List archived leases
get
Regularize charges for a termination
put
Rent Reminders
List rent reminders
get
Create a rent reminder
post
Get a rent reminder
get
Update a rent reminder
put
Delete a rent reminder
delete
Generate reminder letter PDF
post
Mark reminder as sent
put
Payments
Purchase credits
post
Stripe
Stripe Webhook - Event reception
post
Schemas
powered by Zudoku
Menu
FairePlace Property Management API
FairePlace Property Management API
Health
API health check endpoints
Health check
GET
https://api.faireplace.com/api
/health
Check if the API is running
Health check ›
Responses
200
API is healthy
status
string
Contacts
