IBAN Validatie API Documentatie



API integratie specificatie


1. Wat is de omgekeerde IBAN Validatie API?


De Omgekeerde IBAN is een online systeem, deze voorziet bedrijven met een online interface waar ze real-time IBAN validatie en identificatie kunnen uitvoeren.

Deze functies komen in de vorm van add-on modules, dewelke de functionaliteit van uw portaal uitbreiden.

Het International Bank Account Number of IBAN is een gestandaardiseerde manier om een rekeningsnummer te defineren die internationaal werkt.

Zijn structuur is:

<2-letterige ISO Landcode> + <2-cijferige Checksum] + <BBAN>


BBAN is de term die gebruikt wordt om het nationaale formaat voor een bankaccountnummer te formuleren, wat kan verschillen tussen landen (en soms enkel en alleen ontworpen werd voor IBAN connectiviteit!).
Merk op dat een BBAN kan komen met een eigen checksum algoritme.

IBAN voorziet basisbescherming met de checksum tegen transcriptiefouten (lees:menselijk kopieren). Het voorziet bovendien een lijst met geldige bestemde landen en hun BBAN-codes.
Dus, wanneer je de IBAN API module vraagt om een IBAN te 'valideren' zorgt het ervoor dat deze checks doorgevoerd worden.
Echter kan het niet garanderen dat het bankaccount ook werkelijk bestaat - de enige partij die dit kan doen is het ontvangende land of de ontvangende kredietinstelling.



2. Features


De Omgekeerde IBAN Validatie stelt je instaat de volgende queries uit te voeren:




3. API-gebruik


Het API-systeem stelt je in staat de validatie van IBAN's automatisch te doen verlopen via een simpel HTTP GET of POST verzoek.
De geaccepteerde parameters worden hieronder in de tabel beschreven:

Veldnaam Lengte Type Beschrijving
IBAN Max 100 String De IBAN die je wil valideren.
api_key 128 String Je persoonlijke API-sleutel.

*Om een API-sleutel te ontvangen, gelieve ons te contacteren via contact@iban.com

VOORBEELD – Valideer een IBAN
Een voorbeeld van een IBAN validatie die gebruikt maakt van een HTML GET request vind je hier terug:
https://api.iban.com/clients/api/iban-api.php?api_key=BAPI_KEY&iban=IBAN

Waar:

Waneer een HTTP GET of POST request gemaakt wordt met de correcte API-seleutel, zal het systeem de waarden terugsturen in een XML-bestand. Je kan een voorbeeld van een XML antwoord terugvinden in de volgende sectie“API XML Response Structure”



4. API XML Response Structure


Een XML Schema van het API’s antwoord kan teruggevonden worden in het documentatie-archief.
Een gedetailleerde beschrijving van de velden vind je terug in de onderstaande tabel:
Veldnaam Lengte Type Beschrijving
IBAN Max 100 String De IBAN die je opgaf wordt gedisplayed
NAAM_BANK 256 String Bankcode die identificeert welke bank het IBAN uitbaat
SEPA 5 String Indicator als deze IBAN’s SEPA-betalingen ondersteunt. Waarde is Waar of Onwaar
LAND 32 String Volledige naam van het land van oorsprong bv. “Verenigde Staten”
LANDCODE 2 String Twee letters ter afkorting van de landcode bv. US, UK, AU, FR … enz.
STAD 128 String Naam van de stad waar de bank zich’s bevindt.
ADRES 128 String Adres van de bank in kwestie.
SWIFT 128 String SWIFT code van de bank in kwestie.
VALID 5 String Waar/Onwaar resultaat als de IBAN checksums correct zijn.

Het API-systeem returnt resultaten in XML-fromaat, wat je eenvoudig kan parsen in verschillende programmeertalen en platformen.

Een voorbeeld van een XML-antwoord van de API voor de IBAN validatie query zou zijn:

<result>
<iban>DE08500700100094201100</iban>
<bank_name>DEUTSCHE BANK AG</bank_name>
<country>GERMANY</country>
<country_code>DE</country_code>
<city>60262 FRANKFURT AM MAIN</city>
<address>TAUNUSANLAGE 12</address>
<swift>DEUTDEFFXXX</swift>
<sepa>TRUE</sepa>
<valid>TRUE</valid>
</result>



5. API Fouten


In geval van fouten returnt de IBAN API een XML-antwoord die een foutcode bevat.

De <error></error> XML tags worden terugstuurd zonder andere velden in het XML-bestand.

Hieronder vind je een omschrijving terug van alle foutcodes die kunnen optreden:

<error>Subscription Expired</error>
<error>Invalid API Key</error>
<error>No IBAN specified</error>