Bank Account Verification

Bank Account Verification

POST {{baseurl}}/v2/api/identity/za/bav

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Users identity number
accountDetails*	Object	Account details data object e.g "accountDetails":{ "bankBranchCode":"470010", "bank":"", "accountNumber":"1443535328", "accountType":"Savings" }
bankBranchCode*	String	Account bank branch code
bank	String	Account bank
accountNumber*	String	Account number
accountType*	String	Account Type
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
data	Object	Validation data object
lastName	String	Lastname to compare against ID
firstName	String	Firstname to compare against ID
middleName	String	Middlename to compare against ID
email	String	Email to compare against ID
phoneNumber	String	Phone number to compare against ID

Bank Account Verification

With this endpoint, you have access to the verification of the client's account numbers for all banks in South Africa.

Bank Account Verification Sample Request

{
    "validations": {
        "data": {
            "firstName": "CONCO",
            "middleName": "",
            "lastName": "",
            "email": "[e-mail]",
            "phoneNumber": "0795030317"
        }
    },
    "accountDetails": {
        "bankBranchCode": "470010",
        "bank": "",
        "accountNumber": "1443535328",
        "accountType": "Savings"
    },
    "id": "8203170496089",
    "isSubjectConsent": true
}

Found Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca7cd80de606cd7e5ad3",
        "validations": {
            "data": {
                "phoneNumber": {
                    "validated": false,
                    "value": "0795030317"
                },
                "fullName": {
                    "validated": true,
                    "value": "CONCO"
                },
                "email": {
                    "validated": false,
                    "value": "[e-mail]"
                }
            },
            "validationMessages": "Email does not match, Phone Number does not match"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "identityNumberValid": "No",
        "accountTypeValid": "Yes",
        "accountStatus": "Open",
        "acceptsDebits": "Yes",
        "acceptsCredits": "Yes",
        "accountNumberValid": "Yes",
        "bavRiskOutcome": "Low",
        "isConsent": true,
        "accountNumber": "1443535328",
        "idNumber": "8203170496089",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "type": "zaBAV",
        "allValidationPassed": false,
        "requestedAt": "2023-05-10T16:47:20.552Z",
        "requestedById": "628b38f13ae28a7b742d4bf9",
        "country": "ZA",
        "createdAt": "2023-05-10T16:47:20.938Z",
        "lastModifiedAt": "2023-05-10T16:47:20.938Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "Onyeka",
            "lastName": "Ijeh",
            "middleName": "",
            "id": "628b38f13ae28a7b742d4bf9"
        }
    },
    "links": []
}

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}