Property Management

Copy page

Key Management

Track physical keys throughout their lifecycle — from creation to archival.

Key lifecycle

Code
 
Created → Rendered → Returned → Archived
                 │
                 ├──► Lost
                 ├──► Found
                 └──► Damaged

Keys are associated with an estate and track who holds them, when they were handed over, and their current condition.

Create a key

Code
 
curl -X POST https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Cle porte entree",
    "type": "Door",
    "quantity": 3,
    "description": "3 copies of front door key"
  }'

Code
 
{
  "id": "key-aabb1122-3344-5566-7788-99aabbccddee",
  "estate_id": "estate-3c4d5e6f-7890-abcd-ef12-34567890abcd",
  "label": "Cle porte entree",
  "type": "Door",
  "quantity": 3,
  "status": "Created",
  "created_at": "2026-02-20T10:00:00Z"
}

Key types

Type	Description
Door	Front door, apartment door
Mailbox	Mailbox key
Garage	Garage or parking key
Basement	Basement/cellar key
Gate	Building gate key
Badge	Electronic badge or access card
Other	Other key type

Key statuses

Status	Description
Created	Key registered in the system
Rendered	Key handed over to the tenant
Returned	Key returned by the tenant
Lost	Key reported lost
Found	Previously lost key recovered
Damaged	Key reported damaged
Archived	Key no longer in use

Update key status

Code
 
curl -X PATCH https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/keys/{key_id} \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "Rendered",
    "rendered_to": "lessee-5e6f7890-abcd-ef12-3456-7890abcdef12",
    "rendered_at": "2026-04-01T09:00:00Z"
  }'

List keys for an estate

Code
 
curl https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/keys \
  -H "Authorization: Bearer $TOKEN"

Code
 
{
  "data": [
    {
      "id": "key-aabb1122-3344-5566-7788-99aabbccddee",
      "label": "Cle porte entree",
      "type": "Door",
      "quantity": 3,
      "status": "Rendered"
    },
    {
      "id": "key-ccdd3344-5566-7788-99aa-bbccddeeff00",
      "label": "Cle boite aux lettres",
      "type": "Mailbox",
      "quantity": 1,
      "status": "Rendered"
    }
  ]
}

Keys in the lease document

Keys are automatically included in the generated lease PDF. The key inventory appears in the entry/exit inspection section (etat des lieux).

When generating a lease PDF, all keys with status Rendered for the estate are listed with their type, quantity, and handover date.

---

Related

• Property Overview — Property hierarchy
• Estates API — Manage rental units
• Lease Workflow — End-to-end lease creation