Lease Annexes

Verifier la conformite des annexes

Verifie la conformite reglementaire des annexes d'un bail en comparant les annexes presentes avec les exigences legales du type de bail.

Le rapport indique :

  • is_compliant : true si toutes les annexes obligatoires sont presentes et incluses
  • mandatory : detail de chaque annexe obligatoire avec son statut (present, excluded, missing)
  • recommended : annexes recommandees mais non obligatoires

Cas d'usage : Appelez cet endpoint avant de finaliser un bail ou d'initier une signature electronique pour vous assurer que le dossier est complet.

get/leases/{lease_id}/annexes/compliance

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/annexes/compliance
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Identifiant du bail a verifier.

Response

Rapport de conformite genere avec succes.

lease_idstring uuid required

Identifiant du bail verifie.

is_compliantboolean required

true si toutes les annexes obligatoires sont presentes et incluses. false si au moins une annexe obligatoire est manquante.

total_annexesinteger required

Nombre total d'annexes attachees au bail.

included_annexesinteger required

Nombre d'annexes incluses (non exclues) dans le dossier.

Example response

{
  "total_annexes": 3,
  "included_annexes": 3,
  "mandatory": [
    {
      "annex_type": "NOTICE_INFORMATION",
      "name": "Notice d'information",
      "status": "missing"
    }
  ],
  "recommended": [
    {
      "annex_type": "NOTICE_INFORMATION",
      "name": "Notice d'information",
      "status": "missing"
    }
  ]
}

Changes

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