Dokumentation

API-Referenz

PATCH/api/v1/holders/{holder_id}

Halter aktualisieren

Senden Sie nur die zu ändernden Felder. If-Match bindet die Änderung an die bekannte Revision und verhindert, dass parallele Aktualisierungen einander überschreiben. Erforderlich ist holders:write.

Beschreibung

Aktualisiert Halterdaten und erhöht bei Identitätsänderungen die Revision.

Parameter

holder_idpathPflicht

Öffentliche Halter-ID.

Beispiel: hld_test_1a2b3c4d5e6f708192a3b4c5
If-MatchheaderPflicht

Zuletzt gelesene Revisionsnummer in Anführungszeichen.

Beispiel: "1"

Request-Body

Der Body wird als application/json übertragen. Verwenden Sie ausschließlich die dokumentierten Feldnamen.

Request-Felder

FeldTypAngabeBeschreibung
typeenumOptionalNeuer Haltertyp. Das resultierende Objekt muss die zugehörigen Pflichtfelder enthalten.
first_name, last_namestring|nullOptionalPersonenname; null entfernt den jeweiligen Wert.
birth_datedate|nullOptionalGeburtsdatum im Format YYYY-MM-DD.
birth_place, birth_name, titlestring|nullOptionalWeitere Personendaten.
genderenum|nullOptionalGeschlecht oder null.
company_namestring|nullOptionalUnternehmensname.
registerobject|nullOptionalRegistertyp und Registernummer.
business_sectorstring|nullOptionalDreistelliger Wirtschaftszweig.
email, phonestring|nullOptionalKontaktdaten.
addressobjectOptionalVollständige Anschrift mit Straße, Hausnummer, Postleitzahl und Ort.
external_referencestring|nullOptionalReferenz aus dem eigenen System.
Request-Beispieljson
{
  "phone": "+491701234568",
  "address": {
    "street": "Am Markt",
    "house_number": "14",
    "postal_code": "28195",
    "city": "Bremen",
    "country_code": "DE"
  }
}

Responses

200

Aktualisierter Halter mit erhöhter Versionsnummer.

409

If-Match entspricht nicht mehr der aktuellen Revision.

422

Die partielle Änderung ergibt kein gültiges Halterobjekt.

Response-Body

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

Response-Felder

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Halter-ID.
objectstringImmerKonstanter Wert holder.
environmentenumImmertest oder live.
livemodebooleanImmertrue für Live-Ressourcen.
revisionintegerImmerFortlaufende Versionsnummer der Halterdaten; erhöht sich bei Änderungen.
external_referencestring|nullOptionalReferenz aus dem eigenen System.
verification_statusenumImmerunverified, pending, verified oder failed.
dataobjectImmerPersonen-, Unternehmens-, Kontakt- und Anschriftdaten der aktuellen Revision.
created_atdate-timeImmerErstellungszeitpunkt im ISO-8601-Format.
updated_atdate-timeImmerLetzte Änderung im ISO-8601-Format.
200 Response-Beispieljson
{
  "id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
  "object": "holder",
  "environment": "test",
  "livemode": false,
  "external_reference": "customer-1842",
  "revision": 2,
  "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": "+491701234568",
    "address": {
      "street": "Am Markt",
      "house_number": "14",
      "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"
}

Wann verified zurückgesetzt wird

Änderungen an Name, Geburtsdaten, Firma, Register oder Anschrift setzen eine bestehende Verifizierung für die neue Revision zurück. Reine Kontaktänderungen können den Status erhalten, sofern sie nicht Teil des geprüften Nachweises waren.

Zum Öffnen eines Treffers Enter drücken.