Validation IBAN - Cleariflow API

GET

iban

Validation IBAN

curl --request GET \
  --url https://bankvalidation.cleariflow.com/v1/iban/

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

Premiers pas

URL de base

https://bankvalidation.cleariflow.com/v1/iban/

Endpoint de validation

L’endpoint iban requiert votre clé API et un paramètre IBAN pour effectuer une validation complète des numéros de compte bancaire international.

https://bankvalidation.cleariflow.com/v1/iban/
? api_key = YOUR_UNIQUE_API_KEY
& iban = DE89370400440532013000

Cette requête réussie valide un IBAN allemand et renvoie des informations détaillées :

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

Paramètres de requête

api_key

String

requis

Votre clé API unique. Notez que chaque utilisateur possède des clés API uniques pour chacune des API Cleariflow ; votre clé de l’API de validation bancaire ne fonctionnera pas pour votre API de taux de change, par exemple.

iban

String

requis

Le numéro de compte bancaire international à valider. Les espaces sont autorisés et seront automatiquement supprimés lors du traitement. L’IBAN doit suivre le format standard ISO 13616.

Paramètres de réponse

La réponse de l’API est renvoyée dans un format JSON universel et léger.

iban

String

L’IBAN normalisé sans espaces, renvoyé en majuscules.

is_valid

Boolean

Résultat global de validation indiquant si l’IBAN est valide selon toutes les règles de validation.

country_code

String

Le code pays ISO à deux lettres (par ex., DE pour l’Allemagne, FR pour la France).

country_name

String

Le nom complet du pays associé à l’IBAN.

bank_code

String

Le code d’identification bancaire extrait de l’IBAN selon le format spécifique au pays.

account_number

String

La partie numéro de compte de l’IBAN, hors code pays, somme de contrôle et code bancaire.

length

Integer

La longueur réelle de l’IBAN fourni.

expected_length

Integer

La longueur attendue pour les IBAN du pays spécifique selon la norme ISO 13616.

checksum_valid

Boolean

Indique si la validation de la somme de contrôle IBAN a réussi à l’aide de l’algorithme MOD-97.

format_valid

Boolean

Indique si le format de l’IBAN correspond à la structure attendue pour le pays.

details

Object

Informations détaillées supplémentaires sur la structure et le formatage de l’IBAN.

details.structure

String

Une représentation visuelle de la structure IBAN utilisant les placeholders B (Banque), S (Guichet), C (Client) et K (Clé).

details.example

String

Un exemple correctement formaté de l’IBAN avec des espaces pour la lisibilité.

details.bank_name

String

Le nom de la banque (affiche actuellement « Bank information not available »).

details.bank_bic

String

Le code BIC de la banque (affiche actuellement « BIC not available »).

details.account_type

String

Le type de compte (généralement « Bank Account »).

details.currency

String

Le code devise du pays (par ex., EUR pour les pays de la zone euro, GBP pour le Royaume-Uni).

Exemples

IBAN allemand valide

Requête :

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=DE89370400440532013000

Réponse :

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

IBAN français valide

Requête :

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=FR1420041010050500013M02606

Réponse :

{
  "iban": "FR1420041010050500013M02606",
  "is_valid": true,
  "country_code": "FR",
  "country_name": "France",
  "bank_code": "2004101005",
  "account_number": "0500013M02606",
  "length": 27,
  "expected_length": 27,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BSSS SSCC CCCC CCCC CCC KK",
    "example": "FR14 2004 1010 0505 0001 3M02 606",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

IBAN invalide

Requête :

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=INVALID

Réponse :

{
  "iban": "",
  "is_valid": false,
  "country_code": "",
  "country_name": "",
  "bank_code": "",
  "account_number": "",
  "length": 7,
  "expected_length": 0,
  "checksum_valid": false,
  "format_valid": false,
  "details": {
    "structure": "",
    "example": ""
  }
}

Gestion des erreurs

Paramètre IBAN manquant

Requête :

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY

Réponse :

{
  "error": {
    "message": "Missing iban",
    "code": "missing_iban"
  }
}

Clé API manquante

Requête :

GET https://bankvalidation.cleariflow.com/v1/iban/?iban=DE89370400440532013000

Réponse :

{
  "error": {
    "message": "API key is required",
    "code": "missing_api_key"
  }
}

Structure IBAN

L’IBAN se compose de plusieurs éléments :

Code pays (2 caractères) : code pays ISO 3166-1 alpha-2
Chiffres de contrôle (2 caractères) : validation par algorithme MOD-97
Identifiant bancaire : code bancaire spécifique au pays
Numéro de compte : identifiant du compte client

Formats spécifiques par pays

Les différents pays ont des structures IBAN variables :

Allemagne (DE) : 22 caractères — BBBB BBBB BBBB BBBB BB
France (FR) : 27 caractères — BBBB BSSS SSCC CCCC CCCC CCC KK
Italie (IT) : 27 caractères — CAAA AABB BBSS CCCC CCCC CCX
Royaume-Uni (GB) : 22 caractères — BBBB SSSS SSCC CCCC CC
Espagne (ES) : 24 caractères — BBBB SSSS DDCC CCCC CCCC CC

Où :

B = Code banque
S = Code guichet
C = Numéro de compte client
K = Clé/chiffre de contrôle
A = Type de compte
D = Chiffre de contrôle

Règles de validation

L’API effectue une validation complète incluant :

Validation du format : vérifie si l’IBAN suit la structure attendue pour le pays
Validation de la longueur : vérifie que la longueur de l’IBAN correspond à la norme du pays
Validation de la somme de contrôle : effectue la validation par algorithme MOD-97
Validation du code pays : s’assure que le code pays est pris en charge
Validation des caractères : vérifie les caractères alphanumériques valides

Pays pris en charge

L’API prend en charge la validation IBAN pour plus de 50 pays, notamment :

Europe : Allemagne, France, Italie, Espagne, Pays-Bas, Belgique, Autriche, Suisse, Royaume-Uni, Pologne
Asie : Émirats arabes unis, Bahreïn, Israël, Jordanie, Kazakhstan, Koweït
Amériques : Brésil, Costa Rica, République dominicaine, Guatemala
Afrique : Mauritanie, Maurice, Tunisie

Pour une liste complète des pays pris en charge, consultez la page Pays pris en charge.

Validation BICL'endpoint `bic` valide les codes d'identification bancaire, fournissant une ventilation détaillée des codes bancaires, des informations sur le pays et des types d'institution pour les opérations bancaires internationales.

Validation IBAN

curl --request GET \
  --url https://bankvalidation.cleariflow.com/v1/iban/

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

​Premiers pas

​URL de base

​Endpoint de validation

​Paramètres de requête

​Paramètres de réponse

​Exemples

​IBAN allemand valide

​IBAN français valide

​IBAN invalide

​Gestion des erreurs

​Paramètre IBAN manquant

​Clé API manquante

​Structure IBAN

​Formats spécifiques par pays

​Règles de validation

​Pays pris en charge

Premiers pas

URL de base

Endpoint de validation

Paramètres de requête

Paramètres de réponse

Exemples

IBAN allemand valide

IBAN français valide

IBAN invalide

Gestion des erreurs

Paramètre IBAN manquant

Clé API manquante

Structure IBAN

Formats spécifiques par pays

Règles de validation

Pays pris en charge