createWallet

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Create wallets

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

Generates a new developer-controlled wallet or batch of wallets within a wallet set, specifying blockchain and wallet name.

Header parameters

X-Request-Id

string

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

Body parameters

walletSetId

uuid7

Required

System-generated unique identifier of the resource.

entitySecretCiphertext

byte

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

Required

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

idempotencyKey

uuid

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).

count

integer

1 to 200

Number of wallets that will be created per specified blockchain.

metadata

array

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.

Response

200WalletsResponse

Response Body

object

data

object

Required

Show 1 properties

wallets

array of objects

Required

option 1: EOAWallet

Show 12 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain address of the wallet.

blockchain

string

Required

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

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.

name

string

Optional name or description associated with the wallet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

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).

option 2: SCAWallet

Show 13 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain address of the wallet.

blockchain

string

Required

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

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.

name

string

Optional name or description associated with the wallet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

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).

scaCore

string

Required

SCAs can have different versions that have different functionality. SCACore will display the version of the SCA being created. Please refer to developer docs for a list of the versions supported.

400BadRequestResponse

401NotAuthorizedResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "wallets": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "address": "",
7        "blockchain": "MATIC-AMOY",
8        "createDate": "2023-01-01T12:04:05Z",
9        "updateDate": "2023-01-01T12:04:05Z",
10        "custodyType": "DEVELOPER",
11        "name": "my wallet",
12        "refId": "custom_ref_id",
13        "state": "LIVE",
14        "userId": "ext_user_id_1",
15        "walletSetId": "0192295a-3b32-76d7-b17e-7fcf263165a0",
16        "accountType": "EOA"
17      }
18    ]
19  }
20}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy