API Reference

Create wallets

posthttps://api.circle.com/v1/w3s/developer/wallets

Reference
Playground

Creates a new developer-controlled wallet or a batch of wallets within a wallet set, given the target blockchain and wallet name.

Note: Each walletSetId supports a maximum of 10 million wallets.

Header parameters

X-Request-Id

string

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

Body parameters

walletSetId

string

Required

System-generated unique identifier of the resource.

entitySecretCiphertext

string

Required

A base64 string expression of the entity secret ciphertext. The entity secret should be encrypted by the entity public key. Circle mandates that the entity secret ciphertext is unique for each API request.

blockchains

array of strings

Required

Blockchain(s) the requested wallets will be created on.

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

idempotencyKey

string

Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.

accountType

string

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 valuesSCAEOA

count

integer

Number of wallets that will be created per specified blockchain.

metadata

array of objects

List of metadata fields to associate with the corresponding wallet. If count is specified, the amount of items in the array should match the count field.

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

200WalletsResponse

Response Body

object

data

object

Required

Show 1 properties

wallets

array of objects

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

201WalletsResponse

Response Body

object

data

object

Required

Show 1 properties

wallets

array of objects

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

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy