Create a Crypto Address

Once you have an Assed Pool and id from the earlier request, you can generate crypto addresses within that Asset Pool. See the list of available cryptocurrency addresses in the Supported Assets and Protocols guide.

To create a Crypto Address, send the POST /digital/v1/addresses request with the following body parameters:

Example request

{
    "network": "ETHEREUM",
    "asset": "ETH",
    "reference": "First Eth Address",
    "customerId": "customerOne",
    "assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
}

Field	Description
network	Blockchain network where the asset is hosted
asset	Type of cryptocurrency asset
reference	Unique reference for the crypto address
customerId	Unique identifier of the customer
assetPoolId	Unique identifier of the asset pool. Useid from the previous request

Upon successfully submitting the request, you'll receive details of the newly created Address:

Example response

{
    "assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600",
    "keyPairId": "44cf54df-93e9-4dd9-84c9-e96f0cf90f3e",
    "reference": "First Eth Address"
}

Field	Description
assetPoolId	The unique identifier of the Asset Pool
keyPairId	The unique identifier of the key pair
reference	A unique reference for the crypto address

At this point, the address is created on the relevant blockchain and associated with AssetPoolId from the request. Then it is delivered asynchronously through a webhook to the destination set up earlier.

Address Created Webhook

The "address created" webhook is sent to any destination subscribed to the layer1:digital:address:created event:

Address Created

{
    "event": "layer1:digital:address:created",
    "timestamp": "2024-05-30T20:03:54.075299611Z",
    "data": {
      "id": "d18a869f-1919-44a0-9e5e-784d7ca8f45a",
      "address": "0xc4b21fb39aaf5fc07d3cd4420bf3ee74a61642e9",
      "network": "ETHEREUM",
      "keyPairId": "44cf54df-93e9-4dd9-84c9-e96f0cf90f3e",
      "reference": "First Eth Address",
      "customerId": "customerOne",
      "assetPoolId": "2be1cc9c-a5af-47e2-9dba-b7b82317e600"
    }
  }

Field	Description
event	Event type that triggered the webhook
timestamp	Time when the event occurred in ISO 8601 format
data	Nested object containing the details of the created address
data.id	Unique identifier of the new address
data.address	Crypto address that was created
data.network	Blockchain network where the address is hosted
data.keyPairId	Unique identifier of the key pair
data.reference	Unique reference for the crypto address
data.customerId	Unique identifier of the customer
data.assetPoolId	Unique identifier of the asset pool

You can extract the address from data.address and show it to users, from which you expect deposits to be sent and who can the pay in the correct cryptocurrency.