ibantools-germany
Version:
IBAN Validator and Generator for German Bank Accounts
43 lines (42 loc) • 1.47 kB
TypeScript
/**
* ibantools-germany
* Copyright (c) 2022-2026 Markus Baumer <markus@baumer.dev>
* SPDX-License-Identifier: MIT OR MPL-2.0
*/
import type { ProbablyString } from "./types";
/**
* Validate bank account number and BLZ
*
* IMPORTANT: A positive result does not does not necessarily mean that
* the account exists; it only checks for structure and check digit!
*
* @param accountNumber Account number with up to 10 digits
* @param blz German BLZ with 8 digits
* @returns
*/
export declare const isValidAccountNumberBLZ: (accountNumber: ProbablyString, blz: ProbablyString) => boolean;
/**
* Validate German BBAN
*
* IMPORTANT: A positive result does not does not necessarily mean that
* the account exists; it only checks for structure and check digit!
*
* @param bban German BBAN with 18 digits
* @returns
*/
export declare const isValidBBAN: (bban: ProbablyString) => boolean;
/**
* Validate (German) IBAN
*
* If `onlyGermany` is true, it will return false for any IBAN not starting
* with "DE". If false, non-German IBAN will be verified but no national
* methods will be applied.
*
* IMPORTANT: A positive result does not does not necessarily mean that
* the account exists; it only checks for structure and check digit!
*
* @param iban German IBAN with 22 chars
* @param onlyGermany Allow only German IBANs (default: false)
* @returns
*/
export declare const isValidIBAN: (iban: ProbablyString, onlyGermany?: boolean) => boolean;