/v1/leases/{lease_id}/signature-requestsAuthentication
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 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"
}'Parameters
lease_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
channelstringWhere 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
{
"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
dataSignatureRequestResponserequiredA remote signing request's state. The link itself is never returned.
Show data schema
channelstringrequiredexpires_atstringrequiredFormat: date-time
idstringrequiredFormat: uuid
last_reminder_atstring | nullrequiredFormat: date-time
Show last_reminder_at schema
string | nullVariant 1: string
stringVariant 2: null
nulllease_idstringrequiredFormat: uuid
reminder_countintegerrequiredsent_atstring | nullrequiredFormat: date-time
Show sent_at schema
string | nullVariant 1: string
stringVariant 2: null
nullsigned_atstring | nullrequiredFormat: date-time
Show signed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullstatusstringrequiredsent, viewed, signed, expired or revoked.
metaMetarequiredEnvelope 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