Zum Hauptinhalt springen
GET
curl
Der Endpoint „Institution abrufen“ von Didit gibt eine Bank mit ihren Leistungsmerkmalen und ihrem Status zurück. Ein Wert, der nie beobachtet wurde, ist null und keine Schätzung.

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
erforderlich

Die Institutions-ID, zum Beispiel es-banco-norte.

Antwort

Die Bank.

Eine Bank und ihre unterstützten Funktionen. Die Werte stammen aus beobachteten Fähigkeitsdaten, die täglich aktualisiert werden; ein nie beobachteter Wert ist null, keine Vermutung.

id
string
erforderlich

Didit-Kennung der Bank, ein stabiler Slug.

Beispiel:

"es-banco-norte"

name
string
erforderlich
country
string
erforderlich
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
erforderlich
timezone
string | null
erforderlich

IANA-Zeitzone, in der die Datumsangaben der Bank angegeben sind.

segments
enum<string>[]
erforderlich
Verfügbare Optionen:
personal,
business
access
enum<string>[]
erforderlich

ongoing wird nur dort aufgelistet, wo dauerhafter Zugriff für die Bank aktiviert ist.

Verfügbare Optionen:
one_time,
ongoing
ongoing_access
boolean
erforderlich

Ob der laufende Zugriff bei dieser Bank verfügbar ist.

Die längste Einwilligung, die die Bank zulässt, in Tagen. null, wenn nicht beobachtet.

history_days_max
integer | null
erforderlich

Die längste Historie, die die Bank liefert, in Tagen. null, wenn nicht beobachtet.

pending_transactions
boolean | null
erforderlich

Ob die Bank ausstehende Transaktionen meldet.

pending_linkage
boolean | null
erforderlich

Ob die Bank eine ausstehende Transaktion mit der gebuchten Transaktion verknüpft, wodurch pending_id gesetzt wird.

balance_types
enum<string>[]
erforderlich
Verfügbare Optionen:
booked,
available,
expected
transaction_fields
string[]
erforderlich

Die Transaktionsfelder, von denen bekannt ist, dass die Bank sie übermittelt. Jedes andere Feld ist null.

sign_in
enum<string> | null
erforderlich

Wie sich die Person bei der Bank anmeldet.

Verfügbare Optionen:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
erforderlich

Ob Bank Link eine verifizierte E-Mail-Adresse der Person benötigt.

corporate_accounts
boolean | null
erforderlich

Ob Geschäftskonten unterstützt werden.

bank_account_selection
boolean | null
erforderlich

Ob die Person die Konten bei der Bank statt in Bank Link auswählt.

Ob die Bank eine weitere Bestätigung verlangt, um älteren Verlauf freizugeben.

reconfirmation
boolean | null
erforderlich

Ob eine Verlängerung auf dem Bildschirm von Didit ohne Anmeldung bei der Bank erneut bestätigt werden kann.

sync_frequency_hours
integer | null
erforderlich

Stunden zwischen automatischen Synchronisationen, sofern die Bank einen schnelleren Takt erlaubt. null bedeutet den täglichen Standardwert.

health
enum<string>
erforderlich
Verfügbare Optionen:
operational,
degraded,
down
Zuletzt geändert am 22. November 2026