Account Verification API

Account Verification API is the Brick Bank Account Validation endpoint for checking destination bank account details. Send the bank short code and account number, then use the response to confirm whether Brick can validate the account through the supported bank network.

Use this API before saving beneficiary details or initiating a payout. The response may include the account holder name returned by the bank network, but it does not by itself prove legal ownership or complete fraud screening.

Request parameters

Response parameters

Response examples

200 Success

Code
{
  "status": 200,
  "data": {
    "message": "We are successfully able to verify the account",
    "bankShortCode": "DANA",
    "accountNo": "08123412341234",
    "accountName": "beneficiary holder name",
    "activityId": "86569bbf0b017afb59cb71765eaec280"
  },
  "error": null,
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

400 Invalid format

Code
{
  "status": 400,
  "data": null,
  "error": {
    "code": "invalid_format",
    "message": "The bank account validation request could not be processed because one or more submitted fields are missing, invalid, or not in the required format.",
    "action": "Please review the request parameters and ensure the account number, bank code, and other required fields follow the required format before submitting again.",
    "reason": "The request contains invalid, incomplete, or improperly formatted information required to process the bank account validation."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

404 Account not found

Code
{
  "status": 404,
  "data": null,
  "error": {
    "code": "account_not_found",
    "message": "We were unable to verify the submitted bank account details. The account number, account holder name, or bank information may be incorrect or not available for validation.",
    "action": "Please review the account number, account holder name, and bank details, then submit the request again with the correct information.",
    "reason": "The provider could not find a matching bank account or account holder based on the submitted validation details."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

500 Internal server error

Code
{
  "status": 500,
  "data": null,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Bank account validation could not be completed at this time due to a temporary processing issue from the downstream bank network, or internal validation service.",
    "action": "Please retry the request later. If the issue persists, please contact support with the transaction reference for further assistance.",
    "reason": "The validation request could not be completed because a temporary system or bank network error occurred during processing."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

503 Unknown behaviour

Code
{
  "status": 503,
  "data": null,
  "error": {
    "code": "UNKNOWN_BEHAVIOUR",
    "message": "Bank account validation could not be completed because the bank network returned an unexpected response that could not be met with a standard validation result.",
    "action": "Please retry the request later. If the issue persists, please contact support with the transaction reference for further investigation.",
    "reason": "The provider returned an unmapped, unexpected, or unsupported response that could not be classified under the standard validation outcome."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}