Application screening

Get report availability and pricing

Tells you, per report type, what the company will be charged, whether the report can be requested right now, where it currently stands, and which other reports must be requested alongside it. Requires the rental_applications:read permission.

GET

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

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 · What can be requested for this applicant.

rentalApplicationIdstring

The rental application these capabilities are for.

screeningVerifiedboolean

Whether TransUnion has verified the applicant's identity. No report can be requested until this is true.

creditReportFeenumber

What the company is charged for a credit report, as a decimal amount. 0 when the company's plan includes it.

creditReportAvailableboolean

True when the applicant is verified and no credit report has been requested yet.

creditReportStatusenum<string>

Where the most recent credit report stands.

notRequestedrequestedavailablefailed

creditPrerequisiteReportsenum<string>[]

Reports that must be requested in the same call. Always empty for the credit report — it is the prerequisite for the others.

criminalcrediteviction

criminalReportFeenumber

What the company is charged for a criminal report, as a decimal amount.

criminalReportAvailableboolean

True when the applicant is verified and no criminal report has been requested yet.

criminalReportStatusenum<string>

Where the most recent criminal report stands.

notRequestedrequestedavailablefailed

criminalPrerequisiteReportsenum<string>[]

Contains credit while no credit report exists — you must ask for both in the same call. Empty once a credit report exists.

criminalcrediteviction

evictionReportFeenumber

What the company is charged for an eviction report, as a decimal amount.

evictionReportAvailableboolean

True when the applicant is verified and no eviction report has been requested yet.

evictionReportStatusenum<string>

Where the most recent eviction report stands.

notRequestedrequestedavailablefailed

evictionPrerequisiteReportsenum<string>[]

Contains credit while no credit report exists. Empty once a credit report exists.

criminalcrediteviction

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.

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.