# IBAN and banks

> Validate Pakistani IBANs with the mod-97 checksum and look up the bank, its type and status from the bank code.

Source: https://pakdatakit.dev/docs/iban/

`import { validateIBAN, getBankFromIBAN, getBankInfo } from 'pakdatakit/iban'`

A Pakistani IBAN is 24 characters: `PK`, two check digits, a four-letter bank code and a 16-digit account number. These functions check the format and checksum and name the bank.

> **A valid IBAN is not a verified account**
>
> The checksum catches typos. It does not confirm the account exists or who owns it; only the bank (or a payment through it) can.
## Examples

**TypeScript**

```ts
import { validateIBAN, getBankFromIBAN, getBankInfo } from 'pakdatakit';

validateIBAN('PK36SCBL0000001123456702');
// → true

getBankFromIBAN('PK36 SCBL 0000 0011 2345 6702');
// → 'Standard Chartered Bank (Pakistan) Limited'

getBankInfo('MEZN');
// → {
//     "code": "MEZN",
//     "name": "Meezan Bank Limited",
//     "type": "islamic",
//     "active": true,
//     "mergedInto": null,
//     "aliasOf": null
//   }
```

**Python**

```python
from pakdatakit import validate_iban, get_bank_from_iban, get_bank_info

validate_iban('PK36SCBL0000001123456702')
# → True

get_bank_from_iban('PK36 SCBL 0000 0011 2345 6702')
# → 'Standard Chartered Bank (Pakistan) Limited'

get_bank_info('MEZN')
# → {
#     "code": "MEZN",
#     "name": "Meezan Bank Limited",
#     "type": "islamic",
#     "active": True,
#     "merged_into": None,
#     "alias_of": None
#   }
```

**Dart**

```dart
import 'package:pakdatakit/pakdatakit.dart';

validateIBAN('PK36SCBL0000001123456702');
// → true

getBankFromIBAN('PK36 SCBL 0000 0011 2345 6702');
// → 'Standard Chartered Bank (Pakistan) Limited'

getBankInfo('MEZN');
// → {
//     "code": "MEZN",
//     "name": "Meezan Bank Limited",
//     "type": "islamic",
//     "active": true,
//     "mergedInto": null,
//     "aliasOf": null
//   }
```

**C#**

```csharp
using PakDataKit;

Iban.Validate("PK36SCBL0000001123456702");
// → true

Iban.GetBank("PK36 SCBL 0000 0011 2345 6702");
// → "Standard Chartered Bank (Pakistan) Limited"

Iban.GetBankInfo("MEZN");
// → {
//     "code": "MEZN",
//     "name": "Meezan Bank Limited",
//     "type": "islamic",
//     "active": true,
//     "mergedInto": null,
//     "aliasOf": null
//   }
```

**PHP**

```php
use PakDataKit\Iban;

Iban::validate('PK36SCBL0000001123456702');
// → true

Iban::getBank('PK36 SCBL 0000 0011 2345 6702');
// → 'Standard Chartered Bank (Pakistan) Limited'

Iban::getBankInfo('MEZN');
// → {
//     "code": "MEZN",
//     "name": "Meezan Bank Limited",
//     "type": "islamic",
//     "active": true,
//     "mergedInto": null,
//     "aliasOf": null
//   }
```

## Reference

### validateIBAN()

```ts
function validateIBAN(iban: string): boolean;
```

**Parameters.** `iban`: with or without spaces, any case.

**Returns** `true` when the IBAN is a Pakistani IBAN of the right length and its ISO 13616 mod-97 checksum is correct.

**Related:** [`getBankFromIBAN()`](#getbankfromiban), the [IBAN checker](https://pakdatakit.dev/tools/iban/).

### getBankFromIBAN()

```ts
function getBankFromIBAN(iban: string): string | null;
```

**Returns** the bank's name for a valid IBAN, or `null` when the IBAN is invalid or the bank code is unknown.

### getBankInfo()

```ts
function getBankInfo(ibanOrCode: string): BankInfo | null;

interface BankInfo {
  code: string; // e.g. MEZN
  name: string;
  type: string; // 'commercial' | 'islamic' | 'microfinance' | 'digital' | 'emi' | ...
  active: boolean;
  mergedInto: string | null;
  aliasOf: string | null;
}
```

**Parameters.** `ibanOrCode`: an IBAN or a four-letter bank code.

**Returns** the bank's details, including whether it still operates and what it merged into.

**Caveats.** Bank codes are checked against real IBANs and the State Bank of Pakistan's lists; see [data sources](https://pakdatakit.dev/data/).

Every function and type: the [IBAN API reference](https://pakdatakit.dev/api/typescript/iban/).
