Skip to main content
POST
/
v1
/
w3s
/
user
/
sign
/
message
Create a challenge to sign message
curl --request POST \
  --url https://api.circle.com/v1/w3s/user/sign/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-User-Token: <x-user-token>' \
  --data '{
  "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "encodedByHex": false,
  "message": "I agree with this transfer",
  "memo": "Transfer USDC to Sam"
}'
{
  "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

Sign message for end user request

​
walletId
string<uuid>
required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
message
string
required

The user friendly message that needs to be signed. If it is a hex string, encodedByHex needs to be TRUE. The hex string should start with “0x” and have even length.

Example:

"I agree with this transfer"

​
encodedByHex
boolean

Indicator of whether the input message is encoded by hex. If TRUE, then the message should be a hex string. By default, it is False.

Example:

false

​
memo
string

The human readable explanation for this sign action. Useful for presenting with extra information.

Example:

"Transfer USDC to Sam"

Response

Signature already exists

​
data
object
required