From zero to signed lease in 6 API calls

Get an API key, create a property, generate a lease, and collect eIDAS signatures — all copy-paste ready.

Code
# 1. Set your API key
export API_KEY="fp_your_api_key_here"

# 2. Create an owner
curl -X POST https://api.faireplace.com/api/owners \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Jean", "last_name": "Dupont", "owner_category": "individual", "email": "jean@example.com", "mobile_phone": "+33612345678"}'

# 3. Create a building + apartment
PLACE=$(curl -s -X POST https://api.faireplace.com/api/places \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Residence Les Jardins", "owner_id": "<owner_id>", "postal_code": "75012", "city": "Paris"}' | jq -r '.id')

curl -X POST https://api.faireplace.com/api/places/$PLACE/estates \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"area": 45.0, "number_of_room": 2, "floor": 3}'

# 4. Create a lease
curl -X POST https://api.faireplace.com/api/leases \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"estate_id": "<estate_id>", "rent_amount": 950.00, "deposit_amount": 950.00, "start_date": "2026-04-01", "end_date": "2029-03-31"}'

# 5. Generate the PDF
curl -X POST https://api.faireplace.com/api/leases/<lease_id>/pdf \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template_type": "StandardLease"}'

# 6. Collect signatures (OTP via SMS)
curl -X POST https://api.faireplace.com/api/leases/<lease_id>/signature/initiate \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pdf_id": "<pdf_id>", "signers": [{"signer_type": "PROPRIETAIRE", "first_name": "Jean", "last_name": "Dupont", "email": "jean@example.com", "phone": "+33612345678"}]}'