API Reference

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Circle Contracts

Templates

View / Update

Interact

Deploy / Import

Event Monitors

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Derive a wallet

puthttps://api.circle.com/v1/w3s/developer/wallets/{id}/blockchains/{blockchain}

Reference
Playground

Derives an EOA (Externally Owned Account) or SCA (Smart Contract Account) wallet using the address of the specified wallet and blockchain. If the target wallet already exists, its metadata will be updated with the provided metadata. This operation is only supported for EVM-based blockchains.

Header parameters

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Path parameters

blockchain

string

Required

The unique identifier of the blockchains.

uuid

Required

The universally unique identifier of the resource.

Body parameters

metadata

object

Show 2 properties

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

Response

200WalletResponse

Response Body

object

data

object

Required

Show 1 properties

wallet

object

Required

option 1: EOAWallet

Show 13 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesEOA

option 2: SCAWallet

Show 14 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesSCA

scaCore

string

Required

SCAs have different versions, each with unique functionality. SCACore displays the version of the SCA being created. For a list of supported versions, refer to the developer documentation.

Allowed valuescircle_4337_v1circle_6900_singleowner_v1circle_6900_singleowner_v2circle_6900_singleowner_v3

201WalletResponse

Response Body

object

data

object

Required

Show 1 properties

wallet

object

Required

option 1: EOAWallet

Show 13 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesEOA

option 2: SCAWallet

Show 14 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesSCA

scaCore

string

Required

SCAs have different versions, each with unique functionality. SCACore displays the version of the SCA being created. For a list of supported versions, refer to the developer documentation.

Allowed valuescircle_4337_v1circle_6900_singleowner_v1circle_6900_singleowner_v2circle_6900_singleowner_v3

400BadRequestResponse

401NotAuthorizedResponse

404NotFoundResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "wallet": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
6      "blockchain": "MATIC-AMOY",
7      "createDate": "2023-01-01T12:04:05Z",
8      "updateDate": "2023-01-01T12:04:05Z",
9      "custodyType": "DEVELOPER",
10      "name": "",
11      "refId": "custom_ref_id",
12      "state": "LIVE",
13      "userId": "ext_user_id_1",
14      "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
15      "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
16      "accountType": "EOA"
17    }
18  }
19}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy