{"id":27437297,"url":"https://github.com/baumerdev/ibantools-germany","last_synced_at":"2025-04-14T20:19:56.425Z","repository":{"id":61839005,"uuid":"552476422","full_name":"baumerdev/ibantools-germany","owner":"baumerdev","description":"IBAN Validator and Generator for German Bank Accounts","archived":false,"fork":false,"pushed_at":"2025-02-09T17:18:44.000Z","size":2395,"stargazers_count":14,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T20:19:48.341Z","etag":null,"topics":["bank-account","germany","iban","javascript","kontonummer","sepa","validation"],"latest_commit_sha":null,"homepage":"https://baumerdev.github.io/ibantools-germany/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/baumerdev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-16T17:22:54.000Z","updated_at":"2025-04-08T18:49:31.000Z","dependencies_parsed_at":"2023-09-22T18:53:06.164Z","dependency_job_id":"353296bb-d9ee-4f99-9668-340c87a96bbc","html_url":"https://github.com/baumerdev/ibantools-germany","commit_stats":{"total_commits":77,"total_committers":4,"mean_commits":19.25,"dds":"0.10389610389610393","last_synced_commit":"e9ad49b078d4a3a275f55502c60b834d0df57ac6"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baumerdev%2Fibantools-germany","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baumerdev%2Fibantools-germany/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baumerdev%2Fibantools-germany/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baumerdev%2Fibantools-germany/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/baumerdev","download_url":"https://codeload.github.com/baumerdev/ibantools-germany/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248952355,"owners_count":21188427,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bank-account","germany","iban","javascript","kontonummer","sepa","validation"],"created_at":"2025-04-14T20:19:55.382Z","updated_at":"2025-04-14T20:19:56.419Z","avatar_url":"https://github.com/baumerdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IBANTools-Germany: Validator and Generator for German Bank Accounts\n\n![CI: Lint, test and build](https://github.com/baumerdev/ibantools-germany/workflows/Lint,%20test%20and%20build/badge.svg?branch=main)\n[![Coverage Status](https://coveralls.io/repos/github/baumerdev/ibantools-germany/badge.svg?branch=main)](https://coveralls.io/github/baumerdev/ibantools-germany?branch=main)\n\nThis TypeScript/JavaScript library validates IBAN and German bank account\nnumbers. It can be used standalone or as an enhancement of IBAN validators, like\n[IBANTools](https://simplify.github.io/ibantools/).\n\nIf you need German bank data in your project, e.g., to auto-fill forms when a\nuser enters an IBAN, take a look at the side project [BankData-Germany](https://baumerdev.github.io/bankdata-germany/).\n\n\u003e _Version 1.2500.* includes data from 2024-12-09 to 2025-03-02, as well as from 2025-03-03 to 2025-06-08. Validation will be based on the data that is valid according to your system time (data changes at midnight CET on 2025-03-03)._\n\n* [Installation](#installation)\n* [Usage](#usage)\n* [Data Source](#data-source)\n* [Package Version](#package-version)\n\n## Installation\n\n### Package Manager\n\nAdd it to your project using a package manager like npm or yarn. You should\nexplicitly install the latest version, as the bank data may change multiple\ntimes a year.\n\n```sh\n$ npm install --save ibantools-germany@latest\n# or\n$ yarn add ibantools-germany@latest\n```\n\n### Browser / CDN\n\nIf you only want the functions in your browser, you can include the following\npre-built file.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/ibantools-germany/dist/build/browser.js\"\u003e\u003c/script\u003e\n```\n\n## Usage\n\nThe npm package contains the code for both ESM and CJS. Therefore, in addition\nto using `import` as shown in the usage examples below, you can also utilize\n`require`.\n\n### Validation\n\nYou can validate the bank account number and BLZ (Bankleitzahl = bank sort\ncode), a BBAN, or an IBAN. Additionally, you have the option to restrict IBAN\nvalidation to only allow German IBANs.\n\n```javascript\nimport { isValidAccountNumberBLZ, isValidBBAN, isValidIBAN } from \"ibantools-germany\"\n\nisValidAccountNumberBLZ(\"9290701\", \"10220500\"); // true\n\nisValidBBAN(\"102205000009290701\"); // true\nisValidBBAN(\"20041010050500013M02606\"); // false (valid but not a German BBAN)\n\nisValidIBAN(\"DE23102205000009290701\"); // true\nisValidIBAN(\"FR1420041010050500013M02606\"); // true\nisValidIBAN(\"FR1420041010050500013M02606\", false); // false (only allow German IBAN)\n```\n\n### Generation\n\n```javascript\nimport { generateBBAN, generateIBAN } from \"ibantools-germany\"\n\ngenerateBBAN(\"9290701\", \"10220500\"); // 102205000009290701\ngenerateBBAN(\"foo\", \"bar\"); // null\n\ngenerateIBAN(\"9290701\", \"10220500\"); // DE23102205000009290701\ngenerateIBAN(\"foo\", \"bar\"); // null\n```\n\n### Browser / CDN\n\nWhen using the pre-built version, the `ibantoolsGermany` object is globally\ndefined on the `window`, containing the functions.\n\n```javascript\nibantoolsGermany.generateBBAN(\"9290701\", \"10220500\");\nibantoolsGermany.generateIBAN(\"9290701\", \"10220500\");\nibantoolsGermany.isValidAccountNumberBLZ(\"9290701\", \"10220500\");\nibantoolsGermany.isValidBBAN(\"102205000009290701\");\nibantoolsGermany.isValidIBAN(\"DE23102205000009290701\");\n```\n\n## Data Source\n\nUnfortunately, there isn't a single algorithm to verify all German bank account\nnumbers or BBANs, as each bank employs its own method(s) which can change\nperiodically. To address this,\n[Deutsche Bundesbank](https://www.bundesbank.de/en/tasks/payment-systems/services/bank-sort-codes/download-bank-sort-codes-626218)\npublishes updated data every quarter.\n\nThese updates can encompass both technical changes, such as modifications in\ncheck digit methods, as well as content changes like alterations to BLZ, bank\nnames, and more. Some updates might not contain any relevant changes for this\nlibrary at all.\n\n## Package Version\n\nThe version numbers are based on [Semantic Versioning](https://semver.org/)\nwith some modifications.\n\n\u003e 1.2205.3\n\nThe first number represents the Major version. If this number increases, there\nmay be updates that are not backward compatible, requiring adjustments to your\ncode. In the above version string, the major version is **1**.\n\nThe first two digits of the second number indicate the year of the included data\nand check digit methods. The third and fourth digits increase either with minor\nversion changes that maintain backward compatibility or when new data is\nincluded. In the provided version string, the year is 20**22**, with a few minor\nupdates, possibly including data updates for spring and summer.\n\nThe last number is reserved for patches and bug fixes.\n\nConsidering that the data could change up to four times a year, it's advisable\nto use an appropriate version string in your package.json. As breaking changes\noccur only when the first number changes, specifying something like `\"1.x\"`\nshould suffice.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaumerdev%2Fibantools-germany","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbaumerdev%2Fibantools-germany","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaumerdev%2Fibantools-germany/lists"}