https://github.com/liamja/modcheck.js

Check a UK bank account number against a sort code using the VocaLink modulus check.
https://github.com/liamja/modcheck.js

banking gb modulus-check modulus-checking uk vocalink

Last synced: about 2 months ago
JSON representation

Check a UK bank account number against a sort code using the VocaLink modulus check.

• Host: GitHub
• URL: https://github.com/liamja/modcheck.js
• Owner: liamja
• Created: 2015-08-23T16:07:50.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-08-30T07:51:54.000Z (over 8 years ago)
• Last Synced: 2024-04-29T21:21:44.540Z (8 months ago)
• Topics: banking, gb, modulus-check, modulus-checking, uk, vocalink
• Language: JavaScript
• Homepage:
• Size: 23.4 KB
• Stars: 6
• Watchers: 4
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# modcheck.js [![Build Status](https://travis-ci.org/liamja/modcheck.js.svg?branch=master)](https://travis-ci.org/liamja/modcheck.js)

A Javascript library to check a UK bank account number against a sort code using [VocaLink's modulus check](https://www.vocalink.com/customer-support/modulus-checking/).

### :warning: Warning

A passing modulus check **does not** mean that an account number and sort code exists and is registered to an account holder; it merely confirms the possiblity of an account number being valid for a given sort code.

## Building

`npm run build`

## Testing

`npm test`

## Using

Basic usage in a node.js script:

```js

var Modcheck = require('modcheck');

var modcheck = new Modcheck('66374958', '08-99-99');

if (modcheck.check()) {

  console.log('This account number could potentially be registered to this sort code.');

} else {

  console.log('This account number could NOT be registered to this sort code.');

}

```

## Resources

- [valacdos.txt](https://www.vocalink.com/media/1518/valacdos.txt)

- [scsubtab.txt](https://www.vocalink.com/media/1517/scsubtab.txt)

- [Modulus Check Specification](http://www.vocalink.com/media/700427/vocalink_-_validating_account_numbers_v3.20.pdf)

## Other Implementations

- [Ruby (by Baris Balic)](https://github.com/barisbalic/modulus)

- [Ruby (by Hayden Ball)](https://github.com/ball-hayden/uk_account_validator)

- [C# (by Rat Cow Software)](https://code.google.com/p/ratcowsoftopensource/source/browse/trunk/ratcowutilities/RatCow.UKBankAccValidator/?r=81)