Keys

Create a new key

Creates a new key for a property

post/places/{place_id}/estates/{estate_id}/keys

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/keys
  • Auth: HTTP bearer

Path parameters

place_idstring uuid required

place ID

estate_idstring uuid required

property ID

Request body

key_type'CLEF' | 'BADGE_MAGNETIQUE' | 'BADGE_RF' | 'BIOMETRIQUE' | 'CLEF_DUPLIQUEE' | 'TELECOMMANDE' required

Key or access badge type

descriptionstring required

Key description

brandstring nullable

Key or badge brand

key_numberstring nullable

Key or badge number

quantityinteger

Key quantity

protected_codestring nullable

Key protection code

security_level'LOW' | 'STANDARD' | 'MEDIUM' | 'HIGH' | 'CRITICAL' required

Key security level

access_restrictionsstring nullable

Access restrictions

emergency_contactstring nullable

Emergency contact

notesstring nullable

Internal notes about the key

Example request

{
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "notes": "Enhanced security key"
}

Response

Key created successfully

idstring uuid required

Unique key identifier

tenant_idstring required

Tenant ID (multi-tenant isolation)

estate_idstring uuid required

Property ID

key_type'CLEF' | 'BADGE_MAGNETIQUE' | 'BADGE_RF' | 'BIOMETRIQUE' | 'CLEF_DUPLIQUEE' | 'TELECOMMANDE' required

Key or access badge type

descriptionstring nullable

Key description

brandstring nullable

Key or badge brand

key_numberstring nullable

Key or badge number

quantityinteger nullable

Key quantity

protected_codestring nullable

Key protection code

status'ACTIVE' | 'RENDERED' | 'LOST' | 'STOLEN' | 'DAMAGED' | 'REPLACED' | 'ARCHIVED' required

Key status

security_level'LOW' | 'STANDARD' | 'MEDIUM' | 'HIGH' | 'CRITICAL' required

Key security level

access_restrictionsstring nullable

Access restrictions

emergency_contactstring nullable

Emergency contact

is_renderedboolean required

Indicates whether the key has been returned

notesstring nullable

Internal notes about the key

rendered_tostring nullable

Person to whom the key was handed over

rendered_bystring nullable

Person who handed over the key

rendered_atstring date-time nullable

Date and time when the key was handed over

expected_return_datestring date-time nullable

Expected key return date

purposestring nullable

Reason for handing over the key

last_status_change_atstring date-time nullable

Date and time of the last status change

last_status_change_bystring nullable

Person who made the last status change

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.