Get Verified Accounts

Once your customer has approved the sharing of account verification data with you, you can use this API to retrieve the account details for the customer.

Headers

Content-Type String - (Required)
application-json

Accept String - (Required)
application-json

Authorization String - (Required)
Bearer {ACCESS_TOKEN} (See Authentication)

Parameters

CUSTOMER_ID String (part of URL) - (Required)
The specific Customer ID to retrieve

Returns

accounts Array
The list of accounts that have been verified for the specified customer ID

accountId String
Unique identifier for the account (This is not the same as CustomerId)

accountNumberDisplay String
Displays the last four digits of the account number

bankId String
Displays the routing number for the account

identifier String
Displays the account number for the account

type String
Displays the payment network type for which the bankId and identifier are used in delivery

GET Request

GET - /v1/customers/{CUSTOMER_ID}/account_verifications/accounts

GET Request

1curl --location --request GET '{API_BASE_URL}/v1/customers/{CUSTOMER_ID}/account-verifications/accounts' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer {ACCESS_TOKEN}'

Response Body

Response

1{ 
2	"accounts": [ 
3		{ 
4			"depositAccount": {
5				"accountId": "11111111-1fff-1111-1111-000111111111", 
6				"accountNumberDisplay": "0001" 
7			}, 
8			"paymentNetworks": [{
9				"bankId": "000000000", 
10				"identifier": "00000000001", 
11				"type": "US_ACH" 
12			}], 
13		}, 
14		{ 
15			"depositAccount": {
16				"accountId": "22222222-2eee-2222-2222-2e2e2e2e2e2e", 
17				"accountNumberDisplay": "0002" 
18			}, 
19			"paymentNetworks": [{
20				"bankId": "000000000", 
21				"identifier": "00000000002", 
22				"type": "US_ACH" 
23			}], 
24		}, 
25	] 
26}