NameCheck Quick Start
Make your first successful payee validation request
NameCheck Version
This page relates to the version of NameCheck API which includes Confirmation of Payee (launched October 2026).
This guide walks you through integrating NameCheck and making your first successful payee validation request.
By the end of this guide, you will:
- Configure access to our environments
- Make a NameCheck API call and receive a match result
- Understand how to interpret results
- Prepare for Go-Live
For complete endpoint documentation, request and response formats, and field-level details, see the NameCheck API Reference.
Plan for Go-Live early
These include:
- Implementing approved CX messaging
- Implementing business processes required to prevent data harvesting
- Completing the compliance attestation
We recommend reviewing these requirements early in your integration to avoid delays later.
Refer to the Business Requirements Guide for NameCheck.
Configure your access to our non-prod environment
Before calling the NameCheck API, you must configure your environment in the Integration Centre. This step ensures your system can securely connect to CommBank APIs.
To call the NameCheck API, you will need:
- mTLS certificate (available through DigiCert X9)
Used to establish a secure connection to CommBank APIs - Source IP whitelisting
The IP addresses your system will use to connect to CommBank APIs must be registered - JWT signing key
Used to authenticate API requests
Make sure you are using the non-prod environment for initial testing.
If your environment is not fully configured, API requests may fail due to authentication or connectivity errors.
For more details, refer to our Security & Getting Access Guides
Build your initial integration
Depending on your use case, you will need to integrate NameCheck to your own payment workflow.
NameCheck is typically triggered when a user enters account details for a new payee creation or onboarding, or before a payment is made.
At a minimum, your application should:
1. Capture payee details
You will need to collect:
- BSB
- Account number
- Account name
This is typically done as part of your payment or payee onboarding workflow.
2. Implement data harvesting control
To prevent misuse of NameCheck (e.g. repeated lookups to collect account data), you must implement business processes to prevent data harvesting.
For example:
- A user attempts to validate the same account details multiple times in succession
- After a defined limit is reached, further checks are temporarily blocked
Detailed requirements are located in the Integration Centre for signed-up customers only.
Refer to: Business Requirements (NameCheck)
3. Prepare to call the NameCheck API
Once the above is in place, your application should be able to:
- Trigger a NameCheck request when payee details are entered
- Handle the API response
- Pass the result to your user interface
Make your first NameCheck request
You can validate a payee by sending a request with:
- BSB
- Account number
- Account name
Note: NameCheck currently has a 5 requests per second limit.
Example Request
{
"account": {
"type": "bankAccount",
"bsb": "123456",
"accountNumber": "123456789"
},
"name": "John Smith"
}
Example Response
{
"result": {
"code": "Match",
"description": "The provided account details strongly align with the intended payee based on authoritative verification"
}
}
Refer to our guide on Error codes and Troubleshooting for more details.
Understand and display the matching results
The response includes a result indicating how closely the account details entered align with the intended payee.
| NameCheck Result | Description |
|---|---|
| Match | The provided account details strongly align with the intended payee based on authoritative verification. |
| Close Match | There is partial or conflicting alignment between signals; details may be correct but require confirmation. |
| No Match | The provided account details do not align with the intended payee. |
| Account Closed / Inactive | The account is closed or inactive. |
For a detailed explanation of each outcome and how to interpret them, refer to our Understanding Match Results guide.
NameCheck results must be presented using approved messaging and formats.
You should:
- Display the approved CX messaging for each outcome, using the correct symbols and colours
- Ensure the messaging is clearly visible to users
- Not display any raw API fields (e.g. reason codes)
Refer to: CX Messaging Guidelines.
Prepare for production and Go-Live
Once your integration is working in our non-prod environment, you can begin preparing for production and Go-Live.
This involves both technical validation and go-live readiness requirements.
1. Complete connectivity and technical testing
Before production access can be enabled, you will need to:
- Verify connectivity to NameCheck endpoints
- Successfully execute required test cases (evidence required)
- Demonstrate that your integration behaves as expected
Test cases will be provided by our Integration Team for signed-up customers. You will need to submit evidence that these test cases have been successfully passed.
2. Implement Go-Live Requirements
As mentioned above, you will need to submit evidence of completion for multiple business go-live requirements.
Refer to: Business Requirements for NameCheck
3. Configure your production environment
Before going live, repeat environment configuration in production:
- Upload and verify your mTLS certificate
- Configure source IP whitelisting
- Publish your JWT signing key
4. Obtain production access and go live
Refer to the NameCheck Go-Live Checklist and make sure every item has been completed.
Once all requirements are met, reviewed and approved by our team, you will be able to go-live and start using NameCheck!