Skip to main content
GET
Get wallet

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1

Path Parameters

id
string<uuid>
required

Wallet ID

Query Parameters

expand[]
string[]

Expand related resources inline (e.g. addresses).

Response

Success

addresses
object[]

Addresses on the wallet; populated only when requested via expand[]=addresses

chain
string

Blockchain the wallet operates on

Example:

"ethereum"

created_at
string<date-time>

ISO-8601 timestamp when the wallet was created

Example:

"2026-05-16T10:30:00Z"

customer_ref_id
string

Partner-supplied reference identifier for the wallet

Example:

"cust_8842"

id
string

Unique identifier of the wallet

Example:

"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

metadata
object

Arbitrary partner-supplied key/value metadata

name
string

Human-readable name of the wallet

Example:

"Treasury wallet"

object
string

Object type, always "wallet"

Example:

"wallet"

primary_address
string

Wallet's preferred receive address; omitted when no address has been provisioned yet

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

status
string

Current status of the wallet

Example:

"active"

updated_at
string<date-time>

ISO-8601 timestamp when the wallet was last updated

Example:

"2026-05-16T10:30:00Z"

vault_id
string

Identifier of the vault the wallet belongs to

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

wallet_type
string

Wallet type (e.g. hot, cold, operational)

Example:

"hot"