Zum Hauptinhalt springen
POST
curl
Der Endpoint Create a Bank Link von Didit startet auf Ihrem Server einen Durchlauf von Bank Link, um eine Bankverbindung herzustellen oder zu erneuern, und gibt die gehostete url zurück. Jedes Feld hat einen Standardwert, daher besteht die kleinste Anfrage aus {} zuzüglich der gewünschten Felder. Ordnen Sie die zurückgegebene id Ihrem Benutzer zu und prüfen Sie das Ergebnis selbst über Bank Link abrufen oder das Webhook-Ereignis bank.link.completed. Siehe Schnellstart und Bank Link.

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

Body

application/json

Erstellen Sie einen Bank-Link. Die kleinste Anfrage ist {} plus das, was Sie wünschen: Jedes Feld hat einen Standardwert.

mode
enum<string>
Standard:connect

connect (Standard) erstellt eine neue Verbindung. renew benötigt connection_id und übernimmt die Einstellungen dieser Verbindung.

Verfügbare Optionen:
connect,
renew
connection_id
string<uuid>

Die zu erneuernde Verbindung. Nur mit mode: renew.

access
enum<string>
Standard:one_time

one_time (Standard) liest die Daten einmal aus. ongoing hält den Zugriff offen, bis die Einwilligung endet oder jemand ihn beendet. Mit gesetztem institution_id antwortet eine Bank, die keinen dauerhaften Zugriff offen halten kann, mit 400 ongoing_access_not_available, bevor ein Bildschirm angezeigt wird. Ohne sie listet die Bankauswahl nur Banken auf, die dies können.

Verfügbare Optionen:
one_time,
ongoing
country
string

Optional. Ohne diese Angabe wählt die Person unter den Ländern aus, die Ihre Anwendung aktiviert hat. Es muss ein Land sein, das Bank Link unterstützt; jedes andere, auch ZZZ, antwortet mit 400 invalid_request und field: country. Ein leerer Request-Body bleibt gültig.

Pattern: ^[A-Z]{3}$
institution_id
string

Optionale Bank zur Vorauswahl, aus list_institutions. Überspringt die Auswahl.

Maximum string length: 64
segment
enum<string>
Standard:any

Filtert die Bankauswahl und gibt an, welchen Login die Bank öffnet, wenn sie Logins trennt. Standardwert any.

Verfügbare Optionen:
personal,
business,
any
data
enum<string>[]

Was gelesen werden soll. accounts ist immer enthalten: Name, Typ, Währung, Kennungen und der Name des Kontoinhabers, sofern die Bank ihn teilt. Standard ist ["accounts"].

Maximum array length: 3
Verfügbare Optionen:
accounts,
balances,
transactions
history_days
integer
Standard:90

Anzahl der Tage an Transaktionshistorie, die angefordert werden, 1 bis 365, Standard 90. Die Bank kann weniger liefern: Jedes Konto meldet in history_coverage, was geliefert wurde. Kann nicht zusammen mit history_from gesendet werden.

Erforderlicher Bereich: 1 <= x <= 365
history_from
string<date>

Startdatum des abzurufenden Verlaufs anstelle von history_days. Kann nicht zusammen mit history_days gesendet werden: Beides zusammen führt zu 400 history_window_ambiguous. Für ein Datum, das älter als 365 Tage ist oder in der Zukunft liegt, wird 400 window_not_available zurückgegeben.

extended_history
enum<string>
Standard:standard

allow_extra_auth ermöglicht es einer Bank, die eine weitere Bestätigung verlangt, ältere Historie freizugeben.

Verfügbare Optionen:
standard,
allow_extra_auth

Nur bei Ongoing. Anzahl der Tage, für die Sie die Bank bitten, den Zugriff offen zu halten, 1 oder mehr. Standard: der längste Zeitraum, den die Bank erlaubt. Die Verbindung meldet das Datum, das die Bank tatsächlich gewährt hat, in consent.expires_at. Bei access: one_time antwortet sie mit 400 invalid_request und field: consent_days.

Erforderlicher Bereich: 1 <= x <= 32767
ownership
object

Optionaler Vergleich des Kontoinhabers mit einer Person oder einem Unternehmen.

end_user
object

Die Person oder das Unternehmen, die bzw. das das Konto verbindet.

redirect_url
string<uri>

Wohin der Browser am Ende geht, mit link_id, status und einem signierten state (nur zur Anzeige: der Webhook und get_link sind maßgeblich). In einer Sandbox-Anwendung benötigt eine einfache http-Adresse von localhost, 127.0.0.1 oder [::1] (beliebiger Port und Pfad, ohne Zugangsdaten, ohne Fragment) keine Registrierung. Jede andere Adresse antwortet mit 400 redirect_url_not_registered: Die Registrierung anderer Adressen ist noch nicht verfügbar. Ohne redirect_url landet die Person auf der eigenen Ergebnisseite von Didit.

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

Optionaler Sprachcode wie es oder pt-BR. Andernfalls die Browsersprache.

Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
vendor_data
string

Ihre eigene Referenz, die im Link und in der Verbindung zurückgegeben wird.

Maximum string length: 255
expires_in
integer
Standard:3600

Gültigkeitsdauer des Links in Sekunden, 300 bis 86400. Standard 3600.

Erforderlicher Bereich: 300 <= x <= 86400
duplicates
enum<string>
Standard:reuse

reuse (Standardwert) schließt einen Link ab, der auf bereits gemeinsam genutzte Konten verweist, als Erneuerung dieser Verbindung. allow erstellt eine unabhängige zweite Verbindung.

Verfügbare Optionen:
reuse,
allow
allow_one_time_fallback
boolean
Standard:false

Bei ongoing kann die Person mit einem einmaligen Auslesen fortfahren, wenn eine Bank keinen dauerhaften Zugriff offen halten kann, nachdem die Person den eingeschränkten Zugriff auf dem Bildschirm der Bank bestätigt hat. Das Angebot zeigt, was dies kostet. Nur bei access: ongoing: Bei einmaligem Zugriff wird mit 400 invalid_request und field: allow_one_time_fallback geantwortet.

accept_reduced_grant
boolean
Standard:false

Wenn die Bank oder die Person weniger gewährt, als Sie angefragt haben, schließen Sie den Link ab und berechnen nur die gewährten Scopes. Andernfalls endet der Link mit failed und reduced_grant, und nichts wird berechnet.

sandbox
object

Nur für Sandbox-Anwendungen: wählt den Didit-Test-Bank-Kunden aus. In einer Live-Anwendung wird er ignoriert.

Antwort

Der Link wurde erstellt.

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