API-Referenz
GET
/api/v1/holder-verifications/{verification_id}Halterverifizierung abrufen
Liefert den Status einer asynchronen Halterprüfung. Die API gibt Metadaten, aber keine hochgeladenen Dateien zurück. Erforderlich ist holders:read; holders:verify erlaubt ebenfalls den Abruf des eigenen Prüfversuchs.
Liefert Status, Dokumentanforderungen und Ergebnis des Prüfversuchs.
Parameter
verification_idpathPflichtÖffentliche Verifizierungs-ID.
Beispiel:hvr_test_2b3c4d5e6f708192a3b4c5d6Responses
200Aktueller Prüfstatus.
404Prüfung fehlt oder gehört nicht zum authentifizierten Mandanten.
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. |
200 Response-Beispieljson
{
"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": "processing",
"required_document_slots": [
"front",
"back"
],
"created_at": "2026-08-26T10:18:00+02:00",
"updated_at": "2026-08-26T10:18:00+02:00"
}Statuswerte
requires_documents: mindestens ein benötigter Nachweisslot fehlt.processing: Nachweise werden geprüft.verified: der Halter ist im geprüften Datenstand verifiziert.failed: Prüfung fehlgeschlagen.