Check if a certain account is restricted

post/account-number-verification

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/account-number-verification
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:restricted_accounts

Request body

accountNumberstring

The bban account number to check, formatted as 'XX-XXX-XXXXX'

accountIbanNumberstring

The iban account number to check, formatted as 'ILXXXXXXXXXXXXXXXXXXX'

Response

Response

status'RESTRICTED' | 'VALID' | 'INVALID'

Returns whether the account is restricted, and if not then if the account number is valid or not

reason'BANK_INVALID' | 'BRANCH_INVALID' | 'ACCOUNT_INVALID' | 'BRANCH_CLOSED' | 'SHORT_ACCOUNT_NUMBER'

If the account is invalid, the reason will be displayed here

Example response

{
  "status": "INVALID"
}

Changes

No recorded changes to this operation across all 1 revision of this API.