Lease Annexes

Review the signature dossier

Reviews the documents (annexes) required before a lease can be sent for signature.

Returns, for each expected annex, whether it is mandatory or recommended, whether it is currently included, and its materialization state (READY, TO_GENERATE, TO_UPLOAD, or MISSING). The top-level is_ready_to_sign flag indicates whether all mandatory annexes are ready.

Usage Example

curl -X GET https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/annexes/signature-dossier \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "is_ready_to_sign": false,
  "items": [
    {
      "annex_type": "Dpe",
      "name": "Diagnostic de Performance Énergétique (DPE)",
      "requirement": "MANDATORY",
      "included": true,
      "materialization": "READY",
      "annex_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "annex_type": "EtatRisques",
      "name": "État des Risques et Pollutions (ERP)",
      "requirement": "MANDATORY",
      "included": false,
      "materialization": "MISSING",
      "annex_id": null
    }
  ]
}
get/leases/{lease_id}/annexes/signature-dossier

Request

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

Path parameters

lease_idstring uuid required

Lease ID

Response

Signature dossier reviewed successfully

is_ready_to_signboolean required

Whether all mandatory annexes are ready and the lease can be signed.

Example response

{
  "items": [
    {
      "annex_type": "NOTICE_INFORMATION",
      "name": "Diagnostic de Performance Énergétique (DPE)",
      "requirement": "MANDATORY",
      "included": true,
      "materialization": "READY",
      "annex_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Changes

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