Dokument herunterladen

Die Response enthält Binärdaten, in der Regel ein PDF. MIME-Typ und Dateiname stehen in den Response-Headern. Erforderlich ist documents:read.

Beschreibung

Überträgt den Binärinhalt eines einzelnen Antragsdokuments.

Parameter

idpathPflicht

Öffentliche Antrags-ID.

Beispiel: app_test_1a2b3c4d5e6f708192a3b4c5

document_idpathPflicht

ID aus der Dokumentenliste.

Beispiel: doc_17

Responses

200

Binärinhalt des Dokuments.

401/403

API-Schlüssel oder Scope documents:read ist ungültig.

404

Antrag, Dokument oder gespeicherter Inhalt ist nicht verfügbar.

Response-Body

Content-Type: application/pdf oder application/octet-stream. Die Response ist kein JSON-Objekt. Der konkrete MIME-Typ und Dateiname stehen in den Response-Headern.

Response-Felder

Feld	Typ	Angabe	Beschreibung
`Header: Content-Type`	string	Immer	MIME-Typ des übertragenen Dokuments.
`Header: Content-Disposition`	string	Immer	Auslieferungsart und vorgeschlagener Dateiname.
`Body`	binary	Immer	Unveränderter Dokumentinhalt.

Content-Type: application/pdf
Content-Disposition: attachment; filename="Abmeldebestaetigung.pdf"

<184233 Bytes>

Speicherung

Der Download benötigt documents:read, aber keine zusätzliche Berechtigung applications:read.
Übernehmen Sie den Server-Dateinamen nur nach eigener Bereinigung.
Speichern Sie Dokumente im Mandantenkontext des Antrags.
Protokollieren Sie die X-Request-Id, nicht den Dokumentinhalt oder den API-Schlüssel.