Application screening

Read a screening report

Returns the body of one unlocked screening report as an HTML document, ready to render. Requires the rental_applications:read permission.

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

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
reportIdstringrequired

The report to read, from the list of unlocked reports. A Snowflake id, sent as a decimal string.

example: 1833029384756102400

Response

200 · The report as an HTML document. The response is `text/html`, not JSON — it is TransUnion's own rendering of the credit, criminal, or eviction findings.

400 · This is a criminal report on an application in a jurisdiction that requires a separate attestation, and the attestation has not been given. Call [Accept the bifurcated-screening attestation](api-reference/rental-applications/accept-bifurcated-screening) first. Credit and eviction reports are never blocked this way.

400 · The report exists but TransUnion has not delivered its content yet, or the delivery failed. Check `reportStatus` — only `available` reports can be read.

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 unlocked report with this id exists on this rental application, or the rental application itself was not found.

This is consumer credit and background data

The document contains the applicant's credit file or criminal and eviction history. In the United States it is a consumer report under the Fair Credit Reporting Act: it may only be used for the permissible purpose the applicant consented to, it must not be shown to anyone without that purpose, and it should not be stored outside MagicDoor. Do not proxy this endpoint to a browser without checking the caller first.

Screening data depends on the applicant's consent

TransUnion is only contacted after the applicant has accepted TransUnion's terms on their own portal — check transunionTermsAcceptedAt on the rental application. Until then the applicant's identity cannot be verified, no report can be produced, and screening.creditScore and screening.creditUtilization stay absent. Nothing in this section makes the applicant consent; it only acts on a consent that already exists.