Addresses

Blockchain addresses are unique identifiers used to send and receive digital assets. This section allows you to manage, generate, and validate addresses associated with customers.

Address API Endpoints

GET addresses

Use Case

This endpoint returns a paginated list of wallet addresses associated with users or companies. Commonly used for auditing address activity or linking addresses to accounts.

Base URL

Address Sample Response
1
idstring (UUID)

Unique identifier of the address. This is a UUID assigned when the address is created.

2
addressstring

The actual blockchain address generated by the system, used to receive or send cryptocurrency.

3
company_idstring (UUID)

The unique identifier of the company that owns or manages this address.

4
customer_idstring (UUID)

The unique identifier of the customer associated with this address. Links the address to a specific user account.

5
labelstring

A user-defined name or label for easy identification of the address. Often used to differentiate between purposes (e.g., 'Primary Deposit Address').

6
chainstring

The blockchain network the address is associated with (e.g., 'arbitrum', 'ethereum', 'tron'). Determines how transactions are routed.

7
statusstring

The current status of the address. Typically 'active' for addresses that can receive deposits, or 'inactive' for disabled addresses.

8
created_atobject

Timestamp indicating when the address was created. Contains 'seconds' (Unix timestamp) and 'nanos' (nanoseconds) for precise timing.

9
pagenumber

The current page number in the paginated response.

10
per_pagenumber

The number of items returned per page.

11
totalnumber

The total number of addresses available across all pages.

12
total_pagesnumber

The total number of pages available based on the per_page limit.

Address Sample Response

Query Parameters
1
pagenumber

The page number of the paginated results to retrieve. This is used for navigating through multiple pages of data. Default is 1, meaning the first page.

2
limitnumber

The maximum number of items to return per page. Useful for controlling the size of each response. Default is 20.

Request Parameters

Get Address by ID or Address

Use Case

Retrieve a single address using its unique UUID or address string. Useful for looking up detailed address activity or metadata.

1
idString (UUID)Yes

The unique identifier for the address, usually auto-generated by the system. It can be used to fetch specific address details or manage address lifecycle events.

2
addressStringYes

The actual blockchain address to query. This is the alphanumeric string used for sending or receiving crypto assets on a specific chain, such as Bitcoin or Ethereum.

Get Address by ID or Address

Get Address by ID or Address Sample Response
1
idstring (UUID)

A system-generated unique identifier assigned to the blockchain address. This is used internally for referencing and managing the address.

2
addressstring

The actual blockchain address string (e.g., 'bc1q...') used to receive or send digital assets. This is the key value for wallet transactions.

3
labelstring

A user-friendly name or tag given to the address to easily distinguish it from others (e.g., 'Main Wallet', 'USDT Wallet').

4
addressTypestring

Specifies how the address is used. Common types include 'deposit' for receiving funds and 'withdrawal' for sending funds.

5
chainstring

The blockchain network to which the address belongs (e.g., 'bitcoin', 'ethereum'). Ensures compatibility with specific cryptocurrency protocols.

6
totalReceivedstring

Cumulative value of funds received by this address, typically denominated in the chain's native asset.

7
totalCountReceivedstring

Total number of individual transactions that have credited this address.

8
expiredboolean

Indicates if the address has expired or is no longer active. Expired addresses should not be used for new deposits.

9
createdAtstring (ISO 8601)

Timestamp indicating when the address was first created in the system. Format follows ISO 8601 standards.

10
updatedAtstring (ISO 8601)

Timestamp representing the last time the address record was modified. Useful for tracking changes or updates.

11
customerobject

The customer associated with this address, containing details such as id, name, email, phone, and blacklist status. Null if no customer is linked.

Address Response Sample

Generate Addresses

Use Case

Generate or assign a new address for a supported blockchain, optionally tied to a customer.

Base URL

Generate Addresses Sample Request
1
chainstringRequired

The blockchain network for which the deposit address is being generated. Determines the address format and compatibility (e.g., 'ethereum').

2
customer_idstringOptional

A unique identifier for the customer in your system. This is typically a UUID representing the user account.

3
referencestringOptional

Optional unique ID to track this deposit address request (e.g., order ID or user reference).

4
customer_emailstringRequired

The email address of the customer associated with the deposit address. Used for mapping and communication purposes.

5
labelstringNot Required

A descriptive label for the address, such as 'Primary Deposit Address' or 'ETH Wallet'. Helps organize and identify generated addresses.

Sample Request

Generate Addresses Sample Response
1
chainstring

The blockchain network the address belongs to (e.g., 'bitcoin', 'ethereum').

2
company_idstring (UUID)

The unique identifier of the company that owns the address.

3
customer_idstring (UUID)

The unique identifier of the customer associated with the generated address.

4
addressstring

The generated blockchain address associated with the customer or company.

5
statusstring

Represents whether the address is currently active or inactive.

6
labelstring

A user-friendly name used to identify the purpose of the address (e.g., 'Primary Deposit Address').

Sample Response

Validate Address

Use Case

Validates whether an address is well-formed and supported on a given chain. Does not assign or persist the address — only validates its format.

Validate Address - Request

Validate Address Sample Request
1
addressStringRequired

The blockchain address you want to validate. It should be in the correct format for the selected chain (e.g., a Bitcoin address like 'bc1q...').

2
chainStringRequired

The blockchain network the address belongs to (e.g., 'bitcoin', 'ethereum'). This helps ensure the address is valid for the correct network.

Sample Request

Validate Address Response
1
successboolean

Indicates whether the API request was processed successfully.

2
messagestring

A human-readable message describing the result of the validation operation.

3
validboolean

Returns true if the provided blockchain address is valid for the specified chain, otherwise false.

4
addressstring

The blockchain address that was validated.

5
chainstring

The blockchain network the address was validated against (e.g., 'solana', 'ethereum').

6
request_idstring

A unique identifier for this specific API request, useful for debugging and support.

7
timestampstring (ISO 8601)

The UTC timestamp when the validation was completed.

Response

Stablecoins Supported Chains

Use Case

Displays all supported blockchain networks along with their native tokens and stablecoins.
Helps developers identify which tokens can be used for transactions and ensures correct decimals are applied when sending or receiving assets.

Endpoint

Stablecoins Supported Chains Response
1
chainsarray

A list of supported blockchain networks, each containing its native token and available stablecoins.

2
chainstring

The name of the blockchain network (e.g., 'arbitrum', 'bsc', 'ethereum', 'tron').

3
nativeTokenobject

Details of the chain's native token, including symbol and decimals.

4
stablecoinsarray

A list of stablecoins supported on the chain, each with symbol and decimals.

5
symbolstring

The symbol of the chain's native token (e.g., 'ETH', 'BNB', 'TRX').

6
decimalsnumber

The number of decimals used by the native token.

Sample Response

Did you find this page useful?