Sign transaction

Sign a transaction.

POST

/

public

/

v1

/

submit

/

sign_transaction

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SIGN_TRANSACTION_V2

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.signWith

string

required

A Wallet account address, Private Key address, or Private Key identifier.

parameters.unsignedTransaction

string

required

Raw unsigned transaction to be signed

parameters.type

enum<string>

required

Enum options: TRANSACTION_TYPE_ETHEREUM, TRANSACTION_TYPE_SOLANA, TRANSACTION_TYPE_TRON, TRANSACTION_TYPE_BITCOIN

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.signTransactionIntentV2

object

required

The signTransactionIntentV2 object

Show signTransactionIntentV2 details

activity.intent.signTransactionIntentV2.signWith

string

required

A Wallet account address, Private Key address, or Private Key identifier.

activity.intent.signTransactionIntentV2.unsignedTransaction

string

required

Raw unsigned transaction to be signed

activity.intent.signTransactionIntentV2.type

enum

required

type field

Enum options: TRANSACTION_TYPE_ETHEREUM, TRANSACTION_TYPE_SOLANA, TRANSACTION_TYPE_TRON, TRANSACTION_TYPE_BITCOIN

activity.result

object

required

The result of the activity

Show result details

activity.result.signTransactionResult

object

required

The signTransactionResult object

Show signTransactionResult details

activity.result.signTransactionResult.signedTransaction

string

required

signedTransaction field

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/sign_transaction \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SIGN_TRANSACTION_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "unsignedTransaction": "<string>",
        "type": "<TRANSACTION_TYPE_ETHEREUM>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().signTransaction({
  signWith: "<string> (A Wallet account address, Private Key address, or Private Key identifier.)",
  unsignedTransaction: "<string> (Raw unsigned transaction to be signed)",
  type: "<TRANSACTION_TYPE_ETHEREUM>" // type field
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SIGN_TRANSACTION_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "signTransactionIntentV2": {
            "signWith": "<string>",
            "unsignedTransaction": "<string>",
            "type": "<TRANSACTION_TYPE_ETHEREUM>"
          }
        },
        "result": {
          "signTransactionResult": {
            "signedTransaction": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}