Financing Document
Documents attached to a financing case.
DELETE/api/documents/{id}
[DISABLED] Delete a document
[DISABLED] Soft-deletes the document. Not available: document deletion via API is out of scope and stays disabled for now.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | FinancingDocument identifier |
Code samples
curl -X DELETE 'https://sandbox.partner.miete24.com/api/documents/{id}' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/documents/{id}', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 204 | FinancingDocument resource deleted | — |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
GET/api/documents/{id}
Get document metadata
Returns metadata (name, size, category, review status, etc.) for a single document. Answers 404 for documents that are not available to you — the same set the document list omits.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | FinancingDocument identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/documents/{id}' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/documents/{id}', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | FinancingDocument resource | FinancingDocument.FinancingDocumentResponse-financing_document.read |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
GET/api/documents/{id}/download
Download document file
Downloads the actual file content of a document belonging to one of your financing cases. Only documents you are entitled to receive are served: files you provided yourself, plus the signed contract and the signed handover confirmation. Documents the end customer provided, Miete24-internal documents and superseded versions are not available and answer with 404 — the same documents are omitted from the document list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | FinancingDocument identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/documents/{id}/download' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/documents/{id}/download', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | FinancingDocument resource | FinancingDocument |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
GET/api/financing-cases/{financingCaseId}/documents
List the documents of a financing case you may access
Returns the documents of the specified financing case that are available to you: the files you provided yourself, plus the signed contract and the signed handover confirmation. Customer-provided documents, Miete24-internal documents and superseded versions are omitted, so every returned downloadUrl is guaranteed to work.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | FinancingDocument identifier |
| page | query | integer | no | The collection page number |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/documents' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/documents', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | FinancingDocument collection | array<FinancingDocument.FinancingDocumentResponse-financing_document.read> |
| 403 | Forbidden | — |
POST/api/financing-cases/{financingCaseId}/documents
Upload a document to a financing case
Uploads a file (PDF, PNG, JPG, max 10MB) to the specified financing case. Requires category.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | FinancingDocument identifier |
Code samples
curl -X POST 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/documents' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/documents', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 201 | FinancingDocument resource created | FinancingDocument.FinancingDocumentResponse-financing_document.read |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 422 | Unprocessable entity | — |