Send Address Book Request

This recipe outlines the steps to send an address book request using the Customers Bank API. By following this guide, developers can authenticate their API access, search for external accounts, send connection requests, and optionally check for pending requests. This process enables seamless integration and efficient management of connection requests within the Customers Bank ecosystem. Each step includes detailed instructions and sample code to ensure a smooth implementation.

Step 1: Authenticate API

Endpoint: https://cubi-sandbox-api.customersbank.com/security/v1/authenticate/token

Description: Authenticate and receive an API token

Example Request:

POST /security/v1/authenticate/token HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Content-Type: application/json
Content-Length: 125

{
    "clientId": "ebb8a62b-e559-43d4-ae44-c7cdc5567320",
    "clientSecret": "12~3F~11111111111111111111111111111111"
}

Step 2: Search External Accounts

Endpoint: https://cubi-sandbox-api.customersbank.com/transfers/v1/AddressBook/availableAccounts

Description: Search for other clients in order to connect with them

Example Request:

Step 3: Add Entry Request

Endpoint: https://cubi-sandbox-api.customersbank.com/transfers/v1/AddressBook/entries

Description: Request to connect with an account

Example Request:

View Entry Requests

Endpoint: GET /AddressBook/entries/requests

Description: View sent connect requests that are currently pending

Request Example: