Skip to main content
POST
/
v1
/
w3s
/
user
/
initialize
Create a challenge for user initialization with wallet creation
curl --request POST \
  --url https://api.circle.com/v1/w3s/user/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-User-Token: <x-user-token>' \
  --data '{
  "idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "accountType": "SCA",
  "blockchains": [
    "ETH"
  ],
  "metadata": [
    {
      "name": "<string>",
      "refId": "custom_ref_id"
    }
  ]
}'
{
  "data": {
    "challengeId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-User-Token
string
required

Unique system generated JWT session token for specific user.

​
X-Request-Id
string

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

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Body

application/json

Request body

​
idempotencyKey
string<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.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
accountType
enum<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 and Aptos don't support Smart Contract Account (SCA).

Available options:
SCA,
EOA
​
blockchains
enum<string>[]

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

Minimum length: 1
Example:
["ETH"]
​
metadata
object[]

List of metadata fields to associate with the corresponding wallet.

Response

Returns the existing challenge if the idempotency key matches a previous successful request.

​
data
object
required
⌘I