Zum Hauptinhalt springen
GET
curl
Der Endpoint Get a Bank Connection von Didit liefert eine Verbindung mit ihrem Status, den Datumsangaben zur Einwilligung, dem Synchronisierungsstatus, Kontenübersichten und Kosten. sync.initial_status zeigt Ihnen, wann die ersten Daten abrufbar sind, consent.expires_at, wann die Einwilligung erneuert werden muss, und sync.budgets, wie viele Aktualisierungen die Bank noch zulässt. Siehe Verbindungen.

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 Verbindungs-ID.

Antwort

Die Verbindung.

Die Berechtigung der Person für Ihre Anwendung, die Daten einer Bank auszulesen. Eine Erneuerung behält die Verbindungs-ID und alle Konto-IDs bei. Eine gelöschte Verbindung antwortet nur mit id, status, status_reason, created_at und erasure: Alle anderen Felder fehlen, und es verbleiben keine Bank-, Personen- oder Kontodaten darin.

id
string<uuid>
erforderlich

Kennung der Verbindung.

status
enum<string>
erforderlich

pending: Erste Synchronisierung läuft. active: Einwilligung gültig. renewal_required: Die Einwilligung ist beendet oder die Bank verlangt, dass sich die Person erneut anmeldet; die Daten sind wie zuletzt synchronisiert lesbar, und es wird nichts berechnet. paused: Guthaben für den Monat zu niedrig. revoked: Zugriff von der Person, der Bank oder Ihnen beendet. deleted: Nur id, status, status_reason, created_at und erasure bleiben erhalten. failed: Die erste Synchronisierung ist nie erfolgreich gewesen.

Verfügbare Optionen:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
erforderlich

Warum die Verbindung sich in diesem Status befindet. paused_by_customer ist reserviert. Bei einer deleted-Verbindung: deleted_by_customer, consent_lapsed, retention_elapsed oder application_deleted.

Verfügbare Optionen:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
erforderlich

Wird nach delete_connection gesetzt, andernfalls null.

created_at
string<date-time>
erforderlich
environment
enum<string>
Verfügbare Optionen:
live,
sandbox
access
enum<string>
Verfügbare Optionen:
one_time,
ongoing
institution
object

Die Bank, für die eine Verbindung oder ein Link bestimmt ist.

segment
enum<string> | null
Verfügbare Optionen:
personal,
business,
null
data
enum<string>[]

Die Scopes, die die Person akzeptiert hat.

Verfügbare Optionen:
accounts,
balances,
transactions

Die Einwilligung der Person für diese Verbindung.

sync
object

Synchronisierungsstatus einer Verbindung.

accounts
object[]

Übersicht aller Konten in der Verbindung. Das vollständige Konto lesen Sie mit get_account.

ownership
object

Der optionale Abgleich des Kontoinhabers mit einer Person oder einem Unternehmen.

end_user
object
manage_url
string<uri> | null

Die eigene Zugriffsseite der Person. null, bis die Zugriffsseite verfügbar ist.

billing
object

Was diese Verbindung kostet. Für die Sandbox wird nie etwas berechnet.

possible_duplicate_of
string<uuid> | null

Wird gesetzt, wenn diese Verbindung möglicherweise eine andere aktive Verbindung dupliziert, aber kein end_user.reference eine bestimmte Übereinstimmung zulässt.

vendor_data
string | null
updated_at
string<date-time>
Zuletzt geändert am 22. November 2026