FairePlace Property Management API

Lessees

Endpointhttps://api.faireplace.com/api

Tenant management.

Dedicated tenant endpoints

The endpoints under /lessee/leases are specifically designed to allow tenants to:

View their own leases
Sign their leases electronically
Download signed leases

These endpoints require specific permissions:

lessee:leases:read - To view leases
lessee:leases:sign - To sign leases
lessee:leases:download - To download signed leases

List all lessees

GET

https://api.faireplace.com/api

/lessees

Retrieves the list of all lessees with pagination and filters

List all lessees › query Parameters

q

string

General search term

Example: Jean Dupont

category

string · enum

Filter by lessee category

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

email

string · email

Filter by email address

phone

string

Filter by phone number

city

string

Filter by city

has_income

boolean

Filter by income presence

min_income

number · decimal · min: 0

Minimum income

max_income

number · decimal · min: 0

Maximum income

page

integer · min: 1

Page number

Default: 1

limit

integer · min: 1 · max: 100

Number of items per page

Default: 20

List all lessees › Responses

Lessee list retrieved successfully

Paginated response for the lessee list

object[] · required

Lessees list

total

integer · required

Total number of lessees

Example: 10

page

integer · required

Current page number

Example: 1

limit

integer · required

Number of items per page

Example: 20

GET/lessees

curl --request GET \
  --url https://api.faireplace.com/api/lessees

shell

Example Responses

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "category": "individual",
      "title": "M.",
      "first_name": "Jean",
      "last_name": "Dupont",
      "legal_name": "SARL Dupont & Associés",
      "birth_date": "1985-03-15",
      "birth_place": "Paris",
      "email": "[email protected]",
      "mobile_phone": "+33 6 12 34 56 78",
      "landline_phone": "+33 1 23 45 67 89",
      "address_country": "France",
      "address_complement": "Appartement 12",
      "address_street_number": "123",
      "address_street_name": "rue de la Paix",
      "address_locality": "1er arrondissement",
      "address_postal_code": "75001",
      "address_city": "Paris",
      "address_postal_box": "123",
      "profession": "Ingénieur",
      "employer_name": "TechCorp SAS",
      "employer_phone": "+33 1 98 76 54 32",
      "monthly_income": 3500,
      "other_income": 500,
      "bank_name": "Crédit Agricole",
      "iban": "FR76 1234 5678 9012 3456 7890 123",
      "bic": "AGRIFRPP",
      "additional_addresses": {
        "work": "456 avenue des Champs-Élysées, 75008 Paris"
      },
      "identity_documents": {
        "passport": "12AB34567",
        "id_card": "123456789"
      },
      "additional_contacts": {
        "emergency": "+33 6 98 76 54 32",
        "family": "+33 1 11 22 33 44"
      },
      "custom_fields": {
        "preferred_language": "fr",
        "special_needs": "wheelchair access"
      },
      "auth_user_id": "user_123456789",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 20
}

json

application/json

Create a new lessee

POST

https://api.faireplace.com/api

/lessees

Creates a new lessee in the system

Create a new lessee › Request Body

Data for creating a new lessee

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

first_name

string · maxLength: 255

First name (required for individuals)

last_name

string · maxLength: 255

Last name

legal_name

string · maxLength: 255

Legal name (required for companies)

birth_date

string | null · date

Date of birth

birth_place

string · maxLength: 255

Place of birth

email

string · email

Email address

mobile_phone

string · maxLength: 20

Mobile phone number

landline_phone

string · maxLength: 20

Landline phone number

address_country

string · maxLength: 50

Country

address_complement

string · maxLength: 255

Address complement

address_street_number

string · maxLength: 50

Street number

address_street_name

string · maxLength: 255

Street name

address_locality

string · maxLength: 255

Locality, district, or borough

address_postal_code

string · maxLength: 20

Postal code

address_city

string · maxLength: 100

City

address_postal_box

string · maxLength: 20

PO Box

profession

string · maxLength: 255

Profession

employer_name

string · maxLength: 255

Employer name

employer_phone

string · maxLength: 20

Employer phone

monthly_income

number · decimal · min: 0

Monthly income

other_income

number · decimal · min: 0

Other income

bank_name

string · maxLength: 255

Bank name

iban

string · maxLength: 34

IBAN code

bic

string · maxLength: 11

BIC/SWIFT code

object

Additional addresses (JSON)

object

Identity documents (JSON)

object

Additional contacts (JSON)

object

Custom fields (JSON)

auth_user_id

string

Better Auth user ID

Create a new lessee › Responses

Lessee created successfully

Complete lessee

id

string · uuid · required

Unique identifier of the lessee

Example: 550e8400-e29b-41d4-a716-446655440000

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

first_name

string · maxLength: 255

First name

Example: Jean

last_name

string · maxLength: 255

Last name

Example: Dupont

legal_name

string · maxLength: 255

Legal name (for companies)

Example: SARL Dupont & Associés

birth_date

string | null · date

Date of birth

Example: 1985-03-15

birth_place

string · maxLength: 255

Place of birth

Example: Paris

email

string · email

Email address

Example: [email protected]

mobile_phone

string · maxLength: 20

Mobile phone number

Example: +33 6 12 34 56 78

landline_phone

string · maxLength: 20

Landline phone number

Example: +33 1 23 45 67 89

address_country

string · maxLength: 50

Country

Example: France

address_complement

string · maxLength: 255

Address complement

Example: Appartement 12

address_street_number

string · maxLength: 50

Street number

Example: 123

address_street_name

string · maxLength: 255

Street name

Example: rue de la Paix

address_locality

string · maxLength: 255

Locality, district, or borough

Example: 1er arrondissement

address_postal_code

string · maxLength: 20

Postal code

Example: 75001

address_city

string · maxLength: 100

City

Example: Paris

address_postal_box

string · maxLength: 20

PO Box

Example: 123

profession

string · maxLength: 255

Profession

Example: Ingénieur

employer_name

string · maxLength: 255

Employer name

Example: TechCorp SAS

employer_phone

string · maxLength: 20

Employer phone

Example: +33 1 98 76 54 32

monthly_income

number | null · decimal · min: 0

Monthly income

Example: 3500

other_income

number | null · decimal · min: 0

Other income

Example: 500

bank_name

string · maxLength: 255

Bank name

Example: Crédit Agricole

iban

string · maxLength: 34

IBAN code

Example: FR76 1234 5678 9012 3456 7890 123

bic

string · maxLength: 11

BIC/SWIFT code

Example: AGRIFRPP

object | null

Additional addresses (JSON)

Example: {"work":"456 avenue des Champs-Élysées, 75008 Paris"}

object | null

Identity documents (JSON)

Example: {"passport":"12AB34567","id_card":"123456789"}

object | null

Additional contacts (JSON)

Example: {"emergency":"+33 6 98 76 54 32","family":"+33 1 11 22 33 44"}

object | null

Custom fields (JSON)

Example: {"preferred_language":"fr","special_needs":"wheelchair access"}

auth_user_id

string | null

Better Auth user ID

Example: user_123456789

POST/lessees

curl --request POST \
  --url https://api.faireplace.com/api/lessees \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "individual",
  "title": "Mr.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "[email protected]",
  "mobile_phone": "+33 6 12 34 56 78",
  "address_street": "123 Rue de la Paix",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_country": "France",
  "profession": "Engineer",
  "monthly_income": 3500
}
'

shell

Example Request Body

{
  "category": "individual",
  "title": "Mr.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "[email protected]",
  "mobile_phone": "+33 6 12 34 56 78",
  "address_street": "123 Rue de la Paix",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_country": "France",
  "profession": "Engineer",
  "monthly_income": 3500
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category": "individual",
  "title": "M.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "legal_name": "SARL Dupont & Associés",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "[email protected]",
  "mobile_phone": "+33 6 12 34 56 78",
  "landline_phone": "+33 1 23 45 67 89",
  "address_country": "France",
  "address_complement": "Appartement 12",
  "address_street_number": "123",
  "address_street_name": "rue de la Paix",
  "address_locality": "1er arrondissement",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_postal_box": "123",
  "profession": "Ingénieur",
  "employer_name": "TechCorp SAS",
  "employer_phone": "+33 1 98 76 54 32",
  "monthly_income": 3500,
  "other_income": 500,
  "bank_name": "Crédit Agricole",
  "iban": "FR76 1234 5678 9012 3456 7890 123",
  "bic": "AGRIFRPP",
  "additional_addresses": {
    "work": "456 avenue des Champs-Élysées, 75008 Paris"
  },
  "identity_documents": {
    "passport": "12AB34567",
    "id_card": "123456789"
  },
  "additional_contacts": {
    "emergency": "+33 6 98 76 54 32",
    "family": "+33 1 11 22 33 44"
  },
  "custom_fields": {
    "preferred_language": "fr",
    "special_needs": "wheelchair access"
  },
  "auth_user_id": "user_123456789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get lessee by ID

GET

https://api.faireplace.com/api

/lessees/{id}

Retrieves the details of a specific lessee

Get lessee by ID › path Parameters

id

string · uuid · required

Unique lessee ID

Example: 550e8400-e29b-41d4-a716-446655440000

Get lessee by ID › Responses

Lessee details retrieved successfully

Complete lessee

id

string · uuid · required

Unique identifier of the lessee

Example: 550e8400-e29b-41d4-a716-446655440000

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

first_name

string · maxLength: 255

First name

Example: Jean

last_name

string · maxLength: 255

Last name

Example: Dupont

legal_name

string · maxLength: 255

Legal name (for companies)

Example: SARL Dupont & Associés

birth_date

string | null · date

Date of birth

Example: 1985-03-15

birth_place

string · maxLength: 255

Place of birth

Example: Paris

email

string · email

Email address

Example: [email protected]

mobile_phone

string · maxLength: 20

Mobile phone number

Example: +33 6 12 34 56 78

landline_phone

string · maxLength: 20

Landline phone number

Example: +33 1 23 45 67 89

address_country

string · maxLength: 50

Country

Example: France

address_complement

string · maxLength: 255

Address complement

Example: Appartement 12

address_street_number

string · maxLength: 50

Street number

Example: 123

address_street_name

string · maxLength: 255

Street name

Example: rue de la Paix

address_locality

string · maxLength: 255

Locality, district, or borough

Example: 1er arrondissement

address_postal_code

string · maxLength: 20

Postal code

Example: 75001

address_city

string · maxLength: 100

City

Example: Paris

address_postal_box

string · maxLength: 20

PO Box

Example: 123

profession

string · maxLength: 255

Profession

Example: Ingénieur

employer_name

string · maxLength: 255

Employer name

Example: TechCorp SAS

employer_phone

string · maxLength: 20

Employer phone

Example: +33 1 98 76 54 32

monthly_income

number | null · decimal · min: 0

Monthly income

Example: 3500

other_income

number | null · decimal · min: 0

Other income

Example: 500

bank_name

string · maxLength: 255

Bank name

Example: Crédit Agricole

iban

string · maxLength: 34

IBAN code

Example: FR76 1234 5678 9012 3456 7890 123

bic

string · maxLength: 11

BIC/SWIFT code

Example: AGRIFRPP

object | null

Additional addresses (JSON)

Example: {"work":"456 avenue des Champs-Élysées, 75008 Paris"}

object | null

Identity documents (JSON)

Example: {"passport":"12AB34567","id_card":"123456789"}

object | null

Additional contacts (JSON)

Example: {"emergency":"+33 6 98 76 54 32","family":"+33 1 11 22 33 44"}

object | null

Custom fields (JSON)

Example: {"preferred_language":"fr","special_needs":"wheelchair access"}

auth_user_id

string | null

Better Auth user ID

Example: user_123456789

GET/lessees/{id}

curl --request GET \
  --url https://api.faireplace.com/api/lessees/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category": "individual",
  "title": "M.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "legal_name": "SARL Dupont & Associés",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "[email protected]",
  "mobile_phone": "+33 6 12 34 56 78",
  "landline_phone": "+33 1 23 45 67 89",
  "address_country": "France",
  "address_complement": "Appartement 12",
  "address_street_number": "123",
  "address_street_name": "rue de la Paix",
  "address_locality": "1er arrondissement",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_postal_box": "123",
  "profession": "Ingénieur",
  "employer_name": "TechCorp SAS",
  "employer_phone": "+33 1 98 76 54 32",
  "monthly_income": 3500,
  "other_income": 500,
  "bank_name": "Crédit Agricole",
  "iban": "FR76 1234 5678 9012 3456 7890 123",
  "bic": "AGRIFRPP",
  "additional_addresses": {
    "work": "456 avenue des Champs-Élysées, 75008 Paris"
  },
  "identity_documents": {
    "passport": "12AB34567",
    "id_card": "123456789"
  },
  "additional_contacts": {
    "emergency": "+33 6 98 76 54 32",
    "family": "+33 1 11 22 33 44"
  },
  "custom_fields": {
    "preferred_language": "fr",
    "special_needs": "wheelchair access"
  },
  "auth_user_id": "user_123456789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update lessee

PUT

https://api.faireplace.com/api

/lessees/{id}

Updates the information of an existing lessee

Update lessee › path Parameters

id

string · uuid · required

Unique lessee ID

Example: 550e8400-e29b-41d4-a716-446655440000

Update lessee › Request Body

Data for updating a lessee

category

string · enum

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

first_name

string · maxLength: 255

First name

last_name

string · maxLength: 255

Last name

legal_name

string · maxLength: 255

Legal name (for companies)

birth_date

string · date

Date of birth

birth_place

string · maxLength: 255

Place of birth

email

string · email

Email address

mobile_phone

string · maxLength: 20

Mobile phone number

landline_phone

string · maxLength: 20

Landline phone number

address_country

string · maxLength: 50

Country

address_complement

string · maxLength: 255

Address complement

address_street_number

string · maxLength: 50

Street number

address_street_name

string · maxLength: 255

Street name

address_locality

string · maxLength: 255

Locality, district, or borough

address_postal_code

string · maxLength: 20

Postal code

address_city

string · maxLength: 100

City

address_postal_box

string · maxLength: 20

PO Box

profession

string · maxLength: 255

Profession

employer_name

string · maxLength: 255

Employer name

employer_phone

string · maxLength: 20

Employer phone

monthly_income

number · decimal · min: 0

Monthly income

other_income

number · decimal · min: 0

Other income

bank_name

string · maxLength: 255

Bank name

iban

string · maxLength: 34

IBAN code

bic

string · maxLength: 11

BIC/SWIFT code

object

Additional addresses (JSON)

object

Identity documents (JSON)

object

Additional contacts (JSON)

object

Custom fields (JSON)

auth_user_id

string

Better Auth user ID

Update lessee › Responses

Lessee updated successfully

Complete lessee

id

string · uuid · required

Unique identifier of the lessee

Example: 550e8400-e29b-41d4-a716-446655440000

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

first_name

string · maxLength: 255

First name

Example: Jean

last_name

string · maxLength: 255

Last name

Example: Dupont

legal_name

string · maxLength: 255

Legal name (for companies)

Example: SARL Dupont & Associés

birth_date

string | null · date

Date of birth

Example: 1985-03-15

birth_place

string · maxLength: 255

Place of birth

Example: Paris

email

string · email

Email address

Example: [email protected]

mobile_phone

string · maxLength: 20

Mobile phone number

Example: +33 6 12 34 56 78

landline_phone

string · maxLength: 20

Landline phone number

Example: +33 1 23 45 67 89

address_country

string · maxLength: 50

Country

Example: France

address_complement

string · maxLength: 255

Address complement

Example: Appartement 12

address_street_number

string · maxLength: 50

Street number

Example: 123

address_street_name

string · maxLength: 255

Street name

Example: rue de la Paix

address_locality

string · maxLength: 255

Locality, district, or borough

Example: 1er arrondissement

address_postal_code

string · maxLength: 20

Postal code

Example: 75001

address_city

string · maxLength: 100

City

Example: Paris

address_postal_box

string · maxLength: 20

PO Box

Example: 123

profession

string · maxLength: 255

Profession

Example: Ingénieur

employer_name

string · maxLength: 255

Employer name

Example: TechCorp SAS

employer_phone

string · maxLength: 20

Employer phone

Example: +33 1 98 76 54 32

monthly_income

number | null · decimal · min: 0

Monthly income

Example: 3500

other_income

number | null · decimal · min: 0

Other income

Example: 500

bank_name

string · maxLength: 255

Bank name

Example: Crédit Agricole

iban

string · maxLength: 34

IBAN code

Example: FR76 1234 5678 9012 3456 7890 123

bic

string · maxLength: 11

BIC/SWIFT code

Example: AGRIFRPP

object | null

Additional addresses (JSON)

Example: {"work":"456 avenue des Champs-Élysées, 75008 Paris"}

object | null

Identity documents (JSON)

Example: {"passport":"12AB34567","id_card":"123456789"}

object | null

Additional contacts (JSON)

Example: {"emergency":"+33 6 98 76 54 32","family":"+33 1 11 22 33 44"}

object | null

Custom fields (JSON)

Example: {"preferred_language":"fr","special_needs":"wheelchair access"}

auth_user_id

string | null

Better Auth user ID

Example: user_123456789

PUT/lessees/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/lessees/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Jean-Pierre",
  "email": "[email protected]",
  "monthly_income": 4000
}
'

shell

Example Request Body

{
  "first_name": "Jean-Pierre",
  "email": "[email protected]",
  "monthly_income": 4000
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category": "individual",
  "title": "M.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "legal_name": "SARL Dupont & Associés",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "[email protected]",
  "mobile_phone": "+33 6 12 34 56 78",
  "landline_phone": "+33 1 23 45 67 89",
  "address_country": "France",
  "address_complement": "Appartement 12",
  "address_street_number": "123",
  "address_street_name": "rue de la Paix",
  "address_locality": "1er arrondissement",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_postal_box": "123",
  "profession": "Ingénieur",
  "employer_name": "TechCorp SAS",
  "employer_phone": "+33 1 98 76 54 32",
  "monthly_income": 3500,
  "other_income": 500,
  "bank_name": "Crédit Agricole",
  "iban": "FR76 1234 5678 9012 3456 7890 123",
  "bic": "AGRIFRPP",
  "additional_addresses": {
    "work": "456 avenue des Champs-Élysées, 75008 Paris"
  },
  "identity_documents": {
    "passport": "12AB34567",
    "id_card": "123456789"
  },
  "additional_contacts": {
    "emergency": "+33 6 98 76 54 32",
    "family": "+33 1 11 22 33 44"
  },
  "custom_fields": {
    "preferred_language": "fr",
    "special_needs": "wheelchair access"
  },
  "auth_user_id": "user_123456789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete lessee

DELETE

https://api.faireplace.com/api

/lessees/{id}

Deletes a lessee from the system

Delete lessee › path Parameters

id

string · uuid · required

Unique lessee ID

Example: 550e8400-e29b-41d4-a716-446655440000

Delete lessee › Responses

Lessee deleted successfully

No data returned

DELETE/lessees/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/lessees/:id

shell

Example Responses

No example specified for this content type

Get lessees by type

GET

https://api.faireplace.com/api

/lessees/type/{type}

Retrieves lessees filtered by type (primary, co-tenant, guarantor)

Get lessees by type › path Parameters

type

string · enum · required

Lessee type

Enum values:

PRIMARY

GUARANTOR

CO_TENANT

Example: PRIMARY

Get lessees by type › query Parameters

page

integer · min: 1

Page number

Default: 1

limit

integer · min: 1 · max: 100

Number of items per page

Default: 20

Get lessees by type › Responses

Lessee list for the specified type

Paginated response for the lessee list

object[] · required

Lessees list

total

integer · required

Total number of lessees

Example: 10

page

integer · required

Current page number

Example: 1

limit

integer · required

Number of items per page

Example: 20

GET/lessees/type/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lessees/type/:type

shell

Example Responses

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "category": "individual",
      "title": "M.",
      "first_name": "Jean",
      "last_name": "Dupont",
      "legal_name": "SARL Dupont & Associés",
      "birth_date": "1985-03-15",
      "birth_place": "Paris",
      "email": "[email protected]",
      "mobile_phone": "+33 6 12 34 56 78",
      "landline_phone": "+33 1 23 45 67 89",
      "address_country": "France",
      "address_complement": "Appartement 12",
      "address_street_number": "123",
      "address_street_name": "rue de la Paix",
      "address_locality": "1er arrondissement",
      "address_postal_code": "75001",
      "address_city": "Paris",
      "address_postal_box": "123",
      "profession": "Ingénieur",
      "employer_name": "TechCorp SAS",
      "employer_phone": "+33 1 98 76 54 32",
      "monthly_income": 3500,
      "other_income": 500,
      "bank_name": "Crédit Agricole",
      "iban": "FR76 1234 5678 9012 3456 7890 123",
      "bic": "AGRIFRPP",
      "additional_addresses": {
        "work": "456 avenue des Champs-Élysées, 75008 Paris"
      },
      "identity_documents": {
        "passport": "12AB34567",
        "id_card": "123456789"
      },
      "additional_contacts": {
        "emergency": "+33 6 98 76 54 32",
        "family": "+33 1 11 22 33 44"
      },
      "custom_fields": {
        "preferred_language": "fr",
        "special_needs": "wheelchair access"
      },
      "auth_user_id": "user_123456789",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 20
}

json

application/json

Create multiple lessees

POST

https://api.faireplace.com/api

/lessees/bulk

Creates multiple lessees in a single operation

Create multiple lessees › Request Body

Bulk creation of lessees

object[] · minItems: 1 · maxItems: 100 · required

List of lessees to create

Create multiple lessees › Responses

Lessees created successfully

object[]

Complete lessee

id

string · uuid · required

Unique identifier of the lessee

Example: 550e8400-e29b-41d4-a716-446655440000

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

first_name

string · maxLength: 255

First name

Example: Jean

last_name

string · maxLength: 255

Last name

Example: Dupont

legal_name

string · maxLength: 255

Legal name (for companies)

Example: SARL Dupont & Associés

birth_date

string | null · date

Date of birth

Example: 1985-03-15

birth_place

string · maxLength: 255

Place of birth

Example: Paris

email

string · email

Email address

Example: [email protected]

mobile_phone

string · maxLength: 20

Mobile phone number

Example: +33 6 12 34 56 78

landline_phone

string · maxLength: 20

Landline phone number

Example: +33 1 23 45 67 89

address_country

string · maxLength: 50

Country

Example: France

address_complement

string · maxLength: 255

Address complement

Example: Appartement 12

address_street_number

string · maxLength: 50

Street number

Example: 123

address_street_name

string · maxLength: 255

Street name

Example: rue de la Paix

address_locality

string · maxLength: 255

Locality, district, or borough

Example: 1er arrondissement

address_postal_code

string · maxLength: 20

Postal code

Example: 75001

address_city

string · maxLength: 100

City

Example: Paris

address_postal_box

string · maxLength: 20

PO Box

Example: 123

profession

string · maxLength: 255

Profession

Example: Ingénieur

employer_name

string · maxLength: 255

Employer name

Example: TechCorp SAS

employer_phone

string · maxLength: 20

Employer phone

Example: +33 1 98 76 54 32

monthly_income

number | null · decimal · min: 0

Monthly income

Example: 3500

other_income

number | null · decimal · min: 0

Other income

Example: 500

bank_name

string · maxLength: 255

Bank name

Example: Crédit Agricole

iban

string · maxLength: 34

IBAN code

Example: FR76 1234 5678 9012 3456 7890 123

bic

string · maxLength: 11

BIC/SWIFT code

Example: AGRIFRPP

object | null

Additional addresses (JSON)

Example: {"work":"456 avenue des Champs-Élysées, 75008 Paris"}

object | null

Identity documents (JSON)

Example: {"passport":"12AB34567","id_card":"123456789"}

object | null

Additional contacts (JSON)

Example: {"emergency":"+33 6 98 76 54 32","family":"+33 1 11 22 33 44"}

object | null

Custom fields (JSON)

Example: {"preferred_language":"fr","special_needs":"wheelchair access"}

auth_user_id

string | null

Better Auth user ID

Example: user_123456789

POST/lessees/bulk

curl --request POST \
  --url https://api.faireplace.com/api/lessees/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "lessees": [
    {
      "category": "individual",
      "first_name": "Marie",
      "last_name": "Martin",
      "email": "[email protected]"
    },
    {
      "category": "company/other",
      "legal_name": "SARL Martin & Associates",
      "email": "[email protected]"
    }
  ]
}
'

shell

Example Request Body

{
  "lessees": [
    {
      "category": "individual",
      "first_name": "Marie",
      "last_name": "Martin",
      "email": "[email protected]"
    },
    {
      "category": "company/other",
      "legal_name": "SARL Martin & Associates",
      "email": "[email protected]"
    }
  ]
}

json

application/json

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "category": "individual",
    "title": "M.",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SARL Dupont & Associés",
    "birth_date": "1985-03-15",
    "birth_place": "Paris",
    "email": "[email protected]",
    "mobile_phone": "+33 6 12 34 56 78",
    "landline_phone": "+33 1 23 45 67 89",
    "address_country": "France",
    "address_complement": "Appartement 12",
    "address_street_number": "123",
    "address_street_name": "rue de la Paix",
    "address_locality": "1er arrondissement",
    "address_postal_code": "75001",
    "address_city": "Paris",
    "address_postal_box": "123",
    "profession": "Ingénieur",
    "employer_name": "TechCorp SAS",
    "employer_phone": "+33 1 98 76 54 32",
    "monthly_income": 3500,
    "other_income": 500,
    "bank_name": "Crédit Agricole",
    "iban": "FR76 1234 5678 9012 3456 7890 123",
    "bic": "AGRIFRPP",
    "additional_addresses": {
      "work": "456 avenue des Champs-Élysées, 75008 Paris"
    },
    "identity_documents": {
      "passport": "12AB34567",
      "id_card": "123456789"
    },
    "additional_contacts": {
      "emergency": "+33 6 98 76 54 32",
      "family": "+33 1 11 22 33 44"
    },
    "custom_fields": {
      "preferred_language": "fr",
      "special_needs": "wheelchair access"
    },
    "auth_user_id": "user_123456789",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Delete multiple lessees

DELETE

https://api.faireplace.com/api

/lessees/bulk

Deletes multiple lessees in a single operation

Delete multiple lessees › Request Body

Bulk deletion of lessees

lessee_ids

string[] · minItems: 1 · maxItems: 100 · required

List of lessee IDs to delete

Delete multiple lessees › Responses

Lessees deleted successfully

No data returned

DELETE/lessees/bulk

curl --request DELETE \
  --url https://api.faireplace.com/api/lessees/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "lessee_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}
'

shell

Example Request Body

{
  "lessee_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

json

application/json

Example Responses

No example specified for this content type

List all leases where the user is a tenant

GET

https://api.faireplace.com/api

/lessee/leases

Retrieves the list of all leases where the authenticated user is associated as an active tenant.

Authentication and authorization

The user must be authenticated with a valid JWT
The auth_user_id (JWT sub claim) must correspond to an existing lessee
Only leases where the user is effectively a tenant are returned
Terminated leases (with a past end_date) are excluded

Required permissions

lessee:leases:read

List all leases where the user is a tenant › Responses

Lessee leases retrieved successfully

object[]

Complete lease

id

string · uuid · required

Unique lease identifier

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Rented property unit ID

Example: 550e8400-e29b-41d4-a716-446655440001

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440002

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

version

integer · required

Lease version (incremented with each amendment)

Example: 1

start_date

string · date · required

Lease start date

Example: 2024-01-01

rent_amount

number · decimal · required

Lease rent amount (in EUR). Automatically synchronized with the associated Estate's rent_amount.

Example: 1200

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

is_subject_to_rent_evolution_decree

boolean · required

Subject to rent evolution decree at re-letting

Default: false

is_subject_to_reference_rent_cap

boolean · required

Subject to increased reference rent by prefectural decree

Default: false

payment_day

integer · min: 1 · max: 31 · required

Monthly payment day (1-31)

Example: 5

payment_terms

string · enum · required

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

payment_method

string · enum · required

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

template_id

string | null · uuid

Template ID used to generate the lease

agent_id

string | null · uuid

Agent ID (real estate agent)

reference_number

string | null · maxLength: 500

Lease reference number

Example: BAIL-2024-001

end_date

string | null · date

Lease end date

Example: 2025-01-01

deposit_amount

number | null · decimal

Security deposit amount

Example: 1200

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

last_revision_date

string | null · date

Date of the last rent revision

next_revision_date

string | null · date

Date of the next rent revision

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

furniture_list_id

string | null · uuid

Furniture list ID (for furnished leases)

notes

string | null · maxLength: 5000

Internal notes

reference_rent_per_m2

number | null · decimal

Reference rent in EUR/m²

Example: 20.5

reference_rent_increased_per_m2

number | null · decimal

Increased reference rent in EUR/m²

Example: 22.55

base_rent_amount

number | null · decimal

Base rent (equal to increased reference rent if supplement)

Example: 1000

rent_complement_amount

number | null · decimal

Rent supplement

Example: 200

rent_complement_justification

string | null · maxLength: 5000

Rent supplement justification

previous_tenant_last_rent

number | null · decimal

Previous tenant's last rent

Example: 1150

previous_tenant_last_payment_date

string | null · date

Previous tenant's last payment date

previous_tenant_last_revision_date

string | null · date

Previous tenant's last revision date

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter (e.g., Q1 2024)

Example: T1 2024

irl_reference_value

number | null · decimal

IRL reference index value

Example: 142.35

rent_regulation_applied_at

string | null · date-time

Regulation application date

rent_regulation_zone_type

string | null · maxLength: 50

Regulation zone type

rent_regulation_compliance_status

string | null · maxLength: 20

Regulation compliance status

rent_regulation_last_check

string | null · date-time

Date of last compliance check

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

rent_increase_for_work

number | null · decimal

Rent increase amount due to landlord's work

rent_increase_work_description

string | null

Description of work done by the landlord

rent_increase_work_cost

number | null · decimal

Total cost of work done by the landlord

rent_increase_work_completion_date

string | null · date

Work completion date

rent_increase_legal_basis

string | null

Legal basis (e.g., art. 17-2 law 1989)

rent_increase_calculation_method

string | null

Calculation method used

object | null

Supporting documents (invoices, quotes) - JSON format

rent_increase_start_date

string | null · date

Start date of the rent increase application

rent_increase_end_date

string | null · date

End date of the rent increase application

rent_increase_duration_months

integer | null

Application duration in months

rent_decrease_for_tenant_work

number | null · decimal

Rent decrease amount due to tenant's required work

rent_decrease_work_description

string | null

Description of work to be done by the tenant

rent_decrease_work_estimated_cost

number | null · decimal

Estimated cost of work to be borne by the tenant

rent_decrease_work_deadline

string | null · date

Deadline to complete the work

rent_decrease_work_specifications

string | null

Technical specifications of the work

rent_decrease_work_authorization_required

boolean | null

Prior authorization required

rent_decrease_restitution_clause

string | null

Restitution clause at end of lease

object | null

Documents (quotes, specifications) - JSON format

rent_decrease_start_date

string | null · date

Start date of the rent decrease application

rent_decrease_end_date

string | null · date

End date of the rent decrease application

rent_decrease_duration_months

integer | null

Application duration in months

solidarity_clause

string | null

Solidarity clause between co-tenants

termination_clause

string | null

Termination clause (termination conditions)

visit_clause

string | null

Clause for visits to re-let or sell

furniture_provision_clause

string | null

Clause regarding provided furniture

pet_clause

string | null

Pet clause

insurance_clause

string | null

Tenant home insurance clause

maintenance_clause

string | null

Annual appliance maintenance clause

damage_clause

string | null

Tenant damage clause

regularization_waiver_clause

string | null

Charge regularization waiver clause

rent_free_clause

string | null

Rent-free clause

custom_clause

string | null

Custom clause (free-form)

rent_free_start_date

string | null · date

Rent-free period start date

rent_free_end_date

string | null · date

Rent-free period end date

rent_free_amount

number | null · decimal

Rent-free amount (0 = fully free, >0 = reduced rent)

tenant_fees_cap_visit_dossier_lease_per_m2

number | null · decimal

Fee cap for visits/file processing/lease drafting (EUR/m²)

tenant_fees_cap_inventory_per_m2

number | null · decimal

Fee cap for move-in inspection (EUR/m²)

landlord_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

landlord_fees_visit_dossier_lease_description

string | null

Details of services performed

landlord_fees_inventory_entry

number | null · decimal

Move-in inspection fees

landlord_fees_inventory_entry_description

string | null

Move-in inspection service details

landlord_fees_other

number | null · decimal

Other services

landlord_fees_other_description

string | null

Details of other services and conditions

tenant_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

tenant_fees_visit_dossier_lease_description

string | null

Details of services performed

tenant_fees_inventory_entry

number | null · decimal

Move-in inspection fees

tenant_fees_inventory_entry_description

string | null

Move-in inspection service details

tenant_fees_other

number | null · decimal

Other fees

tenant_fees_other_description

string | null

Details of other services

fees_calculation_date

string | null · date-time

Fee calculation date

fees_regulation_compliance

boolean | null

Regulatory compliance

fees_agency_name

string | null

Agency/professional name

fees_agency_registration_number

string | null

Professional registration number

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

Default: false

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

Default: false

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5). The tenant must notify 6 months before this date.

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision per Articles L145-33 to L145-38)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

Default: false

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

Example: [{"date":"2025-06-01","activity":"Sale of IT accessories","approved_by":"Jean Dupont"}]

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49, requires judicial procedure)

Example: {"date":"2026-03-15","old_activity":"IT retail","new_activity":"Restaurant","approved":true,"indemnity_amount":15000}

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

Example: [{"name":"Holding Company XYZ","siret":"98765432109876","address":"10 Avenue des Champs-Élysées, 75008 Paris","guaranteed_amount":50000,"signature_date":"2025-01-01"}]

commercial_insurance_policy

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

GET/lessee/leases

curl --request GET \
  --url https://api.faireplace.com/api/lessee/leases

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "estate_id": "550e8400-e29b-41d4-a716-446655440001",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440002",
    "reference_number": "BAIL-2024-001",
    "status": "ACTIVE",
    "start_date": "2024-01-01",
    "end_date": "2025-12-31",
    "rent_amount": 1200,
    "rent_frequency": "MONTHLY"
  }
]

json

application/json

List leases pending signature for the tenant

GET

https://api.faireplace.com/api

/lessee/leases/pending-signatures

Retrieves the list of leases where the user is a tenant and where a signature is pending on their part.

Filtering criteria

The lease must have an initiated signature document
The document status must not be COMPLETED
There must be a signature request of type TENANT with a non-COMPLETED status

Required permissions

lessee:leases:read

List leases pending signature for the tenant › Responses

Leases pending signature list

object[]

Complete lease

id

string · uuid · required

Unique lease identifier

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Rented property unit ID

Example: 550e8400-e29b-41d4-a716-446655440001

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440002

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

version

integer · required

Lease version (incremented with each amendment)

Example: 1

start_date

string · date · required

Lease start date

Example: 2024-01-01

rent_amount

number · decimal · required

Lease rent amount (in EUR). Automatically synchronized with the associated Estate's rent_amount.

Example: 1200

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

is_subject_to_rent_evolution_decree

boolean · required

Subject to rent evolution decree at re-letting

Default: false

is_subject_to_reference_rent_cap

boolean · required

Subject to increased reference rent by prefectural decree

Default: false

payment_day

integer · min: 1 · max: 31 · required

Monthly payment day (1-31)

Example: 5

payment_terms

string · enum · required

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

payment_method

string · enum · required

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

template_id

string | null · uuid

Template ID used to generate the lease

agent_id

string | null · uuid

Agent ID (real estate agent)

reference_number

string | null · maxLength: 500

Lease reference number

Example: BAIL-2024-001

end_date

string | null · date

Lease end date

Example: 2025-01-01

deposit_amount

number | null · decimal

Security deposit amount

Example: 1200

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

last_revision_date

string | null · date

Date of the last rent revision

next_revision_date

string | null · date

Date of the next rent revision

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

furniture_list_id

string | null · uuid

Furniture list ID (for furnished leases)

notes

string | null · maxLength: 5000

Internal notes

reference_rent_per_m2

number | null · decimal

Reference rent in EUR/m²

Example: 20.5

reference_rent_increased_per_m2

number | null · decimal

Increased reference rent in EUR/m²

Example: 22.55

base_rent_amount

number | null · decimal

Base rent (equal to increased reference rent if supplement)

Example: 1000

rent_complement_amount

number | null · decimal

Rent supplement

Example: 200

rent_complement_justification

string | null · maxLength: 5000

Rent supplement justification

previous_tenant_last_rent

number | null · decimal

Previous tenant's last rent

Example: 1150

previous_tenant_last_payment_date

string | null · date

Previous tenant's last payment date

previous_tenant_last_revision_date

string | null · date

Previous tenant's last revision date

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter (e.g., Q1 2024)

Example: T1 2024

irl_reference_value

number | null · decimal

IRL reference index value

Example: 142.35

rent_regulation_applied_at

string | null · date-time

Regulation application date

rent_regulation_zone_type

string | null · maxLength: 50

Regulation zone type

rent_regulation_compliance_status

string | null · maxLength: 20

Regulation compliance status

rent_regulation_last_check

string | null · date-time

Date of last compliance check

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

rent_increase_for_work

number | null · decimal

Rent increase amount due to landlord's work

rent_increase_work_description

string | null

Description of work done by the landlord

rent_increase_work_cost

number | null · decimal

Total cost of work done by the landlord

rent_increase_work_completion_date

string | null · date

Work completion date

rent_increase_legal_basis

string | null

Legal basis (e.g., art. 17-2 law 1989)

rent_increase_calculation_method

string | null

Calculation method used

object | null

Supporting documents (invoices, quotes) - JSON format

rent_increase_start_date

string | null · date

Start date of the rent increase application

rent_increase_end_date

string | null · date

End date of the rent increase application

rent_increase_duration_months

integer | null

Application duration in months

rent_decrease_for_tenant_work

number | null · decimal

Rent decrease amount due to tenant's required work

rent_decrease_work_description

string | null

Description of work to be done by the tenant

rent_decrease_work_estimated_cost

number | null · decimal

Estimated cost of work to be borne by the tenant

rent_decrease_work_deadline

string | null · date

Deadline to complete the work

rent_decrease_work_specifications

string | null

Technical specifications of the work

rent_decrease_work_authorization_required

boolean | null

Prior authorization required

rent_decrease_restitution_clause

string | null

Restitution clause at end of lease

object | null

Documents (quotes, specifications) - JSON format

rent_decrease_start_date

string | null · date

Start date of the rent decrease application

rent_decrease_end_date

string | null · date

End date of the rent decrease application

rent_decrease_duration_months

integer | null

Application duration in months

solidarity_clause

string | null

Solidarity clause between co-tenants

termination_clause

string | null

Termination clause (termination conditions)

visit_clause

string | null

Clause for visits to re-let or sell

furniture_provision_clause

string | null

Clause regarding provided furniture

pet_clause

string | null

Pet clause

insurance_clause

string | null

Tenant home insurance clause

maintenance_clause

string | null

Annual appliance maintenance clause

damage_clause

string | null

Tenant damage clause

regularization_waiver_clause

string | null

Charge regularization waiver clause

rent_free_clause

string | null

Rent-free clause

custom_clause

string | null

Custom clause (free-form)

rent_free_start_date

string | null · date

Rent-free period start date

rent_free_end_date

string | null · date

Rent-free period end date

rent_free_amount

number | null · decimal

Rent-free amount (0 = fully free, >0 = reduced rent)

tenant_fees_cap_visit_dossier_lease_per_m2

number | null · decimal

Fee cap for visits/file processing/lease drafting (EUR/m²)

tenant_fees_cap_inventory_per_m2

number | null · decimal

Fee cap for move-in inspection (EUR/m²)

landlord_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

landlord_fees_visit_dossier_lease_description

string | null

Details of services performed

landlord_fees_inventory_entry

number | null · decimal

Move-in inspection fees

landlord_fees_inventory_entry_description

string | null

Move-in inspection service details

landlord_fees_other

number | null · decimal

Other services

landlord_fees_other_description

string | null

Details of other services and conditions

tenant_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

tenant_fees_visit_dossier_lease_description

string | null

Details of services performed

tenant_fees_inventory_entry

number | null · decimal

Move-in inspection fees

tenant_fees_inventory_entry_description

string | null

Move-in inspection service details

tenant_fees_other

number | null · decimal

Other fees

tenant_fees_other_description

string | null

Details of other services

fees_calculation_date

string | null · date-time

Fee calculation date

fees_regulation_compliance

boolean | null

Regulatory compliance

fees_agency_name

string | null

Agency/professional name

fees_agency_registration_number

string | null

Professional registration number

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

Default: false

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

Default: false

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5). The tenant must notify 6 months before this date.

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision per Articles L145-33 to L145-38)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

Default: false

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

Example: [{"date":"2025-06-01","activity":"Sale of IT accessories","approved_by":"Jean Dupont"}]

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49, requires judicial procedure)

Example: {"date":"2026-03-15","old_activity":"IT retail","new_activity":"Restaurant","approved":true,"indemnity_amount":15000}

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

Example: [{"name":"Holding Company XYZ","siret":"98765432109876","address":"10 Avenue des Champs-Élysées, 75008 Paris","guaranteed_amount":50000,"signature_date":"2025-01-01"}]

commercial_insurance_policy

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

GET/lessee/leases/pending-signatures

curl --request GET \
  --url https://api.faireplace.com/api/lessee/leases/pending-signatures

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "estate_id": "550e8400-e29b-41d4-a716-446655440001",
    "reference_number": "BAIL-2024-001",
    "status": "ACTIVE",
    "start_date": "2024-01-01",
    "end_date": "2025-12-31",
    "rent_amount": 1200
  }
]

json

application/json

Get details of a specific lease for the tenant

GET

https://api.faireplace.com/api

/lessee/leases/{id}

Retrieves the full details of a specific lease, only if the authenticated user is a tenant of this lease.

Security validations

Verifies that the user is indeed a tenant of the lease via is_lessee_for_lease
Returns a 403 error if the user is not authorized to access this lease

Required permissions

lessee:leases:read

Get details of a specific lease for the tenant › path Parameters

id

string · uuid · required

Lease ID to retrieve

Example: 550e8400-e29b-41d4-a716-446655440000

Get details of a specific lease for the tenant › Responses

Lease details retrieved successfully

Complete lease

id

string · uuid · required

Unique lease identifier

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Rented property unit ID

Example: 550e8400-e29b-41d4-a716-446655440001

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440002

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

version

integer · required

Lease version (incremented with each amendment)

Example: 1

start_date

string · date · required

Lease start date

Example: 2024-01-01

rent_amount

number · decimal · required

Lease rent amount (in EUR). Automatically synchronized with the associated Estate's rent_amount.

Example: 1200

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

is_subject_to_rent_evolution_decree

boolean · required

Subject to rent evolution decree at re-letting

Default: false

is_subject_to_reference_rent_cap

boolean · required

Subject to increased reference rent by prefectural decree

Default: false

payment_day

integer · min: 1 · max: 31 · required

Monthly payment day (1-31)

Example: 5

payment_terms

string · enum · required

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

payment_method

string · enum · required

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

template_id

string | null · uuid

Template ID used to generate the lease

agent_id

string | null · uuid

Agent ID (real estate agent)

reference_number

string | null · maxLength: 500

Lease reference number

Example: BAIL-2024-001

end_date

string | null · date

Lease end date

Example: 2025-01-01

deposit_amount

number | null · decimal

Security deposit amount

Example: 1200

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

last_revision_date

string | null · date

Date of the last rent revision

next_revision_date

string | null · date

Date of the next rent revision

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

furniture_list_id

string | null · uuid

Furniture list ID (for furnished leases)

notes

string | null · maxLength: 5000

Internal notes

reference_rent_per_m2

number | null · decimal

Reference rent in EUR/m²

Example: 20.5

reference_rent_increased_per_m2

number | null · decimal

Increased reference rent in EUR/m²

Example: 22.55

base_rent_amount

number | null · decimal

Base rent (equal to increased reference rent if supplement)

Example: 1000

rent_complement_amount

number | null · decimal

Rent supplement

Example: 200

rent_complement_justification

string | null · maxLength: 5000

Rent supplement justification

previous_tenant_last_rent

number | null · decimal

Previous tenant's last rent

Example: 1150

previous_tenant_last_payment_date

string | null · date

Previous tenant's last payment date

previous_tenant_last_revision_date

string | null · date

Previous tenant's last revision date

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter (e.g., Q1 2024)

Example: T1 2024

irl_reference_value

number | null · decimal

IRL reference index value

Example: 142.35

rent_regulation_applied_at

string | null · date-time

Regulation application date

rent_regulation_zone_type

string | null · maxLength: 50

Regulation zone type

rent_regulation_compliance_status

string | null · maxLength: 20

Regulation compliance status

rent_regulation_last_check

string | null · date-time

Date of last compliance check

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

rent_increase_for_work

number | null · decimal

Rent increase amount due to landlord's work

rent_increase_work_description

string | null

Description of work done by the landlord

rent_increase_work_cost

number | null · decimal

Total cost of work done by the landlord

rent_increase_work_completion_date

string | null · date

Work completion date

rent_increase_legal_basis

string | null

Legal basis (e.g., art. 17-2 law 1989)

rent_increase_calculation_method

string | null

Calculation method used

object | null

Supporting documents (invoices, quotes) - JSON format

rent_increase_start_date

string | null · date

Start date of the rent increase application

rent_increase_end_date

string | null · date

End date of the rent increase application

rent_increase_duration_months

integer | null

Application duration in months

rent_decrease_for_tenant_work

number | null · decimal

Rent decrease amount due to tenant's required work

rent_decrease_work_description

string | null

Description of work to be done by the tenant

rent_decrease_work_estimated_cost

number | null · decimal

Estimated cost of work to be borne by the tenant

rent_decrease_work_deadline

string | null · date

Deadline to complete the work

rent_decrease_work_specifications

string | null

Technical specifications of the work

rent_decrease_work_authorization_required

boolean | null

Prior authorization required

rent_decrease_restitution_clause

string | null

Restitution clause at end of lease

object | null

Documents (quotes, specifications) - JSON format

rent_decrease_start_date

string | null · date

Start date of the rent decrease application

rent_decrease_end_date

string | null · date

End date of the rent decrease application

rent_decrease_duration_months

integer | null

Application duration in months

solidarity_clause

string | null

Solidarity clause between co-tenants

termination_clause

string | null

Termination clause (termination conditions)

visit_clause

string | null

Clause for visits to re-let or sell

furniture_provision_clause

string | null

Clause regarding provided furniture

pet_clause

string | null

Pet clause

insurance_clause

string | null

Tenant home insurance clause

maintenance_clause

string | null

Annual appliance maintenance clause

damage_clause

string | null

Tenant damage clause

regularization_waiver_clause

string | null

Charge regularization waiver clause

rent_free_clause

string | null

Rent-free clause

custom_clause

string | null

Custom clause (free-form)

rent_free_start_date

string | null · date

Rent-free period start date

rent_free_end_date

string | null · date

Rent-free period end date

rent_free_amount

number | null · decimal

Rent-free amount (0 = fully free, >0 = reduced rent)

tenant_fees_cap_visit_dossier_lease_per_m2

number | null · decimal

Fee cap for visits/file processing/lease drafting (EUR/m²)

tenant_fees_cap_inventory_per_m2

number | null · decimal

Fee cap for move-in inspection (EUR/m²)

landlord_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

landlord_fees_visit_dossier_lease_description

string | null

Details of services performed

landlord_fees_inventory_entry

number | null · decimal

Move-in inspection fees

landlord_fees_inventory_entry_description

string | null

Move-in inspection service details

landlord_fees_other

number | null · decimal

Other services

landlord_fees_other_description

string | null

Details of other services and conditions

tenant_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

tenant_fees_visit_dossier_lease_description

string | null

Details of services performed

tenant_fees_inventory_entry

number | null · decimal

Move-in inspection fees

tenant_fees_inventory_entry_description

string | null

Move-in inspection service details

tenant_fees_other

number | null · decimal

Other fees

tenant_fees_other_description

string | null

Details of other services

fees_calculation_date

string | null · date-time

Fee calculation date

fees_regulation_compliance

boolean | null

Regulatory compliance

fees_agency_name

string | null

Agency/professional name

fees_agency_registration_number

string | null

Professional registration number

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

Default: false

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

Default: false

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5). The tenant must notify 6 months before this date.

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision per Articles L145-33 to L145-38)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

Default: false

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

Example: [{"date":"2025-06-01","activity":"Sale of IT accessories","approved_by":"Jean Dupont"}]

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49, requires judicial procedure)

Example: {"date":"2026-03-15","old_activity":"IT retail","new_activity":"Restaurant","approved":true,"indemnity_amount":15000}

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

Example: [{"name":"Holding Company XYZ","siret":"98765432109876","address":"10 Avenue des Champs-Élysées, 75008 Paris","guaranteed_amount":50000,"signature_date":"2025-01-01"}]

commercial_insurance_policy

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

GET/lessee/leases/{id}

curl --request GET \
  --url https://api.faireplace.com/api/lessee/leases/:id

shell

Example Responses

No example specified for this content type

application/json

Get signature status of a lease for the tenant

GET

https://api.faireplace.com/api

/lessee/leases/{id}/signature/status

Retrieves the signature status of a specific lease for the authenticated tenant.

Returns:

The signature document status (READY, SIGNING, COMPLETED, FAILED, ARCHIVED)
The signed media ID (signed_media_id) if the document is signed, allowing retrieval of the signed PDF URL
The details of all associated signature requests
Information about the signers and their status

Required permissions

lessee:leases:read

Get signature status of a lease for the tenant › path Parameters

id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

Get signature status of a lease for the tenant › Responses

Signature status retrieved successfully

lease_id

string · uuid

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

document_signature_id

string · uuid

Signature document ID

Example: 550e8400-e29b-41d4-a716-446655440001

status

string · enum

Signature document status

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Example: SIGNING

signed_media_id

string | null · uuid

Signed PDF media ID (available after full signature completion)

Example: 550e8400-e29b-41d4-a716-446655440002

object[]

Signature requests list

GET/lessee/leases/{id}/signature/status

curl --request GET \
  --url https://api.faireplace.com/api/lessee/leases/:id/signature/status

shell

Example Responses

No example specified for this content type

application/json

Sign a lease as a tenant

POST

https://api.faireplace.com/api

/lessee/leases/{id}/signature/sign

Allows the authenticated tenant to sign a lease by validating the OTP received via SMS/email.

Signing process

The user must have received an OTP via SMS or email
The OTP is validated via the DO Global service
The signature is applied to the PDF document
The signature request status is updated

Security validations

Verifies that the user is indeed a tenant of the lease
Verifies that the person_id derived from the JWT matches the lease signers
Validates the OTP before applying the signature

Required permissions

lessee:leases:sign

Sign a lease as a tenant › path Parameters

id

string · uuid · required

Lease ID to sign

Example: 550e8400-e29b-41d4-a716-446655440000

Sign a lease as a tenant › Request Body

document_signature_id

string · uuid · required

Signature document ID to sign

Example: 550e8400-e29b-41d4-a716-446655440001

otp

string · minLength: 4 · maxLength: 8 · required

OTP code received via SMS or email

Example: 123456

Sign a lease as a tenant › Responses

Signature initiated successfully (asynchronous processing)

success

boolean

Indicates whether the request was accepted

Example: true

message

string

Confirmation message

Example: OTP validation sent to processing queue

document_signature_id

string · uuid

Signature document ID

Example: 550e8400-e29b-41d4-a716-446655440001

signed_media_id

string | null · uuid

Signed PDF media ID (available after processing)

Example: 550e8400-e29b-41d4-a716-446655440002

signed_pdf_url

string | null

Signed PDF URL (available after processing)

Example: https://storage.example.com/signed/lease-550e8400.pdf

POST/lessee/leases/{id}/signature/sign

curl --request POST \
  --url https://api.faireplace.com/api/lessee/leases/:id/signature/sign \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
  "otp": "123456"
}
'

shell

Example Request Body

{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
  "otp": "123456"
}

json

application/json

Example Responses

No example specified for this content type

application/json

Download the signed lease (PDF)

GET

https://api.faireplace.com/api

/lessee/leases/{id}/pdf

Downloads the signed lease PDF, only if the document has been fully signed by all signers.

Required conditions

The signature document must have the status COMPLETED
All signature requests must have the status COMPLETED
The user must be a tenant of the lease

Response format

Content-Type: application/pdf
Content-Disposition: attachment; filename="lease-{id}.pdf"
The file may be encrypted (SSE-C) depending on the security level

Required permissions

lessee:leases:download

Download the signed lease (PDF) › path Parameters

id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

Download the signed lease (PDF) › Responses

Signed lease PDF

string

GET/lessee/leases/{id}/pdf

curl --request GET \
  --url https://api.faireplace.com/api/lessee/leases/:id/pdf

shell

Example Responses

PDF binary content

plain

application/pdf

List lessees associated with a lease

GET

https://api.faireplace.com/api

/leases/{lease_id}/lessees

Retrieves the list of all lease-lessee associations for a specific lease.

List lessees associated with a lease › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

List lessees associated with a lease › Responses

Lease-lessee association list retrieved successfully

object[]

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

GET/leases/{lease_id}/lessees

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "lease_id": "550e8400-e29b-41d4-a716-446655440000",
    "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
    "role_type": "PRIMARY",
    "rent_share": 0.5,
    "start_date": "2024-01-01",
    "end_date": "2025-01-01",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
    "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
    "guarantor_max_amount": 10000,
    "guarantor_conditions": {},
    "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
  }
]

json

application/json

Associate a lessee with a lease

POST

https://api.faireplace.com/api

/leases/{lease_id}/lessees

Creates a new association between a lease and a lessee.

Associate a lessee with a lease › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

Associate a lessee with a lease › Request Body

Data for associating a lessee with a lease

lessee_id

string · uuid · required

Lessee ID to associate

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

lease_id

string | null · uuid

Associated lease ID (can be omitted if in the path)

Example: 550e8400-e29b-41d4-a716-446655440000

rent_share

number | null · decimal · min: 0 · max: 1

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

guarantor_max_amount

number | null · decimal · min: 0

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

Associate a lessee with a lease › Responses

Lease-lessee association created successfully

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

POST/leases/{lease_id}/lessees

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees \
  --header 'Content-Type: application/json' \
  --data '
{
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}
'

shell

Example Request Body

{
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

application/json

List active lessees for a lease

GET

https://api.faireplace.com/api

/leases/{lease_id}/lessees/active

Retrieves the list of currently active lessees for a specific lease.

List active lessees for a lease › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

List active lessees for a lease › Responses

Active lessee list retrieved successfully

object[]

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

GET/leases/{lease_id}/lessees/active

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees/active

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "lease_id": "550e8400-e29b-41d4-a716-446655440000",
    "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
    "role_type": "PRIMARY",
    "rent_share": 0.5,
    "start_date": "2024-01-01",
    "end_date": "2025-01-01",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
    "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
    "guarantor_max_amount": 10000,
    "guarantor_conditions": {},
    "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
  }
]

json

application/json

Get a lease-lessee association

GET

https://api.faireplace.com/api

/leases/{lease_id}/lessees/{lessee_id}

Retrieves the details of a specific association between a lease and a lessee.

Get a lease-lessee association › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Unique lease-lessee association ID

Example: 550e8400-e29b-41d4-a716-446655440001

Get a lease-lessee association › Responses

Lease-lessee association retrieved successfully

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

GET/leases/{lease_id}/lessees/{lessee_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees/:lessee_id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

application/json

Update a lease-lessee association

PUT

https://api.faireplace.com/api

/leases/{lease_id}/lessees/{lessee_id}

Updates the information of a specific association between a lease and a lessee.

Update a lease-lessee association › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Unique lease-lessee association ID

Example: 550e8400-e29b-41d4-a716-446655440001

Update a lease-lessee association › Request Body

Data for updating a lessee-lease association

role_type

string · enum

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

rent_share

number | null · decimal · min: 0 · max: 1

Rent share for this lessee (if co-tenancy)

Example: 0.6

end_date

string | null · date

End date of the association

Example: 2025-06-30

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal · min: 0

Maximum guaranteed amount (if role = GUARANTOR)

Example: 12000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

Update a lease-lessee association › Responses

Lease-lessee association updated successfully

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

PUT/leases/{lease_id}/lessees/{lessee_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees/:lessee_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_type": "PRIMARY",
  "rent_share": 0.6,
  "end_date": "2025-06-30",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 12000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}
'

shell

Example Request Body

{
  "role_type": "PRIMARY",
  "rent_share": 0.6,
  "end_date": "2025-06-30",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 12000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

application/json

Delete a lease-lessee association

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/lessees/{lessee_id}

Deletes a specific association between a lease and a lessee.

Delete a lease-lessee association › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Unique lease-lessee association ID

Example: 550e8400-e29b-41d4-a716-446655440001

Delete a lease-lessee association › Responses

Lease-lessee association deleted successfully

No data returned

DELETE/leases/{lease_id}/lessees/{lessee_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees/:lessee_id

shell

Example Responses

No example specified for this content type

End a lessee's term

PUT

https://api.faireplace.com/api

/leases/{lease_id}/lessees/{lessee_id}/end

Ends a lessee's association with a lease at a specified date, potentially via an amendment.

End a lessee's term › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Unique lease-lessee association ID

Example: 550e8400-e29b-41d4-a716-446655440001

End a lessee's term › Request Body

Data for ending a lessee's association with a lease

end_date

string · date · required

End date of the association

Example: 2025-01-01

amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440000

End a lessee's term › Responses

Lessee term updated successfully

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

PUT/leases/{lease_id}/lessees/{lessee_id}/end

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/lessees/:lessee_id/end \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_date": "2025-01-01",
  "amendment_id": "550e8400-e29b-41d4-a716-446655440000"
}
'

shell

Example Request Body

{
  "end_date": "2025-01-01",
  "amendment_id": "550e8400-e29b-41d4-a716-446655440000"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 10000,
  "guarantor_conditions": {},
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003"
}

json

application/json

Signatures Owners