List external addresses

This endpoint provides a paginated list of crypto addresses from Address-Book associated with a specific beneficiary. It supports several query parameters to help filter the results by specific criteria, such as address ID, asset ID, and network type.

This endpoint enables clients to retrieve only the necessary subset of addresses for a user, making it flexible and efficient for use cases requiring focused data retrieval.

SecuritybearerAuth
Request
query Parameters
id
string <uuid>

Filters results by a specific crypto address ID. Use this parameter to retrieve a single address by its unique identifier if you need details for one address only.

Example: id=11111111-12ab-ab12-eeeeeeeeeeee
asset_id
string <uuid>

Filters results by a specific asset ID. This allows retrieval of addresses for a particular cryptocurrency asset (e.g., BTC, ETH). Use this to view all addresses associated with a specific asset type for a user.

Example: asset_id=1ed83487-f684-62a2-a155-fe633f0db292
coin_network_id
string <uuid>

Filters addresses by the coin network ID, specifying the network type associated with the asset (e.g., Bitcoin mainnet, Ethereum mainnet). This parameter helps retrieve addresses on a particular blockchain network.

Example: coin_network_id=d969468d-2be6-4522-977e-ea4d92c45e86
header Parameters
bp-user-id
required
string <uuid>
Example: 12312312-2be6-4522-977e-ea4d92c45e86
Responses
200

Success Response

401

Unauthorized

403

Forbidden

422

Validation Error

500

Internal Error

503

Service unavailable

get/v1/crypto-transfers/addresses
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}