MagicDoorAPI
SupportOpen MagicDoor
Lease documents

Send a lease document for signing

Sends the document out to its signers and moves it to pendingSignatures. Place every box you need with the update endpoint first, because the document is what the signers will see.

PUT
https://api.portal.magicdoor.com/company-app/lease-documents/{leaseDocumentId}/begin-signing

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

leaseDocumentIdstringrequired

The document to send. A Snowflake id, sent as a decimal string.

example: 1842019384756201984

Response

200 · The document, now out for signing.

idstring

Id of the lease document. A Snowflake id, sent as a decimal string.

portfolioIdstring

Portfolio the lease rolls up to. A Snowflake id, sent as a decimal string.

propertyIdstring

Property the lease is on. A Snowflake id, sent as a decimal string.

unitIdstring

Unit the lease is on. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease the document belongs to. A Snowflake id, sent as a decimal string.

leaseTemplateIdsstring[]

The lease templates the document was built from.

fileIdstring

The stored PDF. A Snowflake id, sent as a decimal string.

namestring

Name of the document.

statusenum<string>

Where the document stands: draft while it is being prepared, pendingSignatures once it has gone out, completed once everyone has signed, retracted if it was pulled back.

draftpendingSignaturescompletedretracted
typeenum<string>

Whether this is a lease document or a lease renewal document.

leaseleaseRenewal
signersLeaseDocumentSigner[]

Who has to sign, and how far each of them has got.

annotationsLeaseDocumentAnnotation[]

The boxes placed on the PDF — signatures, initials, dates and filled-in values.

fileobject

The stored PDF, resolved to a full file record.

401 · The access token is missing, expired, or not for this company.

404 · No lease document matched the id, or it belongs to another company.

The signing flow

A lease document starts as a draft. Place the signature and text boxes on it with the update endpoint, then call begin-signing to send it out, which moves it to pendingSignatures. Once every signer has signed it becomes completed. Retracting pulls it back out of signing.