/v1/leases/{lease_id}/agreementAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request GET \
--url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/agreement' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
lease_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"consent_text": "string",
"consent_version": "string",
"html": "string",
"is_placeholder": false,
"lease_id": "00000000-0000-4000-8000-000000000001",
"sha256": "string",
"signature_document_id": "00000000-0000-4000-8000-000000000001",
"signature_method": "string",
"signature_request": {
"channel": "string",
"expires_at": "2026-10-29T12:00:00Z",
"id": "00000000-0000-4000-8000-000000000001",
"last_reminder_at": "2026-10-29T12:00:00Z",
"lease_id": "00000000-0000-4000-8000-000000000001",
"reminder_count": 0,
"sent_at": "2026-10-29T12:00:00Z",
"signed_at": "2026-10-29T12:00:00Z",
"status": "string"
},
"signed_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataLeaseAgreementResponserequiredThe lease's rental agreement as a signer sees it, and its signing state.
Show data schema
consent_textstringrequiredconsent_versionstringrequiredhtmlstringrequiredThe agreement, rendered for this lease.
is_placeholderbooleanrequiredThe facility's agreement is still Facily's sample; accept and signing refuse it.
lease_idstringrequiredFormat: uuid
sha256stringrequiredSHA-256 (hex) of `html`; a signature submits it as `seen_sha256`.
signature_document_idstring | nullrequiredThe signed agreement's document.
Format: uuid
Show signature_document_id schema
string | nullThe signed agreement's document.
Variant 1: string
stringVariant 2: null
nullsignature_methodstring | nullrequiredin_person, paper, remote or storedge_import.
Show signature_method schema
string | nullin_person, paper, remote or storedge_import.
Variant 1: string
stringVariant 2: null
nullsignature_requestSignatureRequestResponse | nullrequiredThe newest remote request, if any.
Show signature_request schema
SignatureRequestResponse | nullThe newest remote request, if any.
Variant 1: SignatureRequestResponse
channelstringrequiredexpires_atstringrequiredFormat: date-time
idstringrequiredFormat: uuid
last_reminder_atstring | nullrequiredFormat: date-time
Show last_reminder_at schema
string | nullVariant 1: string
Variant 2: null
lease_idstringrequiredFormat: uuid
reminder_countintegerrequiredsent_atstring | nullrequiredFormat: date-time
Show sent_at schema
string | nullVariant 1: string
Variant 2: null
signed_atstring | nullrequiredFormat: date-time
Show signed_at schema
string | nullVariant 1: string
Variant 2: null
statusstringrequiredsent, viewed, signed, expired or revoked.
Variant 2: null
nullsigned_atstring | nullrequiredFormat: date-time
Show signed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired