IBANTools

https://simplify.github.io/ibantools/
Admin
IBANTools is a TypeScript/JavaScript library for validating, creating, and extracting IBAN, BBAN,...
Tokens:6,188
Snippets:53
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install IBANTools via npm

Source: https://simplify.github.io/ibantools/index.html

Use npm to install the IBANTools library for Node.js environments. This command is suitable for CommonJS ES5 and ES6.

```bash
$ npm install ibantools
```

--------------------------------

### Install IBANTools via Bower

Source: https://simplify.github.io/ibantools/index.html

Use Bower to install the IBANTools library for browser environments using AMD. This command is suitable for AMD ES5.

```bash
$ bower install ibantools
```

--------------------------------

### Validate BBAN with isValidBBAN

Source: https://simplify.github.io/ibantools/functions/isValidBBAN.html

Examples demonstrating successful and failed BBAN validation using the isValidBBAN function.

```javascript
// returns true  
ibantools.isValidBBAN("ABNA0417164300", "NL");
```

```javascript
// returns false  
ibantools.isValidBBAN("A7NA0517164300", "NL");
```

--------------------------------

### Extend Country BBAN Validation

Source: https://simplify.github.io/ibantools/index.html

Example of extending IBANTools with national BBAN validation rules, specifically for Germany. This requires installing an additional package like 'ibantools-germany'.

```javascript
const ibantools = require('ibantools');  
const ibantoolsGermany = require("ibantools-germany");  
ibantools.setCountryBBANValidation("DE", ibantoolsGermany.isValidBBAN);
```

--------------------------------

### Node.js CommonJS Usage

Source: https://simplify.github.io/ibantools/index.html

Demonstrates how to use IBANTools in a Node.js CommonJS environment for IBAN validation and formatting. It shows how to validate an IBAN, get detailed validation errors, and validate a BIC.

```javascript
const ibantools = require('ibantools');  
const iban = electronicFormatIBAN('NL91 ABNA 0417 1643 00'); // 'NL91ABNA0517164300'  
ibantools.isValidIBAN(iban);  

// If you want to know reason why IBAN is invalid  
ibantools.validateIBAN('NL91ABNA0517164300');  
// Returns { valid: false, errorCodes: [iban.ValidationErrorsIBAN.WrongIBANChecksum] }  

// Validate BIC  
ibantools.isValidBIC('ABNANL2A');
```

--------------------------------

### Get Country Specifications

Source: https://simplify.github.io/ibantools/functions/getCountrySpecifications.html

Retrieves detailed IBAN specifications for all countries, including whether they are members of the IBAN registry.

```APIDOC
## GET /api/countrySpecifications

### Description
Retrieves specifications for all countries, including those not members of the IBAN registry. The `IBANRegistry` field indicates membership status.

### Method
GET

### Endpoint
/api/countrySpecifications

### Returns
CountryMap - An object containing country specifications.

### Response Example
```json
{
  "NL": {
    "IBANRegistry": true,
    "bban_regexp": "^\\d{4}[A-Z]{2}\\d{10}$"
  },
  "DE": {
    "IBANRegistry": true,
    "bban_regexp": "^\\d{2}[A-Z]{2}\\d{10}$"
  }
}
```
```

--------------------------------

### Validate IBAN with Specific Options

Source: https://simplify.github.io/ibantools/functions/isValidIBAN.html

This example demonstrates how to validate an IBAN while explicitly disabling QR IBAN validation. It returns false if the IBAN is a QR IBAN and allowQRIBAN is set to false.

```javascript
// returns false  
ibantools.isValidIBAN('CH4431999123000889012', { allowQRIBAN: false });
```

--------------------------------

### Format IBAN to Electronic Format

Source: https://simplify.github.io/ibantools/functions/electronicFormatIBAN.html

Use electronicFormatIBAN to get an IBAN without spaces. IBAN validation is not performed. Returns null for non-string inputs.

```javascript
// returns "NL91ABNA0417164300"  
ibantools.electronicFormatIBAN("NL91 ABNA 0417 1643 00");
```

--------------------------------

### AMD RequireJS Browser Usage

Source: https://simplify.github.io/ibantools/index.html

Shows how to use IBANTools in a browser environment with AMD and RequireJS. It demonstrates validating an IBAN and a BIC.

```javascript
require(["ibantools"], function(ibantools) {  
  console.log(ibantools.isValidIBAN('NL91 ABNA 0417 1643 00'));  
  console.log(ibantools.isValidBIC('ABNANL2A'));  
});
```

--------------------------------

### Compose an IBAN string

Source: https://simplify.github.io/ibantools/functions/composeIBAN.html

Constructs a full IBAN string using the provided country code and BBAN. Returns null if the input parameters are invalid.

```javascript
// returns NL91ABNA0417164300  
ibantools.composeIBAN({ countryCode: "NL", bban: "ABNA0417164300" });
```

--------------------------------

### Interface ComposeIBANParams

Source: https://simplify.github.io/ibantools/interfaces/ComposeIBANParams.html

Defines the structure for parameters required to compose an IBAN.

```APIDOC
## Interface ComposeIBANParams

### Description
Interface for ComposeIBAN parameters used to construct an IBAN.

### Properties
- **bban** (string) - Optional - The Basic Bank Account Number.
- **countryCode** (string) - Optional - The ISO country code.
```

--------------------------------

### friendlyFormatIBAN

Source: https://simplify.github.io/ibantools/functions/friendlyFormatIBAN.html

Formats an IBAN string by separating every four characters. IBAN validation is not performed. If a non-string value is provided for IBAN, null is returned.

```APIDOC
## Function friendlyFormatIBAN

### Description
Get IBAN in friendly format (separated after every 4 characters). IBAN validation is not performed. When non-string value for IBAN is provided, returns null.

### Method
N/A (This is a library function, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
// returns "NL91 ABNA 0417 1643 00"
ibantools.friendlyFormatIBAN("NL91ABNA0417164300");
```

```javascript
// returns "NL91-ABNA-0417-1643-00"
ibantools.friendlyFormatIBAN("NL91ABNA0417164300", "-");
```

### Response
#### Success Response (200)
- **string | null**: The formatted IBAN string or null if the input was not a string.

#### Response Example
```json
{
  "example": "NL91 ABNA 0417 1643 00"
}
```

```json
{
  "example": "NL91-ABNA-0417-1643-00"
}
```
```

--------------------------------

### Validate IBAN with Default Options

Source: https://simplify.github.io/ibantools/functions/validateIBAN.html

Use this to validate a standard IBAN. It returns an object indicating validity and any error codes.

```javascript
// returns {errorCodes: [], valid: true}
ibantools.validateIBAN("NL91ABNA0417164300");
```

```javascript
// returns {errorCodes: [], valid: true} ibantools.validateIBAN('CH4431999123000889012');
```

--------------------------------

### isQRIBAN Function

Source: https://simplify.github.io/ibantools/functions/isQRIBAN.html

Checks if a provided IBAN string is a valid QR-IBAN.

```APIDOC
## isQRIBAN

### Description
Checks if the provided IBAN string is a QR-IBAN.

### Parameters
- **iban** (string) - Required - The IBAN string to validate.

### Returns
- **boolean** - Returns true if the IBAN is a QR-IBAN, otherwise false.

### Request Example
```javascript
ibantools.isQRIBAN("CH4431999123000889012");
```

### Response Example
```json
true
```
```

--------------------------------

### ValidateIBANOptions Interface

Source: https://simplify.github.io/ibantools/interfaces/ValidateIBANOptions.html

Defines the configuration options available for IBAN validation processes.

```APIDOC
## Interface ValidateIBANOptions

### Description
Interface used to define configuration options for IBAN validation.

### Properties
- **allowQRIBAN** (boolean) - Optional - Specifies whether QR-IBANs are permitted during the validation process.
```

--------------------------------

### Format IBAN with default separator

Source: https://simplify.github.io/ibantools/functions/friendlyFormatIBAN.html

Use this function to format an IBAN string with spaces as separators. IBAN validation is not performed. Returns null for non-string inputs.

```javascript
// returns "NL91 ABNA 0417 1643 00"  
ibantools.friendlyFormatIBAN("NL91ABNA0417164300");
```

--------------------------------

### Validate IBAN with Default Options

Source: https://simplify.github.io/ibantools/functions/isValidIBAN.html

Use this snippet to check if a given string is a valid IBAN. It returns true for valid IBANs.

```javascript
// returns true  
ibantools.isValidIBAN("NL91ABNA0417164300");
```

```javascript
// returns false  
ibantools.isValidIBAN("NL92ABNA0517164300");
```

```javascript
// returns true  
ibantools.isValidIBAN('CH4431999123000889012');
```

--------------------------------

### Function composeIBAN

Source: https://simplify.github.io/ibantools/functions/composeIBAN.html

The composeIBAN function generates a valid IBAN string from a country code and a Basic Bank Account Number (BBAN).

```APIDOC
## POST /composeIBAN

### Description
Generates an IBAN from a country code and BBAN.

### Method
POST

### Endpoint
/composeIBAN

### Parameters
#### Request Body
- **params** (ComposeIBANParams) - Required - An object containing the country code and BBAN.
  - **countryCode** (string) - Required - The two-letter country code (e.g., "NL").
  - **bban** (string) - Required - The Basic Bank Account Number.

### Request Example
```json
{
  "params": {
    "countryCode": "NL",
    "bban": "ABNA0417164300"
  }
}
```

### Response
#### Success Response (200)
- **string | null** - The generated IBAN string, or null if generation fails.

#### Response Example
```json
{
  "iban": "NL91ABNA0417164300"
}
```
```

--------------------------------

### ExtractIBANResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ExtractIBANResult.html

This section describes the structure of the result returned by IBAN extraction operations.

```APIDOC
## Interface ExtractIBANResult

### Description
Interface for ExtractIBAN result.

### Properties
- **accountNumber** (string) - Optional - The account number extracted from the IBAN.
- **bankIdentifier** (string) - Optional - The bank identifier extracted from the IBAN.
- **bban** (string) - Optional - The BBAN (Basic Bank Account Number) extracted from the IBAN.
- **branchIdentifier** (string) - Optional - The branch identifier extracted from the IBAN.
- **countryCode** (string) - Optional - The country code extracted from the IBAN.
- **iban** (string) - Required - The full IBAN.
- **valid** (boolean) - Required - Indicates whether the extracted IBAN is valid.
```

--------------------------------

### CountryMap Interface

Source: https://simplify.github.io/ibantools/interfaces/CountryMap.html

Defines the structure for accessing country specifications via an indexable map.

```APIDOC
## CountryMap Interface

### Description
Interface for a map of country specifications, allowing retrieval of specifications by country code.

### Indexable
- **[code: string]** (CountrySpec) - Returns the specification for the given country code.
```

--------------------------------

### Check if IBAN is QR-IBAN

Source: https://simplify.github.io/ibantools/functions/isQRIBAN.html

Use this function to determine if an IBAN string conforms to the QR-IBAN standard. It returns true for QR-IBANs and false otherwise.

```javascript
// returns true  
ibantools.isQRIBAN("CH4431999123000889012");
```

```javascript
// returns false  
ibantools.isQRIBAN("NL92ABNA0517164300");
```

--------------------------------

### electronicFormatIBAN

Source: https://simplify.github.io/ibantools/functions/electronicFormatIBAN.html

Formats an IBAN string by removing all spaces. This function does not perform validation and returns null if a non-string value is provided.

```APIDOC
## electronicFormatIBAN

### Description
Get IBAN in electronic format (no spaces). IBAN validation is not performed. When a non-string value for IBAN is provided, returns null.

### Parameters
#### Path Parameters
- **iban** (string) - Optional - The IBAN string to format.

### Returns
- **string | null** - The formatted IBAN string without spaces, or null if input is not a string.

### Request Example
```javascript
ibantools.electronicFormatIBAN("NL91 ABNA 0417 1643 00");
```

### Response
#### Success Response (200)
- **result** (string) - "NL91ABNA0417164300"
```

--------------------------------

### Format IBAN with custom separator

Source: https://simplify.github.io/ibantools/functions/friendlyFormatIBAN.html

Use this function to format an IBAN string with a custom separator. IBAN validation is not performed. Returns null for non-string inputs.

```javascript
// returns "NL91-ABNA-0417-1643-00"  
ibantools.friendlyFormatIBAN("NL91ABNA0417164300","-");
```

--------------------------------

### extractIBAN

Source: https://simplify.github.io/ibantools/functions/extractIBAN.html

Parses a provided IBAN string and returns an object containing the extracted components and validation status.

```APIDOC
## extractIBAN

### Description
Extracts structured information from an IBAN string.

### Parameters
#### Path Parameters
- **iban** (string) - Required - The IBAN string to be parsed.

### Response
#### Success Response (200)
- **iban** (string) - The full IBAN string.
- **bban** (string) - The Basic Bank Account Number.
- **countryCode** (string) - The ISO country code.
- **valid** (boolean) - Indicates if the IBAN is valid.
- **accountNumber** (string) - The extracted account number.
- **bankIdentifier** (string) - The bank identifier code.

### Request Example
ibantools.extractIBAN("NL91 ABNA 0417 1643 00");

### Response Example
{
  "iban": "NL91ABNA0417164300",
  "bban": "ABNA0417164300",
  "countryCode": "NL",
  "valid": true,
  "accountNumber": "0417164300",
  "bankIdentifier": "ABNA"
}
```

--------------------------------

### Define ComposeIBANParams Interface

Source: https://simplify.github.io/ibantools/interfaces/ComposeIBANParams.html

Defines the interface for parameters used when composing IBAN details. Properties are optional.

```typescript
interface ComposeIBANParams {
 bban?: string;
 countryCode?: string;
}
```

--------------------------------

### Validate IBAN form field using getCountrySpecifications

Source: https://simplify.github.io/ibantools/functions/getCountrySpecifications.html

Demonstrates how to update an IBAN input field's pattern attribute based on the selected country's specifications.

```javascript
// Validating IBAN form field after user selects his country  
// <select id="countries">  
//   ...  
//   <option value="NL">Netherlands</option>  
//   ...  
// </select>  
$("#countries").select(function() {  
  // Find country  
  let country = ibantools.getCountrySpecifications()[$(this).val()];  
  // Add country code letters to IBAN form field  
  $("input#iban").value($(this).val());  
  // Add New value to "pattern" attribute to #iban input text field  
  $("input#iban").attr("pattern", $(this).val() + "[0-9]{2}" + country.bban_regexp.slice(1).replace("$",""));  
});
```

--------------------------------

### ValidateIBANResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ValidateIBANResult.html

Defines the structure of the result returned by the IBAN validation process.

```APIDOC
## Interface ValidateIBANResult

### Description
Represents the outcome of an IBAN validation operation.

### Properties
- **errorCodes** (ValidationErrorsIBAN[]) - A list of validation errors encountered during the process.
- **valid** (boolean) - Indicates whether the IBAN is valid.
```

--------------------------------

### Extract IBAN Details

Source: https://simplify.github.io/ibantools/functions/extractIBAN.html

Use this function to extract components of an IBAN, such as the account number, bank identifier, and country code. It also validates the IBAN's format.

```javascript
// returns {iban: "NL91ABNA0417164300", bban: "ABNA0417164300", countryCode: "NL", valid: true, accountNumber: '0417164300', bankIdentifier: 'ABNA'}
ibantools.extractIBAN("NL91 ABNA 0417 1643 00");
```

--------------------------------

### Define ValidateIBANResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ValidateIBANResult.html

Represents the outcome of an IBAN validation process.

```typescript
interface ValidateIBANResult {  
errorCodes: ValidationErrorsIBAN[];  
valid: boolean;  
}
```

--------------------------------

### extractBIC

Source: https://simplify.github.io/ibantools/functions/extractBIC.html

Parses a BIC string and returns an object containing the bank code, country code, location code, branch code, and validation status.

```APIDOC
## extractBIC

### Description
Extracts components from a provided BIC string.

### Parameters
#### Path Parameters
- **inputBic** (string) - Required - The BIC string to be parsed.

### Response
#### Success Response (200)
- **bankCode** (string) - The bank code component.
- **countryCode** (string) - The country code component.
- **locationCode** (string) - The location code component.
- **branchCode** (string|null) - The branch code component.
- **testBIC** (boolean) - Indicates if it is a test BIC.
- **valid** (boolean) - Indicates if the BIC is valid.

### Response Example
{
  "bankCode": "ABNA",
  "countryCode": "NL",
  "locationCode": "2A",
  "branchCode": null,
  "testBIC": false,
  "valid": true
}
```

--------------------------------

### Validate IBAN with Specific Options

Source: https://simplify.github.io/ibantools/functions/validateIBAN.html

Validate an IBAN while disabling specific validation rules, such as QR IBANs. This is useful for enforcing strict IBAN formats.

```javascript
// returns {errorCodes: [7], valid: false} ibantools.validateIBAN('CH4431999123000889012', { allowQRIBAN: false });
```

--------------------------------

### Interface CountrySpec

Source: https://simplify.github.io/ibantools/interfaces/CountrySpec.html

Defines the structure for IBAN country specifications including regex patterns, character counts, and registry status.

```APIDOC
## Interface CountrySpec

### Description
Interface for IBAN Country Specification defining validation rules for specific countries.

### Properties
- **bban_regexp** (null | string) - Regular expression for the Basic Bank Account Number.
- **chars** (null | number) - Total character count for the IBAN.
- **IBANRegistry** (boolean) - Indicates if the country is present in the IBAN Registry.
- **SEPA** (boolean) - Indicates if the country is part of the SEPA zone.
```

--------------------------------

### isValidIBAN Function

Source: https://simplify.github.io/ibantools/functions/isValidIBAN.html

Validates an IBAN string against standard rules, with optional configuration for specific validation requirements.

```APIDOC
## isValidIBAN

### Description
Validates whether a provided string is a valid IBAN. Returns true if valid, false otherwise.

### Parameters
- **iban** (string) - Required - The IBAN string to validate.
- **validationOptions** (ValidateIBANOptions) - Optional - Configuration options for validation (e.g., allowQRIBAN).

### Returns
- **boolean** - Returns true if the IBAN is valid, false otherwise.

### Request Example
```javascript
ibantools.isValidIBAN("NL91ABNA0417164300");
```

### Response Example
```json
true
```
```

--------------------------------

### isValidBBAN Function

Source: https://simplify.github.io/ibantools/functions/isValidBBAN.html

Validates a Basic Bank Account Number (BBAN) against a given country code.

```APIDOC
## Function isValidBBAN

### Description
Validates a Basic Bank Account Number (BBAN).

### Method
N/A (This is a function call within a library)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
// returns true
ibantools.isValidBBAN("ABNA0417164300", "NL");
```

```javascript
// returns false
ibantools.isValidBBAN("A7NA0517164300", "NL");
```

### Response
#### Success Response (boolean)
- **Returns**: boolean - `true` if the BBAN is valid for the given country code, `false` otherwise.

#### Response Example
```json
{
  "example": "true"
}
```

```json
{
  "example": "false"
}
```
```

--------------------------------

### Validate a BIC using IBANTools

Source: https://simplify.github.io/ibantools/functions/validateBIC.html

Use this function to check if a provided BIC string is valid. It returns an object containing validation status and any associated error codes.

```javascript
// returns {errorCodes: [], valid: true}  
ibantools.validateBIC("NEDSZAJJXXX");
```

--------------------------------

### Extract BIC from Input String

Source: https://simplify.github.io/ibantools/functions/extractBIC.html

Use this function to extract bank code, country code, and location code from a BIC string. The function returns a result object indicating validity and extracted components.

```javascript
// returns {bankCode: "ABNA", countryCode: "NL", locationCode: "2A", branchCode: null, testBIC: false, valid: true}  
ibantools.extractBIC("ABNANL2A");
```

--------------------------------

### ExtractBICResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ExtractBICResult.html

Defines the structure of the result returned by the ExtractBIC function, including bank code, branch code, country code, location code, test BIC status, and validity.

```APIDOC
## Interface ExtractBICResult

### Description
Interface for ExtractBIC result.

### Properties
- **bankCode** (string) - Optional - The bank code.
- **branchCode** (string | null) - Required - The branch code.
- **countryCode** (string) - Optional - The country code.
- **locationCode** (string) - Optional - The location code.
- **testBIC** (boolean) - Required - Indicates if the BIC is a test BIC.
- **valid** (boolean) - Required - Indicates if the BIC is valid.
```

--------------------------------

### validateBIC

Source: https://simplify.github.io/ibantools/functions/validateBIC.html

Validates a given Business Identifier Code (BIC) string.

```APIDOC
## validateBIC

### Description
Validates a provided BIC string and returns the validation result.

### Parameters
#### Path Parameters
- **bic** (string) - Optional - The Business Identifier Code to validate.

### Response
#### Success Response (200)
- **valid** (boolean) - Indicates if the BIC is valid.
- **errorCodes** (array) - A list of error codes if validation fails.

### Request Example
ibantools.validateBIC("NEDSZAJJXXX");

### Response Example
{
  "errorCodes": [],
  "valid": true
}
```

--------------------------------

### ValidateBICResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ValidateBICResult.html

Defines the structure of the result returned when validating a BIC.

```APIDOC
## Interface ValidateBICResult

### Description
Interface for ValidateBIC result.

### Properties
- **errorCodes** (ValidationErrorsBIC[]) - A list of validation errors encountered during the BIC check.
- **valid** (boolean) - Indicates whether the BIC is valid.
```

--------------------------------

### isSEPACountry

Source: https://simplify.github.io/ibantools/functions/isSEPACountry.html

Validates if a provided country code is part of the SEPA (Single Euro Payments Area) region.

```APIDOC
## isSEPACountry

### Description
Validates if a country code is from a SEPA country.

### Parameters
- **countryCode** (string) - Required - The ISO country code to validate.

### Returns
- **boolean** - Returns true if the country is a SEPA country, false otherwise.

### Request Example
```javascript
ibantools.isSEPACountry("NL"); // returns true
ibantools.isSEPACountry("PK"); // returns false
```
```

--------------------------------

### isValidBIC Function

Source: https://simplify.github.io/ibantools/functions/isValidBIC.html

Validates a given Bank Identifier Code (BIC) or SWIFT code.

```APIDOC
## Function isValidBIC

### Description
Validates a BIC/SWIFT code.

### Method
N/A (This is a library function, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
ibantools.isValidBIC("ABNANL2A");
```

### Response
#### Success Response (boolean)
- **true**: if the BIC is valid
- **false**: if the BIC is invalid

#### Response Example
```json
{
  "example": "true"
}
```

#### Error Response
N/A
```

--------------------------------

### Validate BIC/SWIFT Code

Source: https://simplify.github.io/ibantools/functions/isValidBIC.html

Use this function to validate if a given string is a valid BIC or SWIFT code. It returns true for valid formats and false otherwise. Ensure the input is a string.

```javascript
ibantools.isValidBIC("ABNANL2A");
```

```javascript
ibantools.isValidBIC("NEDSZAJJXXX");
```

```javascript
ibantools.isValidBIC("ABN4NL2A");
```

```javascript
ibantools.isValidBIC("ABNA NL 2A");
```

--------------------------------

### Set custom BBAN validation for a country

Source: https://simplify.github.io/ibantools/functions/setCountryBBANValidation.html

Registers a custom validation function for a specific country code. Overwrites any existing validation function for that country.

```typescript
setCountryBBANValidation(  
country: string,  
func: (bban: string) => boolean,  
): boolean
```

--------------------------------

### Validate SEPA country code

Source: https://simplify.github.io/ibantools/functions/isSEPACountry.html

Checks if a country code is part of the SEPA zone.

```javascript
// returns true  
ibantools.isSEPACountry("NL");
```

```javascript
// returns false  
ibantools.isSEPACountry("PK");
```

--------------------------------

### setCountryBBANValidation

Source: https://simplify.github.io/ibantools/functions/setCountryBBANValidation.html

Sets a custom BBAN validation function for a specific country. If a validation function already exists for the country, it will be overwritten.

```APIDOC
## Function setCountryBBANValidation

### Description
Set custom BBAN validation function for country. If `bban_validation_func` already exists for the corresponding country, it will be overwritten.

### Method
N/A (This is a function call within a library)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
// Example usage (assuming IBANTools is imported and initialized)
const countryCode = "US";
const customValidation = (bban) => {
  // Custom validation logic for US BBAN
  return bban.length === 10 && /^[0-9]+$/.test(bban);
};

const success = IBANTools.setCountryBBANValidation(countryCode, customValidation);
console.log(`BBAN validation set for ${countryCode}: ${success}`);
```

### Response
#### Success Response (boolean)
- **boolean** (boolean) - Returns `true` if the validation function was successfully set, `false` otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### Define ValidateBICResult Interface

Source: https://simplify.github.io/ibantools/interfaces/ValidateBICResult.html

Interface representing the result of a BIC validation check, containing a boolean validity flag and a list of error codes.

```typescript
interface ValidateBICResult {  
errorCodes: ValidationErrorsBIC[];  
valid: boolean;  
}
```

--------------------------------

### validateIBAN Function

Source: https://simplify.github.io/ibantools/functions/validateIBAN.html

The validateIBAN function checks the validity of an IBAN string. It can optionally take validation options to customize the validation process.

```APIDOC
## POST /validateIBAN

### Description
Validates an IBAN string against specified options.

### Method
POST

### Endpoint
/validateIBAN

### Parameters
#### Request Body
- **iban** (string) - Optional - The IBAN string to validate.
- **validationOptions** (object) - Optional - Options to customize validation. See ValidateIBANOptions for details.

### Request Example
```json
{
  "iban": "NL91ABNA0417164300",
  "validationOptions": {
    "allowQRIBAN": true
  }
}
```

### Response
#### Success Response (200)
- **valid** (boolean) - Indicates if the IBAN is valid.
- **errorCodes** (array) - An array of error codes if the IBAN is invalid. An empty array means the IBAN is valid.

#### Response Example
```json
{
  "valid": true,
  "errorCodes": []
}
```

#### Error Response (400)
- **error** (string) - A message describing the error.

#### Error Response Example
```json
{
  "error": "Invalid IBAN format"
}
```
```
Tokens:
Raw