Bank Account Number Validation

The Australian Bank Account validation endpoint provides comprehensive validation of BSB (Bank State Branch) and account number combinations according to Australian Banking Association (ABA) standards. This service validates the structure and format of bank account details, ensuring they meet required format standards. The validation includes checking for valid number lengths and proper formatting of both BSB and account numbers.

Bank account validation helps ensure data quality by confirming the structural validity of banking details before they are used in financial and payment systems. The service supports the standard 6-digit BSB format and 6-9 digit account number format, making it suitable for validating all Australian bank account numbers.

IMPORTANT

This validation performs ONLY format conformity checks against ABA-defined standards and does not verify the actual existence or status of the bank account. A successful validation only confirms that the BSB and account number follow the correct structure.

A "valid" result should NOT be interpreted as confirmation that the account exists, is active, or can accept transactions. For systems requiring guaranteed validity, additional verification steps can be implemented via Bank State Branch API →

Model

Specific structure of the data that represents the entity within the API. It defines the attributes and their data types associated with the entity.

It's important to note that you'll need to retrieve the complete identifier for an entity each time you require its complete model. This can be achieved by utilizing the find endpoint to locate the entity and then using the retrieved identifier to call the retrieve endpoint for complete model.

  • Name
    bsb
    Type
    string
  • Name
    account
    Type
    string
  • Name
    formatted
    Type
    string
  • Name
    isValid
    Type
    boolean
GET/validate/bank-account-number/

Validate

This endpoint analyzes an Australian bank account number to verify its validity according to ABA standards. It performs checks including:

  • Valid BSB length (6 digits)
  • Valid account number length (6-9 digits)
  • Proper formatting rules for both components

Mandatory headers

  • Name
    x-api-key
    Type
    string
    Description
    A valid API key obtained through active subscription must be included in the header in order for the endpoint to work.

Required parameters

  • Name
    bsb
    Type
    string
    Description
    The Bank State Branch (BSB) number to validate.
  • Name
    account
    Type
    string
    Description
    The account number to validate.

Request

GET
/validate/bank-account-number/
curl "https://api.vigil.sh/validate/bank-account-number/?bsb=062-001&account=10022001" \
-H 'x-api-key: {api-key}'

Response

{
  "result": {
    "bsb": "062001",
    "account": "10022001",
    "formatted": "062-001 10022001",
    "isValid": true
  }
}