IBAN Validator

IBAN Validator for your reactive Angular forms, comes without any dependencies and can be used even outside of Angular as standalone function in any JS project. It can perform format, digit and length IBAN validations. Currently supports 107 countries

Install

npm install ngx-iban-validator --save

Use as a form validator

Import validateIBAN function from ngx-iban-validator package into your component file. Add validateIBAN to your form validators array.

import { Component, OnInit } from "@angular/core";
import { FormBuilder, FormGroup, Validators } from "@angular/forms";

import { validateIBAN } from "ngx-iban-validator";

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent implements OnInit {
  ibanForm: FormGroup;

  constructor(private formBuilder: FormBuilder) {}

  ngOnInit() {
    this.ibanForm = this.formBuilder.group({
      iban: [null, [Validators.required, validateIBAN]],
    });
  }
}

Display error

• If IBAN is valid as result of validation null is returned.

• If IBAN is invalid and some of the checks fail IBANValidationResult object is returned containing more info about error.

export interface IBANValidationResult {
  ibanInvalid: boolean;
  error: IBANError;
}

export interface IBANError {
  countryUnsupported: boolean;
  codeLengthInvalid: boolean;
  patternInvalid: boolean;
}

Error object contains more details about validation error. You can display errors easily as with any other validator.

<form [formGroup]="ibanForm">
  <input type="text" formControlName="iban" />
  <small
    *ngIf="
      ibanForm.get('iban')?.errors && ibanForm.get('iban')?.errors?.['ibanInvalid']
    "
  >
    <span *ngIf="ibanForm.get('iban')?.errors?.['error']['countryUnsupported']">
      Country not supported
    </span>
    <span *ngIf="ibanForm.get('iban')?.errors?.['error']['codeLengthInvalid']">
      IBAN Code length is invalid
    </span>
    <span *ngIf="ibanForm.get('iban')?.errors?.['error']['patternInvalid']">
      IBAN Code pattern is invalid
    </span>
  </small>
  <button [disabled]="ibanForm.invalid">Submit</button>
</form>

Demo

Check demo application on stackblitz

NGX IBAN Validator Demo Application

Use as standalone function

You can use validateIBAN function independently from any forms.

Value can be passed as part of object in this case validation flow will be the same as for form validation:

• If IBAN is valid as result of validation null is returned.

• If IBAN is invalid and some of the checks fail IBANValidationResult object is returned containing more info about error.

const ibanIsInvalid =
  validateIBAN({
    value: "AL35202111090000000001234567",
  }) !== null;

Value can be passed as a string:

• For valid and invalid IBAN IBANValidationResult object is returned

const ibanIsInvalid = validateIBAN("AL35202111090000000001234567").ibanInvalid;

NodeJS

const ibanValidator = require("ngx-iban-validator");
const ibanIsInvalid = ibanValidator.validateIBAN(
  "BA393385804800211234"
).ibanInvalid;

Supported countries

Development

Install dependencies

npm i

Test

npm run test

Build

npx tsc

v 1.1.8

• Added support for Falkland Islands

v 1.1.7

• Added support for Djibouti and Somalia

v 1.1.6

• Updated error display logic
• Value can be passed directly as a string or part of the object.
  • If value is passed as a part of object same logic as for form validation is applied:
    • If IBAN is valid as result of validation null is returned.
    • If IBAN is invalid and some of the checks fail IBANValidationResult object is returned containing more info about error.
  • If value is passed as a string:
    • For valid and invalid IBAN IBANValidationResult object is returned.
• Return null for valid form field to fix issue with disabling | enabling buttons
  • Thnx to @pramodEE for reporting the issue

v 1.1.5

Added additional pattern validation Added more tests to improve test coverage Added support for new countries: Algeria, Angola, Benin, Burkina Faso, Burundi, Cameroon, Cape Verde, Central African Republic, Chad, Comoros, Congo, Equatorial Guinea, Gabon, Guinea-Bissau, Honduras, Iran, Ivory Coast, Madagascar, Mali, Mongolia, Morocco, Mozambique, Nicaragua, Niger, Russia, Senegal, Togo

v 1.1.4

Avoid Angular warnings for old CommonJS module usage (see https://angular.io/guide/build#configuring-commonjs-dependencies)

Replaced mocha and chai with JEST for tests

v 1.1.3

Added support for new countries: Vatican, Libya, Sao Tome and Principe, Sudan Updated length for LC Saint Lucia from 30 to 32

Added Tests Added Mocha and Chai for testing

v 1.1.2

Updated length for CR to 22 - @freddy36

Read more

IBAN Examples