API Reference

Create a challenge for user initialization with wallet creation

posthttps://api.circle.com/v1/w3s/user/initialize

  • Reference
  • Playground

Creates a challenge for user initialization and creates one or more wallets.

Header parameters
X-User-Token
string
Required

Unique system generated JWT session token for specific user.

Body parameters
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
blockchains
array of strings

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

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA
metadata
array of objects

List of metadata fields to associate with the corresponding wallet.

name
string

Name or description associated with the wallet or walletSet.

refId
string

Reference or description used to identify the object.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "challengeId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
4  }
5}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.