How do I use the V4 Documents API to retrieve and upload property documents?
The V4 Documents API supports retrieving documents linked to tenancies, sales instructions, people, certificates, and maintenance jobs, as well as uploading new documents to properties and people. All endpoints are at https://live-api.letmc.com/v4/documents/.
All retrieval endpoints support startDate and endDate date range filtering, and a removeArchived parameter (default: false) to exclude archived documents. Only publicly accessible documents are returned.
| Entity | Endpoint |
|---|---|
| Tenancy | GET /documents/property/tenancy/{tenancyID} |
| Sales instruction | GET /documents/sales/{salesInstructionID} |
| Person (tenant, landlord, etc.) | GET /documents/person/{PersonID} |
| Certificate | GET /documents/certificate/{certificateID} |
| Maintenance job | GET /documents/maintenance/{maintenanceJobID} |
| Lettings progression | GET /documents/lettingsprogression/{lettingsProgressionID} |
| Property progression | GET /documents/propertyprogression/{propertyProgressionID} |
| Sales progression | GET /documents/propertyprogression/{salesProgressionID} |
Uploading documents
| Target | Endpoint |
|---|---|
| Person | POST /documents/person/{personID}/upload |
| Tenancy | POST /documents/tenancy/{tenancyID}/upload |
| Property | POST /documents/property/{propertyID}/upload |
| Sales instruction | POST /documents/sales/{salesInstruction}/upload |
All uploads use a DocumentationSubmissionModel with document content and metadata.
Upload requirements
- Maximum file size: 10MB
- File contents must be Base64-encoded in the request body
- All uploads are automatically scanned for malware
- The
mimeTypefield must contain the file extension with dot prefix (e.g..pdf,.jpg) — not a standard MIME type
Important: Despite the field name, mimeType expects the file extension, not application/pdf or image/jpeg. The extension in mimeType must exactly match the file extension in documentName (case-insensitive).
Accepted file formats
| Extension | Use |
|---|---|
.pdf |
PDF documents, contracts, certificates |
.doc / .docx |
Microsoft Word documents |
.xls / .xlsx |
Microsoft Excel spreadsheets |
.csv |
Comma-separated values |
.txt |
Plain text |
.gif / .png / .jpg / .jpeg / .bmp |
Images |
.msg / .eml |
Email files |
.heic |
Apple device images |
Example upload request (PDF):
json
{
"documentName": "tenancy-agreement.pdf",
"mimeType": ".pdf",
"contents": "JVBERi0xLjQK..."
}Test with Swagger: Select "V4.Documents" from the tier dropdown.