Spécificités de l'intégration de l'API

1. Que peut faire l'API de récupération d'IBAN ?

Cette API fournit la fonctionnalité unique permettant de récupérer jusqu'à deux caractères inconnus à partir de n'importe quel numéro de compte bancaire international. Cette fonction peut être utilisée dans les cas où certaines parties de l'IBAN sont illisibles ou lorsque l'entrée de l'utilisateur est validée. Le système prend en compte le format et la longueur du pays pour s'assurer qu'il produit le minimum de suggestions. Toutes les permutations possibles de chiffres et de lettres selon le schéma de formatage international sont testées par rapport à l'algorithme de contrôle de modulust.
Cas d'usage:

- Caractères illisibles - Lors de la numérisation d'IBAN à partir de supports papier, il est possible que l'impression dégradée produise des caractères illisibles. Notre système vous permet de placer un point d'interrogation "?" à la place des caractères inconnus. Notre moteur de validation génère alors toutes les combinaisons valides possibles pour cet IBAN.

- Supposition éclairée - Si vous avez un IBAN invalide, vous pouvez faire des suppositions sur les positions possibles de l'erreur en exécutant plusieurs tentatives de récupération avec un caractère générique "?" marqueurs à différents postes.

2. Fonctionnalités

L'API de récupération IBAN vous permet de faire ce qui suit:

• Obtenez une liste des IBAN valides qui suggèrent la variante correcte possible.
• Extraire le code de la banque nationale de l'IBAN original soumis.
• Extrait le code de branche domestique de l'IBAN d'origine soumis.
• Extraire le numéro de compte national de l'IBAN original soumis.

3. Demandes d'API de récupération

Le système API vous permet d'automatiser la récupération IBAN via une simple requête HTTP GET ou POST.
Les paramètres acceptés sont listés dans le tableau ci-dessous:

Champs Nom	Longueur	Type	Description
IBAN	Max 100	String	L'IBAN masqué que vous souhaitez valider. Utilisez "?" (point d'interrogation) à la place du caractère inconnu. Par exemple: DE79850?0300310018056?
api_key	128	String	Votre clé API personnelle.
format	5	String	Format de la réponse XML et JSON pris en charge.

*Pour obtenir une clé API, veuillez nous contactez à contact@iban.com ou souscrivez à un abonnement sur notre page de tarifs

EXEMPLE – Récuper un IBAN
Un exemple d'utilisation de l'API de validation IBAN avec une requête GET peut être trouvé ci-dessous:

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

Where:

• key ( clé) est votre clé API
• IBAN envoyé pour la validation par le module API. Exemple: CH8?0853410203475000?
• xml est le format de la réponse. Un mot-clé json peut également être spécifié pour la réponse au format json.

Une fois qu'une requête HTTP GET ou POST est effectuée avec la clé API correcte, le système renvoie les résultats dans le format spécifié. Vous pouvez trouver un exemple de réponse dans la section suivante “Structure de réponse API ”

4. Réponse de l'API de récupération

Un schéma XSD de l'API ’ et des réponses peut être trouvé ci-dessous:

Une description détaillée des champs d'objet format_data renvoyés peut être vue dans le tableau ci-dessous:

Champs Nom	Longueur	Type	Description
Pays	Max 2	String	Les 2 lettres ISO du code Pays.
iban_length	Max 2	Integer	La longueur exacte de tous les IBAN pour ce pays.
format_template	Max 2	String	Un modèle avec la longueur exacte de l'IBAN montrant les différents caractères à l'intérieur par positions. C = Mixte ( Alphabet + 0-9 ), A = Caractères (alphabetic), N = Chiffres ( 0-9 ).
bank_code	Max 99	String	Le code d'identification de la banque nationale pour cet IBAN.
branch_code	Max 99	String	L'identifiant de la succursale/branchepour cet IBAN.
account_number	Max 99	String	Le numéro de compte bancaire domestique pour cet IBAN.

Un exemple de réponse XML de l'API pour une requête de validation IBAN serait:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Codes de statut de l'API de récupération

L'API de récupération IBAN renvoie les codes d'erreur suivants

Code du Statut	Type	Description
301	Erreur de compte	Clé API est invalide
302	Erreur de compte	Abonnement expiré
303	Erreur de compte	Aucune requête disponible
304	Erreur de compte	Vous n'avez pas accès à cette API
401	Erreur d'entrée	Champs obligatoires manquants.
402	Erreur d'entrée	Trop de caractères génériques. Maximum de deux caractères génériques autorisés.
403	Erreur d'entrée	Trop peu de caractères génériques. Un minimum d'un caractère générique est requis.