Document Request
Requests for customer documents.
GET/api/financing-cases/{financingCaseId}/document-requests
List all document requests for a financing case
Returns all requested documents, information requests, and fill-and-return templates for the specified financing case that are visible to the partner. Miete24-internal items are omitted. Each item includes callbackRequestId and callbackStatus when the request was created with a linked CallbackRequest.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | DocumentRequestListResource identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | DocumentRequestListResource collection | array<DocumentRequestListResource.DocumentRequestItemResponse-document_request.read> |
| 403 | Forbidden | — |
GET/api/financing-cases/{financingCaseId}/document-requests/fill-and-return-templates/{templateId}/download
Download a fill-and-return template
Downloads the template file for a fill-and-return document request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | FillAndReturnTemplateDownloadResource identifier |
| templateId | path | string | yes | FillAndReturnTemplateDownloadResource identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/fill-and-return-templates/{templateId}/download' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/fill-and-return-templates/{templateId}/download', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | FillAndReturnTemplateDownloadResource resource | FillAndReturnTemplateDownloadResource |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
POST/api/financing-cases/{financingCaseId}/document-requests/information/{informationId}/respond
Respond to an information request
Submits a text response to an information request on a financing case.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | InformationResponseRequest identifier |
| informationId | path | string | yes | InformationResponseRequest identifier |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| response | string|null | no |
Code samples
curl -X POST 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/information/{informationId}/respond' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/information/{informationId}/respond', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | InformationResponseRequest resource created | InformationResponseRequest.DocumentRequestItemResponse-document_request.read |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 422 | Unprocessable entity | — |
POST/api/financing-cases/{financingCaseId}/document-requests/{type}/{itemId}/not-available
Mark a document request item as not available
Marks an optional partner-visible request item as not available ("liegt mir nicht vor"). Same guards as the partner portal: the item must belong to the financing case, be visible to the partner (Miete24-internal items are rejected), be optional, and still be pending. Wrong partner scope returns 403; unknown or internal items return 404.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| financingCaseId | path | string | yes | DocumentRequestNotAvailableRequest identifier |
| type | path | string | yes | DocumentRequestNotAvailableRequest identifier |
| itemId | path | string | yes | DocumentRequestNotAvailableRequest identifier |
Code samples
curl -X POST 'https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/{type}/{itemId}/not-available' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/financing-cases/{financingCaseId}/document-requests/{type}/{itemId}/not-available', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | DocumentRequestNotAvailableRequest resource created | DocumentRequestNotAvailableRequest.DocumentRequestItemResponse-document_request.read |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 422 | Unprocessable entity | — |