Schemas
InviteRecipient
A prospective resident who has been invited to apply to TheGuarantors.
Example:
"dana.whitfield@example.com"
Example:
"Dana"
Example:
"ivre_01HQ8Y"
Example:
"Whitfield"
URL that links the prospective renter to their prefilled TheGuarantors application.
Example:
"https://qualify.theguarantors.com/invite/sign-up/k3v9q2m7x1p4r8tz"
Example:
"invite_recipient"
Phone number in E.164 format, for example +12125551234. Spaces and formatting characters such as parentheses, dashes and dots are removed. A 10-digit number without a country code is treated as a US number and gets +1 added. Include the + and country code for any other number.
Example:
"+15551234567"
⌘I
{
"email": "dana.whitfield@example.com",
"first_name": "Dana",
"id": "ivre_01HQ8Y",
"last_name": "Whitfield",
"link": "https://qualify.theguarantors.com/invite/sign-up/k3v9q2m7x1p4r8tz",
"object": "invite_recipient",
"metadata": {},
"phone_number": "+15551234567"
}