Leases
Signatures

Signature status of a lease

Retrieves the signature status for this specific lease. This route fetches the latest document_signature for the lease and queries DO Global to obtain the current state of the signature.

get/leases/{lease_id}/signature/status

Request

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

Path parameters

lease_idstring uuid required

Lease ID

Response

Status retrieved successfully

lease_idstring uuid required

Lease ID

document_signature_idstring uuid required

Signature process ID

stateobject required

Signature state from DO Global (dynamic structure)

Example response

{
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "state": {
    "status": "SIGNING",
    "signers": [
      {
        "signer_type": "PROPRIETAIRE",
        "status": "COMPLETED"
      },
      {
        "signer_type": "LOCATAIRE",
        "status": "PENDING"
      }
    ]
  }
}

Changes

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