API-integreringsspecifikation

1. Vad gör APIet för återskapande av IBAN?

Detta API tillhandahåller den unika funtionaliteten att återskapa upp till två okända tecken från ett internationellt bankkontonummer. Denna funktion kan användas i de fall där delar av IBAN är oläsliga eller när anvädarinmatning valideras. Systemet tar hänsyn till den specifika landsformaten och längden för att garantera att det producerar ett minimum av förslag. Alla möjliga permutationer av siffror och bokstäver enligt det internationella formatsystemet testas gentemot modulus-kontrollsifferalgoritmen.
Användningsfall:

- Oläsliga tecken - När man digitaliserar IBAN från pappersformat är det möjligt att utskriften degraderas så att oläsliga tecken produceras. Vårt system gör det möjligt för dig att placera ett frågetecken "?" i stället för de okända tecknen. Vår valideringsmaskin genereras därefter alla möjliga giltiga kombinationer för denna IBAN.

- Kvalificerad gissning - Om du har en ogiltig IBAN kan du göra en kvalificerad gissning på vilka positioner felet kan vara genom att köra flera försök att återskapa med jokertecken "?"-markeringar på olika positioner.

2. Funktioner

APIet för återskapande av IBAN gör det möjligt för dig att göra det följande:

• Få en lista på giltiga IBAN vilka föreslår möjlig giltig variant.
• Extrahera den inhemska bankkoden från det ursprungliga IBAN som överförts.
• Extrahera den inhemska filialkoden från det ursprungliga IBAN som överförts.
• Extrahera det inhemska kontonumret från det ursprungliga IBAN som överförts.

3. API-begäran för återskapande

API-systemet gör det möjligt för dig att automatisera återskapande av IBAN genom en enkel HTTP GET eller POST-begäran.
Accepterade parametrar listas i tabellen nedan:

Fältnamn	Längd	Typ	Beskrivning
IBAN	Max 100	Sträng	Den maskerade IBAN du vill validera. Använd "?" (frågetecken) i stället för okänt tecken. Till exempel: DE79850?0300310018056?
api_key	128	Sträng	Din personliga API-nyckel.
format	5	Sträng	Format på svaret XML och JSON stöds.

*För att få en API-nyckel ska du vänligen kontakta oss på contact@iban.com eller köpa ett abonnemang på vår ordersida

EXEMPEL – Återskapa ett IBAN
En exempelanvändning av IBAN-valideringsAPI med GET-begäran kan hittas nedan:

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

Där:

• key är din API-nyckel
• IBAN som skickas för validering av API-modulen. Exempel: CH8?0853410203475000?
• xml är svarsformatet. Ett json-nyckelord kan även specificeras för json-formatterat svar.

När en HTTP GET eller POST-begäran görs med den korrekta API-nyckeln kommer systemet att returnera resultaten i specificerat format. Du kan hitta ett exempelsvar i nästa sektion “API-svarsstruktur”

4. Återskapande API-svar

Ett XSD-system på APIets svar kan ses nedan:

En detaljerad beskrivning på format_data-objektfälten som returneras kan ses i tabellen nedan:

Fältnamn	Längd	Typ	Beskrivning
country	Max 2	Sträng	ISO-landskod med 2 bokstäver.
iban_length	Max 2	Integer	Exakt längd på alla IBAN för detta land.
format_template	Max 2	Sträng	En mall med exakt längd på IBAN vilken visar de olika tecknen inuti per pesition. C = Blandad ( Alfabetet + 0-9 ), A = Tecken(alfabetiskt), N = Siffra ( 0-9 ).
bank_code	Max 99	Sträng	Den inhemska bankidentifieringskoden för detta IBAN.
branch_code	Max 99	Sträng	Den inhemska filialidentifieringen för detta IBAN.
account_number	Max 99	Sträng	Det inhemska bankkontonumret för detta IBAN.

Ett exempel på XML-svar från APIet för en IBAN-valideringsfråga skulle vara:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Återskapande API-statuskoder

APIet för återskapande av IBAN returnerar följande felkoder

Statuskod	Typ	Beskrivning
301	Kontofel	Ogiltig API-nyckel
302	Kontofel	Abonnemang uuphört
303	Kontofel	Inga sökningar tillgängliga
304	Kontofel	Du har ingen tillgång till detta API
401	Inmatningsfel	Krävda fält saknas.
402	Inmatningsfel	För många jokertecken. Maximalt två jokertecken tillåtna.
403	Inmatningsfel	För få jokertecken. Minst ett jokertecken krävs.