/v1/leases/{lease_id}/insuranceAuthentication
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 PUT \
--url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/insurance' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"coverage_type": "facility_plan",
"insurance_plan_id": "00000000-0000-4000-8000-000000000001",
"own_policy": {
"carrier": "string",
"certificate_document_id": "00000000-0000-4000-8000-000000000001",
"expires_on": "2026-10-29",
"policy_number": "string"
}
}'Parameters
lease_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
coverage_typestringrequiredValues: "facility_plan", "own_policy", "declined"
insurance_plan_idstring | nullThe facility's plan. Required for facility_plan, refused otherwise.
Format: uuid
Show insurance_plan_id schema
string | nullThe facility's plan. Required for facility_plan, refused otherwise.
Variant 1: string
stringVariant 2: null
nullown_policyOwnPolicyRequest | nullRequired for own_policy, refused otherwise.
Show own_policy schema
OwnPolicyRequest | nullRequired for own_policy, refused otherwise.
Variant 1: OwnPolicyRequest
carrierstringrequiredThe insurer.
Min length: 1 · Max length: 100
certificate_document_idstring | nullAn uploaded certificate of insurance (a document on the tenant or lease).
Format: uuid
Show certificate_document_id schema
string | nullAn uploaded certificate of insurance (a document on the tenant or lease).
Variant 1: string
stringVariant 2: null
nullexpires_onstring | nullFormat: date
Show expires_on schema
string | nullVariant 1: string
stringVariant 2: null
nullpolicy_numberstring | nullMax length: 100
Show policy_number schema
string | nullVariant 1: string
stringVariant 2: null
nullVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"coverage_type": "string",
"effective_date": "2026-10-29",
"id": "00000000-0000-4000-8000-000000000001",
"lease_id": "00000000-0000-4000-8000-000000000001",
"status": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"cancel_reason": "string",
"cancellation_date": "2026-10-29",
"carrier": "string",
"certificate_document_id": "00000000-0000-4000-8000-000000000001",
"coverage_amount": "<VALUE_MATCHING_PATTERN>",
"expires_on": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataInsuranceEnrollmentResponserequiredShow data schema
cancel_reasonstring | nullShow cancel_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullcancellation_datestring | nullFormat: date
Show cancellation_date schema
string | nullVariant 1: string
stringVariant 2: null
nullcarrierstring | nullShow carrier schema
string | nullVariant 1: string
stringVariant 2: null
nullcertificate_document_idstring | nullFormat: uuid
Show certificate_document_id schema
string | nullVariant 1: string
stringVariant 2: null
nullcoverage_amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show coverage_amount schema
string | nullVariant 1: string
stringVariant 2: null
nullcoverage_typestringrequiredeffective_datestringrequiredFormat: date
expires_onstring | nullFormat: date
Show expires_on schema
string | nullVariant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
insurance_plan_idstring | nullFormat: uuid
Show insurance_plan_id schema
string | nullVariant 1: string
stringVariant 2: null
nulllease_idstringrequiredFormat: uuid
policy_numberstring | nullShow policy_number schema
string | nullVariant 1: string
stringVariant 2: null
nullpredecessor_enrollment_idstring | nullFormat: uuid
Show predecessor_enrollment_id schema
string | nullVariant 1: string
stringVariant 2: null
nullpremiumstring | nullThe monthly premium billed, snapshotted from the plan.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show premium schema
string | nullThe monthly premium billed, snapshotted from the plan.
Variant 1: string
stringVariant 2: null
nullstart_reasonstring | nullShow start_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullstatusstringrequiredtenant_idstringrequiredFormat: uuid
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