Generate the application PDF

Renders the printable version of a rental application, stores it in the Files service and returns a link to it. Requires the rental_applications:read permission.

POST

https://services.magicdoor.com/leasing/company-portal/rental-applications/{id}/pdf

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 generated PDF.

fileIdstring

The generated PDF in the Files service.

secureUrlstring

URL for downloading the PDF. It is a secure URL, so fetching it needs an authorized, company-scoped request. The host comes from the Files service and differs between environments — use the value returned here rather than building the URL yourself.

401 · The access token is missing, expired, or not valid.

403 · The caller is authenticated but does not hold the `rental_applications:read` 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.

The PDF contains the applicant's personal data

The rendered document reproduces what is on the application, including the Social Security number and date of birth. Anyone who can reach the returned URL with a valid token can read it.