Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsSign Lease In Person
Search the full API reference Esc to close

Sign Lease In Person

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/signature
Sign the agreement at the counter: the typed name, the consent, an optional drawing (PNG, at most 200 KB) and the hash shown. The signed PDF is filed on the lease; a move-in that waited only for the signature completes. 409 `agreement_changed` (details: the current `sha256`), `lease_already_signed`, `lease_not_signable`, `rental_agreement_not_configured`, `quote_busy`, `lease_busy`.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/signature' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "consent_version": "string",
  "consented": false,
  "seen_sha256": "<VALUE_MATCHING_PATTERN>",
  "typed_name": "string",
  "drawing_png": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

lease_idpath · stringrequired

Format: uuid

Request body

application/json · Required

consent_versionstringrequired

The version of the consent shown.

Min length: 1 · Max length: 30

consentedbooleanrequired

The signer ticked the electronic-signature consent shown with `consent_version`.

drawing_pngstring | null

The drawn signature: a base64-encoded PNG of at most 200 KB.

Max length: 1000000

Show drawing_png schema
string | null

The drawn signature: a base64-encoded PNG of at most 200 KB.

Variant 1: string
string
Variant 2: null
null
seen_sha256stringrequired

The SHA-256 of the agreement as shown; 409 agreement_changed if not.

Pattern: ^[0-9a-fA-F]{64}$

typed_namestringrequired

The signer's full name, typed.

Min length: 1 · Max length: 255

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "lease_id": "00000000-0000-4000-8000-000000000001",
    "signature_document_id": "00000000-0000-4000-8000-000000000001",
    "signature_method": "string",
    "signed_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeaseSignatureResponserequired

A signature recorded.

Show data schema
lease_idstringrequired

Format: uuid

signature_document_idstringrequired

Format: uuid

signature_methodstringrequired
signed_atstringrequired

Format: date-time

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll leases operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Sign Lease In Person | Facily Developers