Application rental history

Add a previous address

Records an address the applicant lived at, with the landlord's contact details, and returns the new entry. Requires the rental_applications:write permission.

POST

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

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

Body

application/json

Every field is optional. The verification fields let you record a verification you did yourself instead of asking MagicDoor to send one.

addressobject

Where the applicant lived.

landlordNamestring

Name of the landlord or property manager. At most 250 characters.

landlordPhonestring

Landlord phone number.

landlordEmailstring · email

Landlord email address. A verification cannot be requested without one.

reasonForLeavingstring

Why the applicant left. At most 500 characters.

rentnumber

Monthly rent paid, as a decimal amount, for example 1650.00.

moveInDatestring · date

When the applicant moved in, as YYYY-MM-DD.

moveOutDatestring · date

When the applicant moved out, as YYYY-MM-DD. Leave it out while they still live there.

verificationConsentboolean

Whether the applicant agreed to MagicDoor contacting this landlord. Defaults to false when omitted, and a verification request is refused while it is false.

default: false

verificationStatusenum<string>

Lets you set the verification state directly, for recording a verification you carried out yourself.

notRequestedpendingverifieddeclinedrejectedexpired

verificationRequestedAtstring · date-time

When the verification was requested. Send this with a UTC offset, for example 2026-08-14T14:12:44+00:00 — unlike the other date-times in this API, it is stored as sent rather than read in the company's timezone.

verificationCompletedAtstring · date-time

When the verification finished. Same offset-carrying format as verificationRequestedAt.

verificationCodestring

The code the landlord uses to open the verification form. At most 100 characters.

verificationNotesstring

Free text from the landlord's answer. At most 2500 characters.

landlordResponseHadLatePaymentsboolean

Whether the landlord reported late payments.

landlordResponseWasEvictedboolean

Whether the landlord reported an eviction.

landlordResponseWouldRecommendTenantboolean

Whether the landlord would recommend the applicant.

commentstring

Free-text note. At most 500 characters.

Response

200 · The new address entry. `files` is always empty here — documents are attached separately.

idstring

The residential-history entry.

addressobject

Where the applicant lived. Absent when no address was given.

landlordNamestring

Name of the landlord or property manager at that address.

landlordPhonestring

Landlord phone number.

landlordEmailstring · email

Landlord email address. Required before a verification can be requested.

reasonForLeavingstring

Why the applicant left or is leaving.

rentnumber

Monthly rent paid at that address, as a decimal amount, for example 1650.00.

moveInDatestring · date

When the applicant moved in.

moveOutDatestring · date

When the applicant moved out. Absent while they still live there.

verificationConsentboolean

Whether the applicant agreed to MagicDoor contacting this landlord. A verification request is refused while this is false.

verificationStatusenum<string>

Where the landlord verification stands. Absent when no verification has ever been recorded for the entry.

notRequestedpendingverifieddeclinedrejectedexpired

verificationRequestedAtstring · date-time

When the verification email went out, in the company's timezone.

verificationCompletedAtstring · date-time

When the landlord answered, in the company's timezone.

verificationCodestring

The 12-character code that lets the landlord open the verification form. Absent until a verification is requested.

verificationNotesstring

Free text the landlord left with their answer.

landlordResponseHadLatePaymentsboolean

The landlord's answer to whether the applicant paid late. Absent until they answer.

landlordResponseWasEvictedboolean

The landlord's answer to whether the applicant was evicted. Absent until they answer.

landlordResponseWouldRecommendTenantboolean

The landlord's answer to whether they would recommend the applicant. Absent until they answer.

verifierNamestring

Name the responding landlord gave when they answered.

commentstring

Free-text note stored with the entry.

filesFile[]

Documents attached to this residential-history entry. Empty when none.

createdstring · date-time

When the entry was added, in the company's timezone.

updatedstring · date-time

When the entry was 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: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.

Allowed in every application status

This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.

The current address feeds screening

The most recent address on the application is part of what MagicDoor sends TransUnion to verify the applicant's identity, and it is one of the addresses checked when working out whether the bifurcated-screening attestation applies.