Generate blockchain addresses for your profiles. Addresses belong to wallets and are used to send and receive funds.
Methods
createAddress()
Generate a new address for a profile (V1 API). Requires wallet to exist first.
Signature:
Parameters:
| Parameter | Type | Required | Description |
|---|
request.reference | string | Yes | Profile reference |
request.networkId | string | Yes | Network ID (from getNetworks()) |
request.clientShare | string | Yes | Client share for key derivation |
Example:
createAddressV2()
Generate a new address (V2 API). Automatically creates wallet if it doesn’t exist. This is the recommended method.
Signature:
Parameters:
Same as createAddress().
Example:
Use V2: The createAddressV2() method is recommended as it automatically creates a wallet if one doesn’t exist, simplifying your workflow.
getAddressById()
Retrieve a single address by its UUID.
Signature:
Parameters:
| Parameter | Type | Required | Description |
|---|
request.id | string | Yes | Address UUID |
Example:
getAddressForProfile()
Get addresses for a profile by reference.
Signature:
Parameters:
| Parameter | Type | Required | Description |
|---|
reference | string | Yes | Profile reference |
request.skip | number | No | Number of records to skip |
request.take | number | No | Number of records to retrieve |
Example:
getAddressForOrganization()
Get all addresses for an organization.
Signature:
Parameters:
| Parameter | Type | Required | Description |
|---|
request.skip | number | No | Number of records to skip |
request.take | number | No | Number of records to retrieve |
Example:
Complete Example