➕Create New Customer Account

In order to verify a Customer's Bank Account, you will first need to create an Account for a Customer before performing the Account verification.

Please note that we will perform the verification on the Bank Account against the customer details provided in the POST Create New Customer endpoint.

If you are going to use the Return DT Account Verification Endpoint to get your verification, you will need to ensure you have set the "popi" field in Create New Customer to 1. Alternatively, if you have already created the Customer, you can use PATCH Update Customer endpoint to set "popi" to 1.

Create New Account Verification

POST {{baseUrl}}/account-verifications

In order to verify an Account a unique Account identifier needs to be created. The Account identifier will contain details of the Customers main bank account.

Request Body

Name	Type	Description
customer_id*	String	This is a UUID for a specific customer that gets generated and returned in the POST Create New Customer response. It ensures that the Bank Account is created for a specific customer.
account_number*	String	This is the Account Number for the Bank Account you would like to verify.
account_holder*	String	This is the name (initials and last_name) of the Account Holder of the Bank Account that you would like to verify.
bank*	String	This is the name of the bank that the end-user/customer banks with. Each bank has a "slug" which you will have to use here. Please see this list of slugs for the available banks.
account_type*	String	This is the type of account that you would like to verify. The accepted options for this field are: Savings, Current, Transmission.
branch_code*	String	This is the Branch Code for the Bank Account that you would like to verify. Universal Branch Codes are also accepted.

Example Request Body - Cheque Account

{
    "data": {
        "id": "{{accountVerificationId}}",
        "account_holder": "MR MA Bowren",
        "bank": "nedbank",
        "account_number": "1234926726",
        "account_type": "Current",
        "branch_code": "198765"
    }
}

Example Request Body - Savings Account

{
    "data": {
        "id": "{{accountVerificationId}}",
        "account_holder": "Miss KJHancock",
        "bank": "absa",
        "account_number": "4077066572",
        "account_type": "Savings",
        "branch_code": "632005"
    }
}

Status Codes

201: Created

Created a consumer account

{
    "data": {
        "id": "{{$randomUUID}}",
        "account_holder": "Miss Jane Doe",
        "bank": "absa",
        "account_number": "XXX7066XXX",
        "account_type": "Current",
        "branch_code": "632005"
    }
}

422: Unprocessable Entity

Missing Customer UUID

{
    "errors": {
        "customer_id": [
            "The customer id field is required."
        ]
    }

Invalid Customer UUID

{
    "errors": {
        "customer_id": [
            "The selected customer id is invalid."
        ]
    }
}

Invalid Bank Slug

{
    "errors": {
        "bank": [
            "The bank provided is invalid."
        ]
    }
}