Ask the applicant to complete screening

Emails the applicant a link back to their application so they can accept TransUnion's terms and complete the identity check. Only legal while the application is submitted, screening is turned on for the company, the applicant is not already verified, and their name, email and Social Security number are all on file. Requires the rental_applications:write permission.

POST

https://services.magicdoor.com/leasing/company-portal/rental-applications/{applicationId}/screening/request-applicant-complete

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

204 · The email was handed to the notification system. The response has no body.

400 · One of the four conditions is not met. The message says which: screening turned off for the company, application not submitted, applicant already verified, or a missing identity field.

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.

Check before you call

requestApplicantCompleteScreeningReadiness on the rental application answers the same four questions without sending anything, and missingFields names exactly which identity fields are absent.

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.