MagicDoorAPI
SupportOpen MagicDoor
Application screening

List screening reports

Returns the screening reports that have been unlocked for this applicant, with their type and whether the content has arrived from TransUnion. Reports TransUnion delivered but which nobody unlocked are not listed. Requires the rental_applications:read permission.

GET
https://services.magicdoor.com/leasing/company-portal/rental-applications/{applicationId}/screening/reports

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

applicationIdstringrequired

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

example: 1830472847398404096

Response

200 · The unlocked reports. A plain array, not paginated. Empty when nothing has been unlocked.

idstring

The report record.

reportTypeenum<string>

Which TransUnion report this is.

criminalcrediteviction
reportCulturestring

The locale the report was produced in, for example "en-US".

reportStatusenum<string>

Whether the report content has arrived from TransUnion yet. Only available reports can be read.

notRequestedrequestedavailablefailed
requestedAtstring · date-time

When the report was requested, in the company's timezone.

createdstring · date-time

When the record was created, in the company's timezone.

updatedstring · date-time

When the record last changed, in the company's timezone.

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.

This lists reports, not their contents

The report body is fetched one at a time from Read a screening report.