NameCheck
POST/core-payments/v2/accounts/namecheck
Checks whether the supplied account name matches the account. Supports Account Types: bankAccount.
The checks performed, and the results that can be returned, depend on the scopes granted to the client:
| Scopes granted | Checks performed | Possible results |
|---|---|---|
payments:namecheck:read | NameCheck | Match, Close Match, No Match, Unavailable |
payments:cop:read | Confirmation of Payee (CoP) | Match, Close Match, No Match, Account Closed, Unavailable |
| Both | NameCheck and CoP, combined into a single result | Match, Close Match, No Match, Account Closed, Unavailable |
Request
Responses
- 200
- 400
- 401
- 403
- 500
- 503
OK
Result Codes
| Code | Description |
|---|---|
| Match | The account name matches the intended recipient |
| Close Match | The account details are similar but not an exact match |
| No Match | The account details do not match the intended recipient |
| Account Closed | The account is closed or no longer valid |
| Unavailable | We couldn't verify the account at this time |
Response Headers
The request body failed validation, in which case details names each offending field, the account number is longer than 34 characters when CoP is performed, or the mandatory x-session-id header is missing, repeated, or not a valid UUID.
Response Headers
Echo of the x-request-id supplied on the request. Quote it when raising a support ticket.
The request carried no usable authorisation context.
Response Headers
Echo of the x-request-id supplied on the request. Quote it when raising a support ticket.
Either the token does not grant access to this operation, so re-authenticating will not help, or a usage cap refused the request. The two caps carry distinct code values because their remedies differ: open a new session, or wait for the daily allowance to reset at midnight Australia/Sydney. A session that has reached its cap cannot be reused. No retry or rate-limit headers are returned on any of these.
Response Headers
Echo of the x-request-id supplied on the request. Quote it when raising a support ticket.
An unexpected error occurred. The request was not completed.
Response Headers
Echo of the x-request-id supplied on the request. Quote it when raising a support ticket.
The service is temporarily unavailable. The request is safe to retry.
Response Headers
Echo of the x-request-id supplied on the request. Quote it when raising a support ticket.