Creating account address

POST /api/public/v1/accounts/:id/addresses

Creates a receiving address on the given account for the specified network.

This request is asynchronous. The address is registered immediately, but its value is generated shortly afterwards — the create response returns value: null. Poll Listing account addresses to retrieve the final address value.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Path Parameters

Name	Type	Description
id	string	Account ID.

Body

Name	Type	Description
data	object	Request data object.
data.type	string	Resource type. Always addresses.
data.attributes	object	Address attributes.
data.attributes.network_id	string	ID of the network to generate the address on. Must belong to the account's currency. Read the account to list its available networks — see Reading account.
data.attributes.label	string	Address label. Use any value that helps you recognize the address later.

Request JSON

{
  "data": {
    "type": "addresses",
    "attributes": {
      "network_id": "string",
      "label": "string"
    }
  }
}

Response

HTTP 200

{
  "data": {
    "id": "0a37e656-fdca-4afb-b78e-992a38279c9d",
    "type": "addresses",
    "attributes": {
      "label": "New Label",
      "value": null,
      "createdAt": "2025-05-29T18:15:35.492Z"
    },
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "network": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

HTTP 422

{
  "errors": [
    {
      "status": 422,
      "title": "Invalid attribute",
      "code": "address_invalid",
      "detail": "Network does not match account currency",
      "source": {
        "pointer": "/data/attributes/networkId"
      }
    }
  ]
}

HTTP 404

{
  "errors": [
    {
      "status": 404,
      "title": "Record not found",
      "code": "network_not_found",
      "detail": "Network not found"
    }
  ]
}

The network_id does not match a known network.

Response Body

Name	Type	Description
data.id	string	Address ID.
data.type	string	Entity type returned. Always addresses.
data.attributes.label	string	Address label, as set in the request.
data.attributes.value	string	The address string. null in this response — generated asynchronously. Retrieve it via Listing account addresses.
data.attributes.createdAt	string	ISO 8601 timestamp of when the address was created.
data.relationships.account	object	The account the address belongs to.
data.relationships.network	object	The network the address was generated on.