Get an external insurance record

Fetches one record of a policy a tenant bought from an insurer outside MagicDoor, including its review state and a link to the uploaded document.

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.

externalIdstringrequired

The external insurance record to act on.

example: 1851002938471120896

idstring

The external insurance record's id.

leaseIdstring

The lease this policy covers.

companyIdstring

The company that owns the lease.

carrierNamestring

The insurance company that issued the policy. An empty string when none was recorded.

policyNumberstring

The policy number taken from the document. Absent when none was recorded.

coverageAmountnumber

Coverage in dollars. Absent when none was recorded.

policyStartDatestring · date-time

When the policy takes effect.

policyEndDatestring · date-time

When the policy expires.

stateenum<string>

Where the record stands with the reviewer. A new record starts at pending; only an approved record counts as coverage for the lease.

pendingapprovedrejected

rejectionReasonstring

Why the record was rejected. Absent unless state is rejected and a reason was given.

insurancePolicyFileobject

The uploaded proof of insurance. Absent when the record has no document attached.

deletedstring · date-time

When the record was deleted. Absent while the record is live.

createdstring · date-time

When the record was created.

updatedstring · date-time

When the record last changed.