Verify account data

Get receiver account data verification

Verify account by account data

POST /api/receiver-account/verify

Headers

Name	Value
x-api-key	<token>
signature	<token>

Body

Name	Type	Description
subaccount_id*	string	Subaccount ID of receiver account.
account_data*	object	Account data to retrieve account info.

* is mandatory parameter

How Filtering Works

The account_data fields for verification match the fields used when creating receiver accounts. You can filter by any combination of these fields.

Approach	Use Case	Example
Partial match	Returns the first receiver account that matches	{ "bsb": "123456" }
Exact match	Returns the specific account matching all fields	{ "bsb": "123456", "account_number": "123456789" }

Examples:

• Send only bsb → Returns first receiver account with that BSB

• Send only account_number → Returns first receiver account with that account number

• Send both bsb + account_number → Returns the exact matching account

Example body request

Direct Entry (AUD)

  {           
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",                                                                                                                                                           
    "account_data": {                                                                                                                                                    
      "bsb": "123456",                                                                                                                                                   
      "account_number": "123456789"                                                                                                                                      
    }                                                                                                                                                                    
  }   

Field	Text
account_number	Account number
bsb	6-digit Bank-State-Branch code

ACH (USD)

  {    
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",                                                                                                                                                                  
    "account_data": {                                                                                                                                                    
      "account_number": "123456789",                                                                                                                                     
      "routing_number": "021000021",                                                                                                                                     
      "account_type": "checking"                                                                                                                                         
    }                                                                                                                                                                    
  } 

Field	Text
account_number	Account number
routing_number	9-digit ABA routing number
account_type	checking or savings

EFT (CAD)

  {        
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",                                                                                                                                                              
    "account_data": {                                                                                                                                                    
      "account_number": "123456119",                                                                                                                                     
      "routing_number": "011401533",                                                                                                                                     
      "account_type": "savings"                                                                                                                                          
    }                                                                                                                                                                    
  } 

Field	Text
account_number	Bank account number
routing_number	9-digit routing number (institution + transit)
account_type	checking or savings

SEPA (EUR)

 {       
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",                                                                                                                                                               
    "account_data": {                                                                                                                                                    
      "iban": "DE89370400440532013000",                                                                                                                                  
      "bic": "COBADEFFXXX"                                                                                                                                               
    }                                                                                                                                                                    
  }    

Field	Text
iban	International Bank Account Number
bic	Bank Identifier Code (SWIFT)

Direct Credit (NZD)

  {         
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",                                                                                                                                                             
    "account_data": {                                                                                                                                                    
      "account_number": "12-3456-1234567-00"                                                                                                                             
    }                                                                                                                                                                    
  }   

Field	Text
account_number	NZ account number format: BB-bbbb-AAAAAAA-SS

Response

200

{
    "exists": true,
    "receiver_id": "b367730a-6837-43e9-9b19-af910f4b8000",
    "account_id": "cdad7781-4169-4129-940d-c15077a46e86",
    "account_data": {
        "bsb": "012 ***",
        "account_number": "111 ***"
    }
}

400