SDK Explorer

Signs a transaction.

Parameters
input
object
Required

Represents the input to sign the EIP-191 message from a specified user-controlled wallet.

option 1:
userId
string
Required

Unique system-generated identifier for the user.

memo
string

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

rawTransaction
string

Raw transaction string that needs to be signed. Excluded with transaction. Required without transaction.

Required to be base64 encoded for NEAR, Solana chains. Required to be hex encoded for EVM chains.

transaction
string

Transaction object in JSON that needs to be signed. Excluded with rawTransaction. Required without rawTransaction.

NOTE: This field is only supported by EVM chains.

walletId
string
Required

System-generated unique identifier of the resource.

option 2:
userToken
string
Required

The JSON Web Token (JWT) representing the user.

memo
string

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

rawTransaction
string

Raw transaction string that needs to be signed. Excluded with transaction. Required without transaction.

Required to be base64 encoded for NEAR, Solana chains. Required to be hex encoded for EVM chains.

transaction
string

Transaction object in JSON that needs to be signed. Excluded with rawTransaction. Required without rawTransaction.

NOTE: This field is only supported by EVM chains.

walletId
string
Required

System-generated unique identifier of the resource.

Responses
Example
1const response = await client.signTransaction({
2  userToken: 'dummy-user-token',
3  walletId: 'wallet-id',
4  rawTransaction: 'raw-tx',
5  memo: 'Transfer',
6})
7console.log(response.data?.challengeId)
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.