Zum Hauptinhalt springen
POST
curl
Der Endpoint „Renew a Bank Connection“ erstellt einen Erneuerungslink für eine Bankverbindung. Er ist eine Abkürzung für das Erstellen eines Links mit mode: renew. Die Verbindungs-ID und alle Konto-IDs bleiben gleich. Solange mehr als 30 Tage verbleiben, antwortet er mit 409 renewal_not_needed. Siehe Bank-Einwilligung erneuern.

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, zu finden unter Developers -> API keys in der Business Console. Der primäre Schlüssel hat vollen Zugriff. Ein benannter Schlüssel kann eingeschränkt werden: pro Ressource keine, nur Lese- oder nur Schreibrechte, begrenzt auf einzelne Workflows oder nur auf genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist. 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste kam. 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibzugriff auf Sitzungen erhält Sitzungslinks und Tokens als null. Siehe https://docs.didit.me/console/api-keys.

Header

Idempotency-Key
string

Optionaler Schlüssel zur Wiederholungssicherheit für einen Vorgang, den Sie selbst wählen, bis zu 255 Zeichen (eine UUID eignet sich). Eine Anfrage, die mit demselben Schlüssel, demselben Endpoint, denselben Query-Parametern und demselben Body wiederholt wird, erhält die erste Antwort mit demselben Status und demselben Body zurück und wird kein zweites Mal ausgeführt oder berechnet. Derselbe Schlüssel mit einem anderen Endpoint, anderen Query-Parametern oder einem anderen Body liefert 409 mit idempotency_key_reused. Solange die erste Anfrage noch läuft, liefert er 409 mit idempotency_key_in_progress und Retry-After. Eine fehlgeschlagene Anfrage (jeder 4xx- oder 5xx-Fehler) wird nicht gespeichert, sodass Sie sie mit demselben Schlüssel erneut senden können. Schlüssel gehören zu Ihrer Anwendung, unabhängig davon, ob Sie mit einem API-Schlüssel oder einem Zugriffstoken aufrufen. Siehe Wiederholungsversuche und Idempotenz.

Required string length: 1 - 255

Pfadparameter

id
string<uuid>
erforderlich

Die Verbindungs-ID.

Body

application/json

Optionale Einstellungen eines Verlängerungslinks. Der Rest stammt von der Verbindung.

redirect_url
string<uri>

Wohin der Browser am Ende geht. In einer Sandbox-Anwendung benötigt eine einfache http-Adresse von localhost, 127.0.0.1 oder [::1] keine Registrierung. Jede andere Adresse antwortet mit 400 redirect_url_not_registered: Die Registrierung anderer Adressen ist noch nicht verfügbar.

Maximum string length: 2048
allowed_origins
string<uri>[]

Akzeptiert, aber derzeit nicht verwendet: reserviert für Didits eingebetteten Bank Link, der noch nicht veröffentlicht ist. HTTPS-Ursprünge, bis zu 50.

Maximum array length: 50
language
string
Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
expires_in
integer
Standard:3600

Gültigkeitsdauer in Sekunden, 300 bis 86400.

Erforderlicher Bereich: 300 <= x <= 86400

Antwort

Der Erneuerungslink.

Ein Durchlauf von Bank Link für eine Person: eine Bank anbinden oder eine Verbindung erneuern. Bestätigen Sie einen Link selbst mit get_link: vertrauen Sie nie einer vom Browser gesendeten ID.

id
string<uuid>
erforderlich

Kennung des Links.

mode
enum<string>
erforderlich
Verfügbare Optionen:
connect,
renew
access
enum<string>
erforderlich
Verfügbare Optionen:
one_time,
ongoing
status
enum<string>
erforderlich

Status des Links. completed, cancelled, expired und failed sind endgültig.

Verfügbare Optionen:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
erforderlich

Die gehostete Verifizierungsseite, zu der die Person geleitet werden soll. Wird nur beim Erstellen des Verifizierungslinks zurückgegeben; bei späteren Abfragen null, weil das Token nicht gespeichert wird.

client_token
string | null
erforderlich

Das Token für den eingebetteten Bank Link von Didit, der noch nicht freigegeben ist: Öffnen Sie heute url. Wird nur bei der Erstellung des Links zurückgegeben; bei späteren Abfragen null. Es hat einen einzigen Zweck und ist nur kurz gültig. Es enthält keine personenbezogenen Daten. Protokollieren Sie es niemals.

expires_at
string<date-time>
erforderlich

Wann ein nicht eingelöster Link nicht mehr funktioniert.

connection_id
string<uuid> | null
erforderlich

Die Verbindung, die dieser Link erstellt oder erneuert hat, sobald status completed ist.

check_id
string<uuid> | null
erforderlich

Das Ergebnis zur Eigentümerstruktur dieses Links, wenn er ownership.compare mit einem anderen Wert als none angefordert hat.

reused
boolean
erforderlich

true, wenn der Link als Erneuerung einer bestehenden Verbindung abgeschlossen wurde, weil die Person genau diese Konten bereits gemeinsam nutzt (duplicates: reuse). Es wird nichts doppelt berechnet.

error
object | null
erforderlich

Warum der Link fehlgeschlagen ist, wenn status failed ist. Andernfalls null.

quote
object
erforderlich

Der Preis eines Links, der bei seiner Erstellung festgeschrieben wird. Berechnet wird der Preis aus dem Angebot. Lesevorgänge werden nie abgerechnet.

vendor_data
string | null
erforderlich

Ihre Referenz aus der Anfrage.

Zuletzt geändert am 22. November 2026