Halter-Nachweis hochladen

Dieser Upload gilt ausschließlich für Personen. Senden Sie bei id_card die Felder front und back gemeinsam; bei meldebescheinigung das Feld document. Unterstützt werden PDF, JPEG, PNG, HEIC, HEIF und WEBP. Unternehmen laden hier keinen Registerbeleg hoch. Die Dateien können nicht über die Halter-API heruntergeladen werden und werden nach vier Tagen gelöscht. Erforderlich ist holders:verify.

Beschreibung

Überträgt alle angeforderten Nachweisslots in einem multipart/form-data-Request.

Parameter

verification_idpathPflicht

ID des Prüfversuchs.

Beispiel: hvr_test_2b3c4d5e6f708192a3b4c5d6

Idempotency-KeyheaderPflicht

Eindeutig pro gemeinsamem Nachweisupload.

Beispiel: verify-documents-customer-1842-v1

Request-Body

Der Body wird als multipart/form-data übertragen. Setzen Sie den Content-Type nicht selbst; Ihr HTTP-Client ergänzt die notwendige Boundary.

Request-Felder

frontDateiPflicht

Vorderseite des Ausweises; maximal 20 MB.

Erlaubte MIME-Typen: application/pdf,image/jpeg,image/png,image/heic,image/heif,image/webp

backDateiPflicht

Rückseite des Ausweises; maximal 20 MB.

Erlaubte MIME-Typen: application/pdf,image/jpeg,image/png,image/heic,image/heif,image/webp

SchemaquelleOpenAPI 3.1 herunterladen

Responses

200

Alle Nachweise übernommen; aktualisierte Verifizierungsressource.

413

Die gesamte Multipart-Anfrage überschreitet das Größenlimit.

415

Content-Type ist nicht multipart/form-data.

422

Ein required_document_slot fehlt, eine Datei ist zu groß oder nicht lesbar, oder der Dateityp wird nicht unterstützt.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

Feld	Typ	Angabe	Beschreibung
`id`	string	Immer	Öffentliche Verifizierungs-ID.
`object`	string	Immer	Konstanter Wert `holder_verification`.
`environment`	enum	Immer	`test` oder `live`.
`livemode`	boolean	Immer	`true` für Live-Ressourcen.
`holder_id`	string	Immer	Geprüfter Halter.
`holder_revision`	integer	Immer	Versionsnummer der Halterdaten, auf die sich die Prüfung bezieht.
`method`	enum	Immer	`simulation`, `identity_document` oder `company_register`.
`document_variant`	enum	Immer	Verwendete Nachweisvariante.
`status`	enum	Immer	`requires_documents`, `processing`, `verified` oder `failed`.
`required_document_slots`	array	Immer	Noch benötigte Multipart-Felder.
`comparison`	object	Optional	Ergebnis des Datenabgleichs.
`failure`	object	Optional	Maschinenlesbarer Code und Meldung bei fehlgeschlagener Prüfung.
`submitted_at`	date-time	Optional	Zeitpunkt der vollständigen Nachweisübertragung.
`verified_at`	date-time	Optional	Zeitpunkt der erfolgreichen Prüfung.
`expires_at`	date-time	Optional	Ablaufzeitpunkt des Prüfversuchs.
`created_at, updated_at`	date-time	Immer	Erstellungs- und Änderungszeitpunkt.

{
  "id": "hvr_test_2b3c4d5e6f708192a3b4c5d6",
  "object": "holder_verification",
  "environment": "test",
  "livemode": false,
  "holder_id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
  "holder_revision": 1,
  "method": "simulation",
  "document_variant": "id_card",
  "status": "verified",
  "required_document_slots": [],
  "created_at": "2026-08-26T10:18:00+02:00",
  "updated_at": "2026-08-26T10:18:00+02:00",
  "comparison": {
    "status": "match",
    "source": "test_simulation"
  },
  "submitted_at": "2026-08-26T10:19:00+02:00",
  "verified_at": "2026-08-26T10:19:01+02:00"
}

Alternative: Meldebescheinigung

Wenn der Prüfversuch document_variant: meldebescheinigung und required_document_slots: ["document"] liefert, senden Sie ausschließlich das Multipart-Feld document. Das interaktive Beispiel rechts zeigt die Ausweisvariante mit front und back.

curl --request POST   'https://digital-zulassen.de/api/v1/holder-verifications/hvr_test_2b3c4d5e6f708192a3b4c5d6/documents'   --header "Authorization: Bearer $DZ_API_KEY"   --header 'Idempotency-Key: verification-registration-certificate-v1'   --form 'document=@./test-meldebescheinigung.pdf;type=application/pdf'

Umgang mit Nachweisen

Keine Dokumentinhalte oder Signaturlinks protokollieren.
Dateien nur serverseitig und unmittelbar aus einem geschützten Speicher übertragen.
Den MIME-Typ nicht allein aus der Dateiendung ableiten.
In der Testumgebung keine echten Ausweis- oder Meldedaten verwenden.
Hochgeladene Dateien werden nach vier Tagen gelöscht. Verifizierungsstatus und Prüfmetadaten bleiben gespeichert.

{ "id": "hvr_test_2b3c4d5e6f708192a3b4c5d6", "object": "holder_verification", "environment": "test", "livemode": false, "holder_id": "hld_test_1a2b3c4d5e6f708192a3b4c5", "holder_revision": 1, "method": "simulation", "document_variant": "id_card", "status": "verified", "required_document_slots": [], "created_at": "2026-08-26T10:18:00+02:00", "updated_at": "2026-08-26T10:18:00+02:00", "comparison": { "status": "match", "source": "test_simulation" }, "submitted_at": "2026-08-26T10:19:00+02:00", "verified_at": "2026-08-26T10:19:01+02:00" }