Schemas
Applicant
An individual who submits a rental application to be considered for occupancy on a specific lease.
Example:
"dana.whitfield@example.com"
Example:
"Dana"
Unique identifier.
Example:
"applc_01HQ9A"
Example:
"Whitfield"
Example:
"applicant"
Enum representing the applicant's current state in the application process.
Available options:
not_started, started, submitted Example:
"submitted"
Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.
E.164 formatted phone number
Example:
"+15551234567"
⌘I
{
"email": "dana.whitfield@example.com",
"first_name": "Dana",
"id": "applc_01HQ9A",
"last_name": "Whitfield",
"object": "applicant",
"status": "submitted",
"metadata": {},
"phone_number": "+15551234567"
}