> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt
> Use this file to discover all available pages before exploring further.

# Bank Account Verification

> Verify that a bank account number belongs to the specified account holder.

## 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

```bash theme={null}
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

```json theme={null}
{
  "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                  |
