Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsSend Signature Request
Search the full API reference Esc to close

Send Signature Request

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/signature-requests
Send the agreement to the tenant to sign remotely, by email, text or both: a link to the public signing page that lasts 7 days. A newer request revokes the open one. The link is not returned. 409 `esign_not_sendable` (the facility's e-sign messages are off, or the tenant cannot be reached: `details.unreachable`), `lease_already_signed`, `lease_not_signable`, `rental_agreement_not_configured`.

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-requests' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "email"
}'
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

channelstring

Where the link goes. A text goes only to a tenant with recorded SMS consent.

Default: "email" · Values: "email", "sms", "both"

Responses

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

201Successful Response
JSON · generated example
{
  "data": {
    "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"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataSignatureRequestResponserequired

A remote signing request's state. The link itself is never returned.

Show data schema
channelstringrequired
expires_atstringrequired

Format: date-time

idstringrequired

Format: uuid

last_reminder_atstring | nullrequired

Format: date-time

Show last_reminder_at schema
string | null
Variant 1: string
string
Variant 2: null
null
lease_idstringrequired

Format: uuid

reminder_countintegerrequired
sent_atstring | nullrequired

Format: date-time

Show sent_at schema
string | null
Variant 1: string
string
Variant 2: null
null
signed_atstring | nullrequired

Format: date-time

Show signed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
statusstringrequired

sent, viewed, signed, expired or revoked.

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

Send Signature Request | Facily Developers