Create an address | Taurus Developer Hub

curl -X POST https://your-protect-instance.example.com/api/rest/v1/addresses \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "walletId": "66313",
  "label": "Address XYZ",
  "comment": "Deposit ABC",
  "customerId": "customerXYZ",
  "currency": "ETH"
}'

{
  "result": {
    "id": "232071",
    "walletId": "66313",
    "seed": "eth",
    "currency": "ETH",
    "addressPath": "m/44'/60'/84'/0'/0'",
    "address": "0x39c4622ac9704dfea991e9c26abcf9bde3c095ac",
    "comment": "Deposit ABC",
    "label": "Address XYZ",
    "customerId": "customerXYZ",
    "balance": {},
    "signature": "XXX",
    "creationDate": "2022-01-25T21:25:15.306338Z",
    "updateDate": "2022-01-25T21:25:15.306338Z",
    "walletInfo": {
      "id": "66313",
      "balance": {},
      "currency": "ETH",
      "coin": "ETH",
      "name": "Hot wallet XYZ",
      "seed": "eth",
      "accountPath": "m/44'/60'/84'",
      "creationDate": "2022-01-25T08:50:15.894917Z",
      "updateDate": "2022-01-25T08:50:15.894917Z",
      "comment": "Meant for XYZ process",
      "blockchain": "ETH"
    }
  }
}

Required role: AccountCreator. This endpoint creates a new address. Address creation requires HSM signature, which makes it synchronuous. Therefore, address creation can be slow and failure could happen if HSM is either unavailable or takes too long to process. If it happens, the API can be called again safely.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

walletIdstringRequiredformat: "uint64"

labelstringRequired

commentstringOptional

customerIdstringOptional

nonHardenedDerivationbooleanOptional

workchainIdintegerOptional

typestringOptional

externalAddressIdstringOptional

Identifier for the address in the user's system. This must be unique. Attempting to create an address with an existing externalAddressId will do nothing and return the originally created address

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error