Dokumentation

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.

Beschreibung

Liefert Status, Dokumentanforderungen und Ergebnis des Prüfversuchs.

Parameter

verification_idpathPflicht

Öffentliche Verifizierungs-ID.

Beispiel: hvr_test_2b3c4d5e6f708192a3b4c5d6

Responses

200

Aktueller Prüfstatus.

404

Prü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

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Verifizierungs-ID.
objectstringImmerKonstanter Wert holder_verification.
environmentenumImmertest oder live.
livemodebooleanImmertrue für Live-Ressourcen.
holder_idstringImmerGeprüfter Halter.
holder_revisionintegerImmerVersionsnummer der Halterdaten, auf die sich die Prüfung bezieht.
methodenumImmersimulation, identity_document oder company_register.
document_variantenumImmerVerwendete Nachweisvariante.
statusenumImmerrequires_documents, processing, verified oder failed.
required_document_slotsarrayImmerNoch benötigte Multipart-Felder.
comparisonobjectOptionalErgebnis des Datenabgleichs.
failureobjectOptionalMaschinenlesbarer Code und Meldung bei fehlgeschlagener Prüfung.
submitted_atdate-timeOptionalZeitpunkt der vollständigen Nachweisübertragung.
verified_atdate-timeOptionalZeitpunkt der erfolgreichen Prüfung.
expires_atdate-timeOptionalAblaufzeitpunkt des Prüfversuchs.
created_at, updated_atdate-timeImmerErstellungs- 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.

Zum Öffnen eines Treffers Enter drücken.