We refreshed our doc site!

Bookmarked links may have changed

Read release notes

signUserMessage

Web3 Services
Compliance Engine

Create a challenge to sign message

POSThttps://api.circle.com/v1/w3s/user/sign/message

Generates a challenge for signing the EIP-191 message from a specified user-controlled wallet. Please note that not all the Dapps currently support Smart Contract Account (SCA), the difference between EOA and SCA can be found in the account types guide, and you can check the list of Dapps that support SCA: https://eip1271.io/.

Header parameters
X-User-Token
string
Required

Unique system generated JWT session token for specific user.

Body parameters
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.

walletId
uuid
Required

System-generated unique identifier of the resource.

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.

memo
string

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

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-2024 Circle Technology Services, LLC. All rights reserved.