External insurance

Approve an external insurance record

Accepts a tenant's proof of a policy bought outside MagicDoor as the lease's coverage. Any other submission still awaiting review on the same lease is rejected automatically with the reason Another policy was approved. Approving an already approved record changes nothing. Requires the leasing_insurance:write permission.

POST

https://services.magicdoor.com/tenantinsurance/company-portal/insurance/externals/{externalId}/approve

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

externalIdstringrequired

The external insurance record to act on.

example: 1851002938471120896

Response

200 · The approved record.

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.

401 · The access token is missing, expired, or not a company portal token.

403 · The token is valid but the caller does not hold the `leasing_insurance:write` permission.

404 · No record with that id, or the record belongs to another company.

Approval always succeeds, but the lease does not always switch over. While the lease's coverage is locked to another source, typically an active damage waiver, the record is approved and the lease keeps its existing coverage until the lock expires. Read the lease back with Get a lease's insurance history to see which coverage is in force.