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 '{
    "ConsentRecieved": true,
    "IDNumber": "8001014800080",
    "IDType": 1,
    "BankName": 1,
    "BranchCode": "250655",
    "AccountType": 1,
    "AccountNumber": "1234567890",
    "Initials": "J",
    "Surname": "Doe",
    "CRef": "REF00001"
  }'

This endpoint spells the consent field ConsentRecieved, not ConsentReceived. The request schema doesn’t allow extra fields, so use this spelling.

Request Fields

Field	Type	Required	Description
`ConsentRecieved`	boolean	No	Set to `true` to confirm subject consent was obtained
`IDNumber`	string	Yes	ID number of the account holder
`IDType`	integer	Yes	Type of ID number. See ID types
`BankName`	integer	Yes	Bank that holds the account. See Banks
`BranchCode`	string	Yes	Bank branch code
`AccountType`	integer	Yes	Type of account. See Account types
`AccountNumber`	string	Yes	Bank account number to verify
`Initials`	string	Yes	Initials of the account holder
`Surname`	string	Yes	Surname of the account holder
`CRef`	string	No	Your transaction reference

IDType, BankName, and AccountType take integer codes. 0 means unspecified for all three.

ID types

Code	Value
`1`	`SID` (South African ID number)
`2`	`SPP`
`3`	`FPP`

TBC: engineering confirming what the SPP and FPP ID types cover.

Banks

Code	Bank
`1`	FNB
`2`	Standard Bank
`3`	ABSA
`4`	Nedbank
`5`	African Bank
`6`	Capitec
`7`	Investec
`8`	Mercantile
`9`	Bidvest Bank
`10`	Sasfin
`11`	Discovery
`12`	Grindrod
`13`	GroBank

Account types

Code	Account type
`1`	Current or cheque
`2`	Savings
`3`	Transmission
`4`	Bond
`5`	Subscription share

Response

{
  "responseObject": {
    "status": "success",
    "result": {
      "AccountVerificationResult": {
        "ResultFile": {
          "AccountNumber": "1234567890",
          "AccountType": "string",
          "IdNumber": "8001014800080",
          "Initials": "J",
          "Surname": "Doe",
          "AccountFound": "string",
          "IdNumberMatch": "string",
          "InitialsMatch": "string",
          "SurnameMatch": "string",
          "Account-Open": "string",
          "AccountDormant": "string",
          "AccountOpenForAtLeastThreeMonths": "string",
          "AccountAcceptsDebits": "string",
          "AccountAcceptsCredits": "string"
        },
        "SubscriberInputDetails": {
          "EnquiryDate": "2026-01-01T00:00:00Z",
          "EnquiryStatus": "string",
          "AccountNo": "1234567890",
          "BankName": "string",
          "BranchCode": "250655"
        }
      }
    },
    "error_message": {
      "noResult": {
        "error": null
      }
    }
  },
  "RequestedBy": "string",
  "AuthorizedBy": "string",
  "CRef": "REF00001",
  "Status": "Success",
  "Message": "string"
}

The example shows the main fields. ResultFile and SubscriberInputDetails carry more fields. See the API reference for the full list.

Response Fields

Field	Description
`responseObject.status`	Status returned for the verification
`ResultFile.AccountFound`	Whether the account exists
`ResultFile.Account-Open`	Whether the account is open
`ResultFile.AccountDormant`	Whether the account is dormant
`ResultFile.AccountOpenForAtLeastThreeMonths`	Whether the account has been open for at least three months
`ResultFile.AccountAcceptsCredits`	Whether the account can receive payments
`ResultFile.AccountAcceptsDebits`	Whether the account can be debited
`ResultFile.IdNumberMatch`	Whether the ID number matches the account holder
`ResultFile.InitialsMatch` / `SurnameMatch`	Whether the initials and surname match the account holder
`SubscriberInputDetails`	Details of the enquiry as submitted
`responseObject.error_message.noResult.error`	Error message when no result was found

The ResultFile fields are strings. TBC: engineering confirming the values each field can take.

The response schema includes both responseObject and response_object, with the same shape. The result is returned in responseObject. TBC: engineering confirming that response_object, result, and result_code are always empty for this endpoint.

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Overview

Endpoint

Request

Request Fields

ID types

Banks

Account types

Response

Response Fields

​Overview

​Endpoint

​Request

​Request Fields

​ID types

​Banks

​Account types

​Response

​Response Fields

Overview

Endpoint

Request

Request Fields

ID types

Banks

Account types

Response

Response Fields