Zum Hauptinhalt springen
GET
curl
Der Endpoint „Get a Bank Link“ von Didit gibt den Status eines Links zurück und, sobald dieser abgeschlossen ist, dessen connection_id und check_id. Rufen Sie ihn von Ihrem Server aus auf, nachdem onSuccess ausgelöst wurde, oder bei bank.link.completed: Vertrauen Sie einer vom Browser gesendeten Link-ID niemals. Ein fehlgeschlagener Link gibt 200 mit status: failed und einem error mit einem Code wie duplicate_conflict oder reduced_grant zurück.

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.

Pfadparameter

id
string<uuid>
erforderlich

Die Link-ID.

Antwort

Der Link.

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