Accounts

Prepare account registration

Changed on

Returns a deposit address or the details needed to register the account. Existing account ownership, kind, and destination are immutable; a conflicting request is refused before session details are created.

post/setup-account

Request

Headers

x-api-keystring

API key for authentication

Example:your-api-key
x-api-versionstring

API version identifier (e.g. "2026-04.amazon"). Optional today, will become required in a future release.

Example:2026-04.amazon

Request body

ownerAddressstring required

Ethereum address (0x followed by 40 hex characters)

sessionOwnerAddressstring required

Ethereum address (0x followed by 40 hex characters)

targetTokenstring required
targetChainstring required

CAIP-2 chain identifier (e.g. "eip155:8453")

recipientstring

Address that receives the final tokens. Must not be a placeholder, burn or chain system address: the zero address, an address of one repeated hex digit (0x1111…, incl. HyperCore HYPE 0x2222…), 0x…dEaD, or a HyperCore token system address (0x20 followed by zeros and the token index). Such values are rejected with 400.

rejectUnmappedboolean
postBridgeActionsunknown
sessionScopesSessionScopes
signerAddressstring

Ethereum address (0x followed by 40 hex characters)

sessionChainIdsinteger[]
forceRegisterboolean

Example request

{
  "ownerAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "sessionOwnerAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "targetChain": "eip155:8453",
  "outputTokenRules": [
    {
      "match": {
        "symbol": "USDC"
      },
      "outputToken": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
    }
  ],
  "signerAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
}

Response

Account setup result

smartAccountstring required

Ethereum address (0x followed by 40 hex characters)

isRegisteredboolean required
targetChainstring
targetTokenstring
needsRegistrationboolean required
solanaDepositAddressstring

Example response

{
  "smartAccount": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "accountParams": {
    "factory": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "factoryData": "0x1234abcd"
  },
  "sessionDetailsUnsigned": {
    "hashesAndChainIds": [
      {
        "sessionDigest": "0x1234abcd"
      }
    ]
  }
}

Changes

    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      the header request parameter x-api-key became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status