Bank Account Verification

Overview

This endpoint verifies bank account details, confirming that the account exists and belongs to the person or entity named. This is commonly used for payment processing, salary disbursement, and KYC workflows.

Endpoint

POST /Citizen/AccountVerificationService

Request

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/AccountVerificationService" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "AccountNumber": "1234567890",
    "BranchCode": "123456",
    "AccountType": "Current",
    "IdNumber": "8001014800080",
    "InitialsAndSurname": "J Doe",
    "CRef": "REF00001"
  }'

Request Fields

Field	Type	Required	Description
`ConsentReceived`	boolean	Yes	Must be `true`
`AccountNumber`	string	Yes	Bank account number to verify
`BranchCode`	string	Yes	Bank branch code
`AccountType`	string	Yes	Account type (`Current`, `Savings`, `Transmission`)
`IdNumber`	string	Yes	SA ID number of the account holder
`InitialsAndSurname`	string	Yes	Initials and surname of the account holder
`CRef`	string	No	Your transaction reference

Response

{
  "AccountVerificationResult": {
    "accountFound": true,
    "accountOpen": true,
    "accountAcceptsCredits": true,
    "accountAcceptsDebits": true,
    "idNumberMatch": true,
    "initialsMatch": true,
    "resultCode": "PASS",
    "resultDescription": "Account verified successfully"
  },
  "Status": "Success",
  "CRef": "REF00001"
}

Response Fields

Field	Description
`accountFound`	`true` if the account exists
`accountOpen`	`true` if the account is open and active
`accountAcceptsCredits`	`true` if the account can receive payments
`accountAcceptsDebits`	`true` if the account can be debited
`idNumberMatch`	`true` if the ID number matches the account holder
`initialsMatch`	`true` if the initials match the account holder
`resultCode`	Summary result code (`PASS`, `FAIL`, `PARTIAL`)
`resultDescription`	Human-readable result description

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Overview

Endpoint

Request

Request Fields

Response

Response Fields

​Overview

​Endpoint

​Request

​Request Fields

​Response

​Response Fields

Overview

Endpoint

Request

Request Fields

Response

Response Fields