API integratie specificatie

1. Wat doet de IBAN Herstel API?

Deze API biedt de unieke functionaliteit om maximaal twee onbekende tekens van elk internationaal bankrekeningnummer te herstellen. Deze functie kan worden gebruikt in gevallen waarin delen van de IBAN onleesbaar zijn of wanneer gebruikersinvoer is gevalideerd. Het systeem houdt rekening met de opmaak en lengte van het specifieke land om ervoor te zorgen dat het de minimale hoeveelheid suggesties oplevert. Alle mogelijke permutaties van cijfers en letters volgens het internationale opmaakschema worden getoetst aan het algoritme voor controlecijfer algoritme.
Gebruiksgevallen:

- Onleesbare tekens - Bij het digitaliseren van IBAN's van papieren dragers is het mogelijk dat gedegradeerde afdrukken onleesbare tekens produceren. Met ons systeem kunt u een vraagteken plaatsen "?" in plaats van de onbekende karakters. Onze validatie-engine genereert vervolgens alle mogelijke geldige combinaties voor deze IBAN.

- Redelijke - als u een ongeldige IBAN hebt, kunt u een gefundeerde schatting maken van de positie van de fout door meerdere herstelpogingen uit te voeren met de wildcard "?" markeringen op verschillende posities.

2. Eigenschappen

Met de IBAN Herstel API kunt u het volgende doen:

• Een lijst met geldige IBAN's die de mogelijke juiste variant suggereren ontvangen.
• De binnenlandse bankcode uit de originele IBAN die is verzonden binnenhalen.
• De binnenlandse filiaalcode uit de originele IBAN die is verzonden binnenhalen.
• Het binnenlandse rekeningnummer uit de originele IBAN die is verzonden binnenhalen.

3. Herstel API verzoeken

Met het API-systeem kunt u IBAN-herstel automatiseren via een eenvoudig HTTP GET- of POST-verzoek.
De geaccepteerde parameters staan in de onderstaande tabel:

                                            

Veldnaam	Lengte	Type	Beschrijving
IBAN	Max 100	String	De verborgen IBAN dat u wilt valideren. Gebruik "?" (vraagteken) in plaats van het onbekende teken. Bijvoorbeeld: DE79850? 0300310018056?
api_key	128	String	Uw persoonlijke API-sleutel.
format	5	String	Format van de respons die XML en JSON ondersteunen.

* Neem voor een API-sleutel contact met ons op via contact@iban.com of koop een abonnement op onze bestelpagina

VOORBEELD - Herstel een IBAN
Een voorbeeld van het gebruik van de IBAN Validati API met een GET-aanvraag vindt u hieronder:

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

Where:

• key is uw API-key
• IBAN verzonden voor validatie door de API-module. Voorbeeld: CH8?0853410203475000?
• xml is het antwoordformaat. Er kan ook een json-sleutelwoord worden opgegeven voor json-geformatteerde reactie.

Nadat een HTTP GET- of POST-aanvraag is gedaan met de juiste API-key, retourneert het systeem de resultaten in de opgegeven indeling. U kunt een voorbeeldantwoord vinden in de volgende sectie API-reactiestructuur”

4. Herstel API Respons

An XSD Schema of the API’s respons is hieronder te zien:

Een gedetailleerde beschrijving van de teruggestuurde format_data-objectvelden is te zien in de onderstaande tabel:

                                                                                                   

Veldnaam	Lengte	Type	Beschrijving
land	Max 2	String	De ISO-landcode van twee letters.
iban_lengte	Max 2	Integer	De exacte lengte van alle IBAN's voor dit land.
format_template	Max 2	String	Een sjabloon met de exacte lengte van de IBAN die de verschillende karakters binnen per posities toont. C = Gemengd (alfabet + 0-9), A = teken (alfabetisch), N = cijfer (0-9).
bank_code	Max 99	String	De binnenlandse bankidentificatiecode voor deze IBAN.
filiaal_code	Max 99	String	De ID van het binnenlandse filiaal voor deze IBAN.
REKENINGNUMMER	Max 99	String	Het nationale bankrekeningnummer voor deze IBAN.

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

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Herstel API Status Codes

De IBAN-herstel-API retourneert de volgende foutcodes

                                                                                                            

Statuscode	Type	Beschrijving
301	Rekeningfout	API Key is ongeldig
302	Rekeningfout	Abonnement verlopen
303	Rekeningfout	Geen vragen beschikbaar
304	Reekeningfout	U hebt geen toegang tot deze API
401	Invoerfout	Vereiste velden ontbreken.
402	Invoerfout	Te veel wildcards. Maximaal twee wildcards toegestaan.
403	Invoerfout	Te weinig wildcards. Er is minimaal één wildcard nodig.