Invite a co-applicant
Creates a second rental application for someone applying alongside this applicant, links the two into a group, and emails the invitee a link to fill theirs in. Requires the rental_applications:write permission.
Authorization
AuthorizationstringrequiredPath parameters
applicationIdstringrequiredThe rental application to work with. A Snowflake id, sent as a decimal string.
Body
application/json
firstNamestringrequiredThe co-applicant's first name. Between 1 and 250 characters.
lastNamestringrequiredThe co-applicant's last name. Between 1 and 250 characters.
emailstring · emailWhere to send the invitation. Without a valid address the co-applicant is still created but no invitation goes out.
phonestringThe co-applicant's phone number.
messagestringA personal note included in the invitation email. At most 2500 characters.
Response
200 · The co-applicant's own new rental application, in summary form. It is a fresh draft, so the stage is `draft`, `daysInStage` is `0` and `needs.kinds` is empty.
idstringThe co-applicant's rental application.
companyIdstringThe company that owns it.
statusenum<string>Always draft on a fresh invite.
submittedAtstring · date-timeAbsent on a fresh invite.
decisionenum<string>Always noDecision on a fresh invite.
isQualifiedDraftbooleanTrue, since an invite always carries a first and last name.
aiApplicationScoreintegerAbsent on a fresh invite.
screeningSummaryenum<string>Always screeningNotCompleted on a fresh invite.
stageenum<string>Always draft on a fresh invite.
daysInStageintegerAlways 0 on a fresh invite.
needsobjectAttention buckets. Always empty on a fresh invite.
paymentStatusenum<string>Absent on a fresh invite.
groupIdstringThe group tying the co-applicant to the original applicant. A UUID string.
firstNamestringThe co-applicant's first name.
lastNamestringThe co-applicant's last name.
emailstring · emailThe co-applicant's email address.
phonestringThe co-applicant's phone number.
createdstring · date-timeWhen the invite was created, in the company's timezone.
updatedstring · date-timeWhen it last changed, in the company's timezone.
400 · The application you are inviting from has no first or last name of its own. Fill those in before inviting anyone.
401 · The access token is missing, expired, or not valid.
403 · The caller is authenticated but does not hold the `rental_applications:write` permission.
404 · No rental application with this id exists, or it belongs to another company. Both cases look identical so that ids cannot be probed across companies.
This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.
The invitee gets their own rental application with its own id, screening, documents and decision. The two are tied together by a shared groupId, and each one lists the others under coApplicants.
The co-applicant's application is still created when the email address is missing or malformed — the invitation is simply skipped, and the call still succeeds. Check the address before you rely on the invite arriving.