Submit a rental application

Submits a draft application on the applicant's behalf, moving it from draft to submitted. Requires the rental_applications:write permission.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

idstringrequired

The rental application to work with. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · The call succeeded at the HTTP level. Check `success` — a refused submission is reported here, not as an error status.

successboolean

Whether the application was submitted.

errorsstring[]

Why it was refused. already_submitted means the application was not in draft status; other entries come from the company's own submission requirements, such as a missing document or unaccepted terms. Empty when success is true.

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.

A refusal still returns 200

This endpoint does not use an error status for a refused submission. Always read success before treating the application as submitted.

Landlord verifications go out automatically

A successful submission emails a verification request to the landlord on every address entry that has the applicant's consent, a valid landlord email address, and no verification requested yet. Addresses that fail any of those three are left alone — you can still ask for those one at a time with Ask a landlord to verify.