API-Integrationsspezifikation

1. Was macht die IBAN Recovery API?

Diese API bietet die einzigartige Funktionalität, um bis zu zwei unbekannte Zeichen von jeder internationalen Kontonummer wiederherzustellen. Diese Funktion kann verwendet werden, wenn Teile der IBAN nicht lesbar sind oder wenn Benutzereingaben validiert werden. Das System berücksichtigt die länderspezifische Formatierung und Länge, um die minimale Anzahl von Vorschlägen zu gewährleisten. Alle möglichen Permutationen von Ziffern und Buchstaben nach dem internationalen Formatierungsschema werden gegen den Modulust Prüfziffer-Algorithmus getestet.
Anwendungsbeispiele:

- Unlesbare Zeichen - Beim Digitalisieren von IBANs von Papierträgern ist es möglich, dass unlesbare Zeichen entstehen. Unser System erlaubt es Ihnen, ein Fragezeichen "?" anstelle der unbekannten Zeichen zu setzen. Unsere Validierungs-Engine generiert dann alle möglichen gültigen Kombinationen für diese IBAN.

- Fundierte Vermutung -Wenn Sie eine ungültige IBAN haben, können Sie eine fundierte Vermutung darüber abgeben, an welchen Positionen der Fehler liegt, indem Sie mehrere Wiederherstellungsversuche mit Platzhaltermarkierungen an verschiedenen Positionen ausführen

2. Features

Mit der IBAN Recovery API können Sie folgendes tun:

• Liefert eine Liste der gültigen IBANs, die die mögliche korrekte Variante vorschlagen.
• Extrahieren Sie die inländische Bankleitzahl aus der ursprünglichen IBAN.
• Extrahieren Sie den inländischen Filialcode aus der ursprünglichen IBAN.
.
• Extrahieren Sie die inländische Kontonummer aus der ursprünglichen IBAN.

3. Wiederherstellungs-API-Anforderungen

Das API-System ermöglicht es Ihnen, die IBAN-Wiederherstellung über eine einfache HTTP-GET- oder POST-Anforderung zu automatisieren.
Die akzeptierten Parameter sind in der folgenden Tabelle aufgeführt:

Feldname	Länge	Typ	Beschreibung
IBAN	Max 100	String	Die maskierte IBAN, die Sie validieren möchten. Verwenden Sie "?" (Fragezeichen) anstelle des unbekannten Zeichens. Zum Beispiel DE79850?0300310018056?
api_key	128	String	Ihr persönlicher API-Key.
format	5	String	Format der Antwort XML und JSON unterstützt.

*Um einen API-Schlüssel zu erhalten, kontaktieren Sie uns bitte unter contact@iban.com oder kaufen Sie ein Abonnement auf unserer Bestellseite

BEISPIEL - Wiederherstellen einer IBAN
Ein Beispiel für die Verwendung der IBAN Validation API mit einer GET-Anforderung finden Sie hier: BEISPIEL - Wiederherstellen einer IBAN

https://api.iban.com/clients/api/recover-iban.php?api_key=key&format=xml&iban=IBAN

Wo:

• Schlüssel ist Ihr API-Schlüssel
• IBAN zur Validierung durch das API-Modul gesendet. Beispiel: CH8?0853410203475000?
• Xml ist das Antwortformat. Auch ein Json-Schlüsselwort kann für json-formatierte Antworten angegeben werden.

Sobald ein HTTP-GET- oder POST-Request mit dem richtigen API-Schlüssel durchgeführt wird, gibt das System die Ergebnisse im angegebenen Format zurück. Eine Beispielantwort finden Sie im nächsten Abschnitt “API-Antwortstruktur”

4. Antwort der Wiederherstellungs-API

Ein XSD-Schema der API-Antwort finden Sie weiter unten:

Eine detaillierte Beschreibung der zurückgegebenen format_data-Objektfelder finden Sie in der folgenden Tabelle:

Feldname	Länge	Typ	Beschreibung
country	Max 2	String	Der 2-stellige ISO-Ländercode.
iban_length	Max 2	Integer	Die genaue Länge aller IBANs für dieses Land.
format_template	Max 2	String	Ein Template mit der genauen Länge der IBAN, die die verschiedenen Zeichen innerhalb der einzelnen Positionen anzeigt. C = gemischt ( Alphabet + 0-9), A = Zeichen (alphabetisch), N = Ziffer ( 0-9).
bank_code	Max 99	String	Die inländische Bankleitzahl für diese IBAN.
branch_code	Max 99	String	Die inländische Filialkennung für diese IBAN.
account_number	Max 99	String	Die inländische Kontonummer für diese IBAN.

Eine XML-Beispielantwort der API für eine IBAN-Validierungsanfrage wäre:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Wiederherstellungs-API-Statuscodes

Die IBAN-Recovery-API gibt folgende Fehlercodes zurück

Status-Code	Typ	Beschreibung
301	Account Fehler	API-Key ist ungültig
302	Account Fehler	Abonnement abgelaufen
303	Account Fehler	Keine Anfragen vorhanden
304	Account Fehler	Sie haben keinen Zugriff auf diese API
401	Eingabefehler	Pflichtfelder fehlen.
402	Eingabefehler	Zu viele Wildcards. Maximal zwei Wildcards erlaubt.
403	Eingabefehler	Zu wenig Wildcards. Es ist mindestens ein Platzhalter erforderlich.