Validate a bank account

This POST endpoint is used to validate a bank account against MassPay's account verification providers, independently of a payout.
The bank account is validated for the user identified by user_token in the path, and the account holder name on record for that user is used for name matching.
If a finalized result is available within ~5 seconds (including cached results), it is returned synchronously with HTTP 200. Otherwise HTTP 202 is returned with a status of PROCESSING and the finalized result is delivered asynchronously through the avs.completed webhook event.
Validations are charged per validation based on your client pricing configuration; validations that cannot be verified by any provider (UNSUPPORTED) are not charged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Token representing the user the bank account belongs to. The name on record for this user is used for account holder name matching.

Body Params

Bank account details to validate. The user is identified by the user_token path parameter.

string
length between 2 and 2

ISO alpha-2 country code of the bank account.

attrs
array of objects
required
length ≥ 1

Bank account attributes to validate. BankAccountNumber is required.

attrs*

A single bank account attribute supplied for validation.

string
enum
required

Attribute type.

Allowed:
string
required

Value of the attribute.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json