Lessees
Leases
Signatures

Get signature status of a lease for the tenant

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/lessee/leases/{id}/signature/status

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/lessee/leases/{id}/signature/status
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Lease ID

Response

Signature status retrieved successfully

lease_idstring uuid

Lease ID

document_signature_idstring uuid

Signature document ID

status'READY' | 'SIGNING' | 'COMPLETED' | 'FAILED' | 'ARCHIVED'

Signature document status

signed_media_idstring uuid nullable

Signed PDF media ID (available after full signature completion)

Example response

{
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "SIGNING",
  "signed_media_id": "550e8400-e29b-41d4-a716-446655440002",
  "requests": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
      "signer_type": "proprietaire",
      "signer_phone": "+33612345678",
      "signer_email": "proprietaire@example.com",
      "status": "COMPLETED",
      "signed_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
      "signer_type": "locataire",
      "signer_phone": "+33612345679",
      "signer_email": "locataire@example.com",
      "status": "PENDING",
      "signed_at": null
    }
  ]
}

Changes

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