Application screening

Re-send identity details to TransUnion

Pushes the applicant's current name, Social Security number, date of birth and address to TransUnion again and re-runs the identity check, then returns the refreshed screening record. Use it after correcting a typo that made the check fail. Requires the rental_applications:write permission.

POST

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

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 screening record with the new verification status.

rentalApplicationIdstring

The rental application this screening belongs to.

transunionScreeningRequestIdinteger

TransUnion's own id for the screening request. Absent until the request has been created with TransUnion.

transunionScreeningRequestRenterIdinteger

TransUnion's own id for the applicant within that request. Absent until the applicant has been registered with TransUnion.

verificationStatusenum<string>

How far the applicant has got with TransUnion's identity check. verified is the only value that allows reports to be requested; manualVerificationRequired means TransUnion wants the applicant to complete an identity exam.

notStartedverifiedunVerifiedmanualVerificationRequired

skippedboolean

Whether the property manager waived screening for this application.

skippedBystring

The user who waived screening. Absent when it was not skipped.

skippedAtstring · date-time

When screening was waived, in the company's timezone.

creditUtilizationnumber

Credit utilisation as a percentage between 0 and 100, read out of the TransUnion credit report by a background job. Absent until that job has run, and never present before the applicant has consented to TransUnion's terms and a credit report has been produced.

creditScoreinteger

Credit score read out of the TransUnion credit report by a background job. Absent until that job has run, and never present before the applicant has consented to TransUnion's terms and a credit report has been produced.

canRevalidateboolean

Whether the applicant's identity data can still be re-sent to TransUnion. Turns false once a report has been requested or produced.

revalidationBlockedReasonstring

Plain-language reason revalidation is unavailable. Absent when canRevalidate is true.

createdstring · date-time

When screening was first started, in the company's timezone.

updatedstring · date-time

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

400 · Revalidation is not possible: screening was never started for this application, it was waived, TransUnion has no record of the applicant, or a report has already been requested or produced. `screening.revalidationBlockedReason` on the rental application carries the same message.

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 first

screening.canRevalidate on the rental application tells you whether this call will work, and screening.revalidationBlockedReason says why not.

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.