/v1/facilities/{facility_id}/tenantsAuthentication
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/facilities/<FACILITY_ID>/tenants' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"address": {
"city": "string",
"state": "st",
"street": "string",
"zip": "string",
"country": "US",
"street_2": "string"
},
"first_name": "string",
"last_name": "string",
"alternate_contact": {
"address": {
"city": "string",
"state": "st",
"street": "string",
"zip": "string",
"country": "US",
"street_2": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"relationship": "string"
},
"alternate_contact_declined": false,
"company_name": "string",
"date_of_birth": "2026-10-29",
"email": "string",
"is_business": false,
"is_military": false,
"middle_initial": "st",
"military_service_end_date": "2026-10-29"
}'Parameters
facility_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
addressAddressInputrequiredA structured mailing address.
Show address schema
citystringrequiredMin length: 1 · Max length: 100
countrystringISO 3166-1 alpha-2 code.
Default: "US" · Min length: 2 · Max length: 2
statestringrequiredTwo-letter state or region code.
Min length: 2 · Max length: 2
streetstringrequiredMin length: 1 · Max length: 255
street_2string | nullMax length: 255
Show street_2 schema
string | nullVariant 1: string
stringVariant 2: null
nullzipstringrequiredMin length: 1 · Max length: 10
alternate_contactAlternateContactInput | nullShow alternate_contact schema
AlternateContactInput | nullVariant 1: AlternateContactInput
addressAddressInputrequiredA structured mailing address.
Show address schema
citystringrequiredMin length: 1 · Max length: 100
countrystringISO 3166-1 alpha-2 code.
Default: "US" · Min length: 2 · Max length: 2
statestringrequiredTwo-letter state or region code.
Min length: 2 · Max length: 2
streetstringrequiredMin length: 1 · Max length: 255
street_2string | nullMax length: 255
Show street_2 schema
string | nullVariant 1: string
Variant 2: null
zipstringrequiredMin length: 1 · Max length: 10
emailstring | nullMax length: 255
Show email schema
string | nullVariant 1: string
stringVariant 2: null
nullfirst_namestringrequiredMin length: 1 · Max length: 100
last_namestringrequiredMin length: 1 · Max length: 100
phonestring | nullMax length: 20
Show phone schema
string | nullVariant 1: string
stringVariant 2: null
nullrelationshipstring | nullMax length: 50
Show relationship schema
string | nullVariant 1: string
stringVariant 2: null
nullVariant 2: null
nullalternate_contact_declinedbooleanThe tenant declined to name an alternate contact.
Default: false
company_namestring | nullMax length: 255
Show company_name schema
string | nullVariant 1: string
stringVariant 2: null
nulldate_of_birthstring | nullFormat: date
Show date_of_birth schema
string | nullVariant 1: string
stringVariant 2: null
nullemailstring | nullMax length: 255
Show email schema
string | nullVariant 1: string
stringVariant 2: null
nullfirst_namestringrequiredMin length: 1 · Max length: 100
is_businessbooleanDefault: false
is_militaryboolean | nullMilitary status. Null means not asked.
Show is_military schema
boolean | nullMilitary status. Null means not asked.
Variant 1: boolean
booleanVariant 2: null
nulllast_namestringrequiredMin length: 1 · Max length: 100
middle_initialstring | nullMax length: 2
Show middle_initial schema
string | nullVariant 1: string
stringVariant 2: null
nullmilitary_service_end_datestring | nullFormat: date
Show military_service_end_date schema
string | nullVariant 1: string
stringVariant 2: null
nullphonestring | nullAt KISS facilities this number is the app sign-in.
Max length: 20
Show phone schema
string | nullAt KISS facilities this number is the app sign-in.
Variant 1: string
stringVariant 2: null
nullsms_consentSmsConsentInput | nullA consent staff obtained (attested). A lead's consent is copied only when the phones match.
Show sms_consent schema
SmsConsentInput | nullA consent staff obtained (attested). A lead's consent is copied only when the phones match.
Variant 1: SmsConsentInput
attestationbooleanrequiredevidence_document_idstring | nullFormat: uuid
Show evidence_document_id schema
string | nullVariant 1: string
stringVariant 2: null
nullobtained_atstringrequiredFormat: date-time
sourcestringrequiredValues: "staff_in_person", "staff_phone", "signed_document"
Variant 2: null
nulltax_exemptbooleanDefault: false
tax_exempt_idstring | nullMax length: 50
Show tax_exempt_id schema
string | nullVariant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
201Successful Response
{
"data": {
"addresses": [
{
"address_type": "string",
"city": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_primary": false,
"state": "string",
"street": "string",
"zip": "string",
"country": "US",
"latitude": "<VALUE_MATCHING_PATTERN>",
"longitude": "<VALUE_MATCHING_PATTERN>",
"street_2": "string",
"verification_status": "string"
}
],
"communication_preferences": {
"email_suppressed": false,
"invoice_delivery": "string",
"marketing_sms_opt_in_evidence_id": "00000000-0000-4000-8000-000000000001",
"marketing_sms_opt_in_recorded_by": "00000000-0000-4000-8000-000000000001",
"marketing_sms_opt_in_source": "string",
"marketing_sms_opted_in_at": "2026-10-29T12:00:00Z",
"marketing_sms_revoked_at": "2026-10-29T12:00:00Z",
"preferred_channels": [
"string"
],
"sms_opt_in_evidence_id": "00000000-0000-4000-8000-000000000001",
"sms_opt_in_recorded_by": "00000000-0000-4000-8000-000000000001",
"sms_opt_in_source": "storedge_import",
"sms_opted_in_at": "2026-10-29T12:00:00Z"
},
"contacts": [
{
"contact_type": "string",
"created_at": "2026-10-29T12:00:00Z",
"first_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_gate_access_authorized": false,
"last_name": "string",
"updated_at": "2026-10-29T12:00:00Z",
"address": {
"address_type": "string",
"city": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_primary": false,
"state": "string",
"street": "string",
"zip": "string",
"country": "US",
"latitude": "<VALUE_MATCHING_PATTERN>",
"longitude": "<VALUE_MATCHING_PATTERN>",
"street_2": "string",
"verification_status": "string"
},
"email": "string",
"phone": "string",
"relationship": "string"
}
],
"created_at": "2026-10-29T12:00:00Z",
"delinquency_exempt": false,
"facility_id": "00000000-0000-4000-8000-000000000001",
"first_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_business": false,
"last_name": "string",
"leases": [
{
"id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"next_billing_date": "2026-10-29",
"rate": "<VALUE_MATCHING_PATTERN>",
"start_date": "2026-10-29",
"status": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"unit_number": "string",
"insurance_plan": {
"coverage_amount": "<VALUE_MATCHING_PATTERN>",
"id": "00000000-0000-4000-8000-000000000001",
"monthly_premium": "<VALUE_MATCHING_PATTERN>",
"name": "string"
}
}
],
"payment_methods": [
{
"added_via": "string",
"created_at": "2026-10-29T12:00:00Z",
"id": "00000000-0000-4000-8000-000000000001",
"is_active": false,
"is_chargeable": false,
"is_default": false,
"method_type": "string",
"provider": "string",
"updated_at": "2026-10-29T12:00:00Z",
"ach_account_type": "string",
"ach_bank_name": "string",
"bank_holder_type": "string"
}
],
"portal_enabled": false,
"status": "string",
"system_tags": [
"string"
],
"tags": [
{
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"name": "string",
"color": "string"
}
],
"tax_exempt": false,
"tenant_number": "string",
"total_balance": "<VALUE_MATCHING_PATTERN>",
"updated_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataTenantCreatedResponserequiredA tenant just created (Step 13 design 5.6), with Rental Review's warnings.
Show data schema
access_contactsTenantAccessContactResponse[]How this tenant's name and phone reach each access-control provider; empty until a provider has linked them.
Show access_contacts schema
holder_hiddenbooleanTrue when another tenant record holds the account but the caller cannot read tenants at its facility, so it is not named; false when none holds it yet.
Default: false
holder_namestring | nullThat record's name, under the same rule.
Show holder_name schema
string | nullThat record's name, under the same rule.
Variant 1: string
stringVariant 2: null
nullholder_tenant_idstring | nullWhen the name and phone sent are another tenant record's, that record; null when none is found or the caller cannot read tenants at its facility.
Format: uuid
Show holder_tenant_id schema
string | nullWhen the name and phone sent are another tenant record's, that record; null when none is found or the caller cannot read tenants at its facility.
Variant 1: string
stringVariant 2: null
nulllink_statusstringrequiredThe tenant's account link with the provider: new, linked or needs_review.
owns_contactbooleanrequiredTrue when this tenant record holds the provider account's name and phone; it stays true while the link is under review.
providerstringrequiredThe access-control provider, for example kiss.
sends_contactbooleanrequiredTrue when an edit to this tenant's name or phone is sent to the provider, where the phone is how the tenant signs in to open their unit.
sync_activebooleanrequiredTrue while Facily is sending this facility's access to the provider.
sync_pausedbooleanrequiredTrue while that sending is paused: an edit is sent when it resumes.
addressesAddressResponse[]requiredShow addresses schema
address_typestringrequiredWhat the address is used for, for example physical, billing, or mailing.
citystringrequiredCity or town.
countrystringISO 3166-1 alpha-2 country code.
Default: "US"
idstringrequiredUnique identifier for this address.
Format: uuid
is_primarybooleanrequiredTrue for the address used by default when only one is needed.
latitudestring | nullLatitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show latitude schema
string | nullLatitude in decimal degrees, where the address has been geocoded.
Variant 1: string
stringVariant 2: null
nulllongitudestring | nullLongitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show longitude schema
string | nullLongitude in decimal degrees, where the address has been geocoded.
Variant 1: string
stringVariant 2: null
nullstatestringrequiredState, province, or region.
streetstringrequiredFirst line of the street address.
street_2string | nullSecond line, for a unit, suite, or apartment number.
Show street_2 schema
string | nullSecond line, for a unit, suite, or apartment number.
Variant 1: string
stringVariant 2: null
nullverification_statusstring | nullOutcome of address validation, for example verified, unverified, or corrected.
Show verification_status schema
string | nullOutcome of address validation, for example verified, unverified, or corrected.
Variant 1: string
stringVariant 2: null
nullverified_atstring | nullWhen the address was last validated against a postal database.
Format: date-time
Show verified_at schema
string | nullWhen the address was last validated against a postal database.
Variant 1: string
stringVariant 2: null
nullzipstringrequiredPostal or ZIP code.
communication_preferencesTenantCommunicationPreferencesrequiredHow one tenant has agreed to be contacted (design 6.4).
Show communication_preferences schema
email_suppressedbooleanDefault: false
invoice_deliverystring | nullShow invoice_delivery schema
string | nullVariant 1: string
stringVariant 2: null
nullmarketing_sms_opt_in_evidence_idstring | nullFormat: uuid
Show marketing_sms_opt_in_evidence_id schema
string | nullVariant 1: string
stringVariant 2: null
nullmarketing_sms_opt_in_recorded_bystring | nullFormat: uuid
Show marketing_sms_opt_in_recorded_by schema
string | nullVariant 1: string
stringVariant 2: null
nullmarketing_sms_opt_in_sourcestring | nullShow marketing_sms_opt_in_source schema
string | nullVariant 1: string
stringVariant 2: null
nullmarketing_sms_opted_in_atstring | nullFormat: date-time
Show marketing_sms_opted_in_at schema
string | nullVariant 1: string
stringVariant 2: null
nullmarketing_sms_revoked_atstring | nullFormat: date-time
Show marketing_sms_revoked_at schema
string | nullVariant 1: string
stringVariant 2: null
nullpreferred_channelsstring[]Show preferred_channels schema
stringsms_opt_in_evidence_idstring | nullFormat: uuid
Show sms_opt_in_evidence_id schema
string | nullVariant 1: string
stringVariant 2: null
nullsms_opt_in_recorded_bystring | nullFormat: uuid
Show sms_opt_in_recorded_by schema
string | nullVariant 1: string
stringVariant 2: null
nullsms_opt_in_sourcestring | nullValues: "storedge_import", "staff_in_person", "staff_phone", "signed_document", "inbound_sms_start", "web_form", "partner"
Show sms_opt_in_source schema
string | nullVariant 1: string
stringValues: "storedge_import", "staff_in_person", "staff_phone", "signed_document", "inbound_sms_start", "web_form", "partner"
Variant 2: null
nullsms_opted_in_atstring | nullFormat: date-time
Show sms_opted_in_at schema
string | nullVariant 1: string
stringVariant 2: null
nullsms_opted_outbooleanDefault: false
company_namestring | nullLegal business name. Present only when is_business is true.
Show company_name schema
string | nullLegal business name. Present only when is_business is true.
Variant 1: string
stringVariant 2: null
nullcontactsTenantContactResponse[]requiredShow contacts schema
addressAddressResponse | nullThe contact's mailing address. Returned by the contact writes; the list leaves it out.
Show address schema
AddressResponse | nullThe contact's mailing address. Returned by the contact writes; the list leaves it out.
Variant 1: AddressResponse
address_typestringrequiredWhat the address is used for, for example physical, billing, or mailing.
citystringrequiredCity or town.
countrystringISO 3166-1 alpha-2 country code.
Default: "US"
idstringrequiredUnique identifier for this address.
Format: uuid
is_primarybooleanrequiredTrue for the address used by default when only one is needed.
latitudestring | nullLatitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
longitudestring | nullLongitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
statestringrequiredState, province, or region.
streetstringrequiredFirst line of the street address.
street_2string | nullSecond line, for a unit, suite, or apartment number.
verification_statusstring | nullOutcome of address validation, for example verified, unverified, or corrected.
verified_atstring | nullWhen the address was last validated against a postal database.
Format: date-time
zipstringrequiredPostal or ZIP code.
Variant 2: null
nullcontact_typestringrequiredcreated_atstringrequiredFormat: date-time
emailstring | nullShow email schema
string | nullVariant 1: string
stringVariant 2: null
nullfirst_namestringrequiredidstringrequiredFormat: uuid
is_gate_access_authorizedbooleanrequiredlast_namestringrequiredphonestring | nullShow phone schema
string | nullVariant 1: string
stringVariant 2: null
nullrelationshipstring | nullShow relationship schema
string | nullVariant 1: string
stringVariant 2: null
nullupdated_atstringrequiredFormat: date-time
created_atstringrequiredWhen the tenant record was created.
Format: date-time
date_of_birthstring | nullFormat: date
Show date_of_birth schema
string | nullVariant 1: string
stringVariant 2: null
nulldelinquency_exemptbooleanrequiredTrue when staff have held this tenant out of the delinquency engine: no fees, no escalation, no notices.
delinquency_summaryTenantDelinquencySummary | nullShow delinquency_summary schema
TenantDelinquencySummary | nullVariant 1: TenantDelinquencySummary
delinquent_lease_countintegerrequiredmax_days_past_dueintegerrequiredtotal_past_duestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
worst_stagestringrequiredVariant 2: null
nulldo_not_rent_atstring | nullWhen staff first flagged this person as do not rent; null when not flagged.
Format: date-time
Show do_not_rent_at schema
string | nullWhen staff first flagged this person as do not rent; null when not flagged.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_bystring | nullThe staff user who first flagged this person.
Format: uuid
Show do_not_rent_by schema
string | nullThe staff user who first flagged this person.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_notestring | nullThe staff note that goes with the flag.
Show do_not_rent_note schema
string | nullThe staff note that goes with the flag.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_reasonstring | nullWhy staff should not rent to this person: delinquency, fraud, damage, conduct or other.
Values: "delinquency", "fraud", "damage", "conduct", "other"
Show do_not_rent_reason schema
string | nullWhy staff should not rent to this person: delinquency, fraud, damage, conduct or other.
Variant 1: string
stringValues: "delinquency", "fraud", "damage", "conduct", "other"
Variant 2: null
nulldrivers_license_numberstring | nullShow drivers_license_number schema
string | nullVariant 1: string
stringVariant 2: null
nulldrivers_license_statestring | nullShow drivers_license_state schema
string | nullVariant 1: string
stringVariant 2: null
nullemailstring | nullPrimary email address, used for billing and notices.
Show email schema
string | nullPrimary email address, used for billing and notices.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility this tenant belongs to. A person renting at two sites is two tenant records.
Format: uuid
first_namestringrequiredGiven name. For a business tenant this is the contact person.
idstringrequiredUnique identifier for this tenant.
Format: uuid
is_businessbooleanrequiredTrue when the tenant is an organization rather than an individual.
last_namestringrequiredFamily name. For a business tenant this is the contact person.
leasesLeaseCompactResponse[]requiredThe tenant's leases, so a listing can show what they rent without a second call.
Show leases schema
idstringrequiredUnique identifier for the lease.
Format: uuid
insurance_planInsurancePlanCompactResponse | nullThe protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.
Show insurance_plan schema
InsurancePlanCompactResponse | nullThe protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.
Variant 1: InsurancePlanCompactResponse
coverage_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
idstringrequiredFormat: uuid
monthly_premiumstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
namestringrequiredVariant 2: null
nulllease_numberstringrequiredOperator-facing lease reference, unique within the facility.
next_billing_datestringrequiredBusiness date rent is next charged.
Format: date
ratestringrequiredCurrent monthly rent charged under this lease.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
start_datestringrequiredBusiness date the lease began.
Format: date
statusstringrequiredLifecycle state of the lease.
tenant_idstringrequiredThe tenant renting under this lease.
Format: uuid
tenant_namestringrequiredThe tenant's display name, denormalized so a listing needs no second call.
unit_numberstringrequiredLabel of the unit this lease occupies.
middle_initialstring | nullMiddle initial, where recorded.
Show middle_initial schema
string | nullMiddle initial, where recorded.
Variant 1: string
stringVariant 2: null
nullnotesstring | nullShow notes schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_methodsPaymentMethodResponse[]requiredShow payment_methods schema
ach_account_typestring | nullWhether the ACH account is checking or savings.
Show ach_account_type schema
string | nullWhether the ACH account is checking or savings.
Variant 1: string
stringVariant 2: null
nullach_bank_namestring | nullName of the bank holding the account, for an ACH method.
Show ach_bank_name schema
string | nullName of the bank holding the account, for an ACH method.
Variant 1: string
stringVariant 2: null
nulladded_viastringrequiredHow the method was stored, for example by the tenant in the portal or by staff.
bank_holder_typestring | nullWhether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.
Show bank_holder_type schema
string | nullWhether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.
Variant 1: string
stringVariant 2: null
nullbin_typestring | nullCREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.
Show bin_type schema
string | nullCREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.
Variant 1: string
stringVariant 2: null
nullcard_brandstring | nullCard network, for example Visa or Mastercard.
Show card_brand schema
string | nullCard network, for example Visa or Mastercard.
Variant 1: string
stringVariant 2: null
nullcard_exp_monthinteger | nullCard expiry month, 1 to 12.
Show card_exp_month schema
integer | nullCard expiry month, 1 to 12.
Variant 1: integer
integerVariant 2: null
nullcard_exp_yearinteger | nullCard expiry year, four digits.
Show card_exp_year schema
integer | nullCard expiry year, four digits.
Variant 1: integer
integerVariant 2: null
nullcreated_atstringrequiredWhen the method was stored.
Format: date-time
idstringrequiredUnique identifier for this stored payment method.
Format: uuid
is_activebooleanrequiredWhether the method may currently be charged.
is_chargeablebooleanrequiredTrue when this method can actually be charged: a live, non-deleted token at the current processor. A migrated legacy row is false.
is_defaultbooleanrequiredTrue for the method charged when no other is specified.
last_fourstring | nullLast four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.
Show last_four schema
string | nullLast four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.
Variant 1: string
stringVariant 2: null
nullmethod_typestringrequiredThe instrument type, for example card or ACH.
nicknamestring | nullStaff-set label, for telling two cards on file apart.
Show nickname schema
string | nullStaff-set label, for telling two cards on file apart.
Variant 1: string
stringVariant 2: null
nullproviderstringrequiredWho holds the token: stax for a chargeable method, legacy for a method migrated from the previous system whose token has not yet been imported.
updated_atstringrequiredWhen the method was last modified.
Format: date-time
phonestring | nullPrimary telephone number.
Show phone schema
string | nullPrimary telephone number.
Variant 1: string
stringVariant 2: null
nullportal_enabledbooleanrequiredWhether the tenant can sign in to the self-service portal.
primary_addressAddressResponse | nullShow primary_address schema
AddressResponse | nullVariant 1: AddressResponse
address_typestringrequiredWhat the address is used for, for example physical, billing, or mailing.
citystringrequiredCity or town.
countrystringISO 3166-1 alpha-2 country code.
Default: "US"
idstringrequiredUnique identifier for this address.
Format: uuid
is_primarybooleanrequiredTrue for the address used by default when only one is needed.
latitudestring | nullLatitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show latitude schema
string | nullLatitude in decimal degrees, where the address has been geocoded.
Variant 1: string
Variant 2: null
longitudestring | nullLongitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show longitude schema
string | nullLongitude in decimal degrees, where the address has been geocoded.
Variant 1: string
Variant 2: null
statestringrequiredState, province, or region.
streetstringrequiredFirst line of the street address.
street_2string | nullSecond line, for a unit, suite, or apartment number.
Show street_2 schema
string | nullSecond line, for a unit, suite, or apartment number.
Variant 1: string
Variant 2: null
verification_statusstring | nullOutcome of address validation, for example verified, unverified, or corrected.
Show verification_status schema
string | nullOutcome of address validation, for example verified, unverified, or corrected.
Variant 1: string
Variant 2: null
verified_atstring | nullWhen the address was last validated against a postal database.
Format: date-time
Show verified_at schema
string | nullWhen the address was last validated against a postal database.
Variant 1: string
Variant 2: null
zipstringrequiredPostal or ZIP code.
Variant 2: null
nullrental_review_warningsRentalReviewWarningResponse[]People flagged as do not rent at any facility of the organization whom this tenant's email, phone or name matches; empty when none do. Never names the flagged tenant; never blocks.
Show rental_review_warnings schema
facility_namestringrequiredThe facility where the matching person is flagged.
flagged_onstringrequiredThe date they were first flagged, at the facility that flagged them.
Format: date
matched_onstring[]requiredWhich of the lead's email, phone and name matched, in that order.
Show matched_on schema
stringreasonstringrequiredWhy they were flagged: delinquency, fraud, damage, conduct or other.
Values: "delinquency", "fraud", "damage", "conduct", "other"
statusstringrequiredLifecycle state of the tenant relationship, for example active, former, or lead.
system_tagsstring[]requiredLabels the platform derives automatically, such as delinquency state. Not operator-editable.
Show system_tags schema
stringtagsTagResponse[]requiredOperator-defined labels applied manually.
Show tags schema
colorstring | nullColour used to render the tag, as a hex code.
Show color schema
string | nullColour used to render the tag, as a hex code.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility this tag is defined for.
Format: uuid
idstringrequiredUnique identifier for this tag.
Format: uuid
namestringrequiredDisplay label of the tag.
tax_exemptbooleanrequiredTrue when the tenant is exempt from sales tax on rent.
tax_exempt_idstring | nullThe exemption certificate number substantiating tax_exempt.
Show tax_exempt_id schema
string | nullThe exemption certificate number substantiating tax_exempt.
Variant 1: string
stringVariant 2: null
nulltenant_numberstringrequiredOperator-facing tenant reference, unique within the facility.
total_balancestringrequiredSum owed across all of this tenant's leases. Positive means money is owed; negative is a credit.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
updated_atstringrequiredWhen the tenant record was last modified.
Format: date-time
vehicle_descriptionstring | nullDescription of a stored vehicle, where the facility rents parking.
Show vehicle_description schema
string | nullDescription of a stored vehicle, where the facility rents parking.
Variant 1: string
stringVariant 2: null
nullvehicle_license_platestring | nullRegistration plate of a stored vehicle.
Show vehicle_license_plate schema
string | nullRegistration plate of a stored vehicle.
Variant 1: string
stringVariant 2: null
nullvehicle_license_statestring | nullIssuing state or province of the vehicle registration.
Show vehicle_license_state schema
string | nullIssuing state or province of the vehicle registration.
Variant 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