Halter abrufen

Liefert die aktuellen Halterdaten samt Versionsnummer und Verifizierungsstatus. Erforderlich ist holders:read.

Beschreibung

Liefert die aktuelle Revision und den Verifizierungsstatus eines Halters.

Parameter

holder_idpathPflicht

Öffentliche Halter-ID.

Beispiel: hld_test_1a2b3c4d5e6f708192a3b4c5

Responses

200

Aktuelles Halterobjekt.

404

Halter fehlt oder gehört zu einem anderen Mandanten beziehungsweise einer anderen Umgebung.

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 Halter-ID.
`object`	string	Immer	Konstanter Wert `holder`.
`environment`	enum	Immer	`test` oder `live`.
`livemode`	boolean	Immer	`true` für Live-Ressourcen.
`revision`	integer	Immer	Fortlaufende Versionsnummer der Halterdaten; erhöht sich bei Änderungen.
`external_reference`	string\|null	Optional	Referenz aus dem eigenen System.
`verification_status`	enum	Immer	`unverified`, `pending`, `verified` oder `failed`.
`data`	object	Immer	Personen-, Unternehmens-, Kontakt- und Anschriftdaten der aktuellen Revision.
`created_at`	date-time	Immer	Erstellungszeitpunkt im ISO-8601-Format.
`updated_at`	date-time	Immer	Letzte Änderung im ISO-8601-Format.

{
  "id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
  "object": "holder",
  "environment": "test",
  "livemode": false,
  "external_reference": "customer-1842",
  "revision": 1,
  "verification_status": "unverified",
  "data": {
    "type": "person",
    "first_name": "Mara",
    "last_name": "Beispiel",
    "birth_date": "1988-04-12",
    "birth_place": "Bremen",
    "email": "mara.beispiel@example.com",
    "phone": "+491701234567",
    "address": {
      "street": "Am Markt",
      "house_number": "12",
      "postal_code": "28195",
      "city": "Bremen",
      "country_code": "DE"
    }
  },
  "created_at": "2026-08-26T10:15:00+02:00",
  "updated_at": "2026-08-26T10:15:00+02:00"
}

Revisionen

revision erhöht sich bei Änderungen an verifizierungsrelevanten Daten. Der Antrag speichert die beim Erstellen aktuelle Revision. Spätere Halteränderungen ändern den Antrag nicht.

{ "id": "hld_test_1a2b3c4d5e6f708192a3b4c5", "object": "holder", "environment": "test", "livemode": false, "external_reference": "customer-1842", "revision": 1, "verification_status": "unverified", "data": { "type": "person", "first_name": "Mara", "last_name": "Beispiel", "birth_date": "1988-04-12", "birth_place": "Bremen", "email": "mara.beispiel@example.com", "phone": "+491701234567", "address": { "street": "Am Markt", "house_number": "12", "postal_code": "28195", "city": "Bremen", "country_code": "DE" } }, "created_at": "2026-08-26T10:15:00+02:00", "updated_at": "2026-08-26T10:15:00+02:00" }