Sign raw payloads

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/sign_raw_payloads \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "payloads": [
            "<string>"
        ],
        "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
        "hashFunction": "<HASH_FUNCTION_NO_OP>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "signRawPayloadsIntent": {
            "signWith": "<string>",
            "payloads": [
              "<string>"
            ],
            "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
            "hashFunction": "<HASH_FUNCTION_NO_OP>"
          }
        },
        "result": {
          "signRawPayloadsResult": {
            "signatures": [
              {
                "r": "<string>",
                "s": "<string>",
                "v": "<string>"
              }
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/sign_raw_payloads \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "payloads": [
            "<string>"
        ],
        "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
        "hashFunction": "<HASH_FUNCTION_NO_OP>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "signRawPayloadsIntent": {
            "signWith": "<string>",
            "payloads": [
              "<string>"
            ],
            "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
            "hashFunction": "<HASH_FUNCTION_NO_OP>"
          }
        },
        "result": {
          "signRawPayloadsResult": {
            "signatures": [
              {
                "r": "<string>",
                "s": "<string>",
                "v": "<string>"
              }
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

sign_raw_payloads

Authorizations

X-Stamp

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_RAW_PAYLOADS

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.payloads

array

required

An array of raw unsigned payloads to be signed.

Show item details

Array item type: string

item field

parameters.encoding

enum<string>

required

Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8, PAYLOAD_ENCODING_EIP712

parameters.hashFunction

enum<string>

required

Enum options: HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE

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.signRawPayloadsIntent

object

required

The signRawPayloadsIntent object

Show signRawPayloadsIntent details

activity.intent.signRawPayloadsIntent.signWith

string

required

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

activity.intent.signRawPayloadsIntent.payloads

array

required

An array of raw unsigned payloads to be signed.

Show payloads details

activity.intent.signRawPayloadsIntent.payloads.item

string

required

item field

activity.intent.signRawPayloadsIntent.encoding

enum

required

encoding fieldEnum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8, PAYLOAD_ENCODING_EIP712

activity.intent.signRawPayloadsIntent.hashFunction

enum

required

hashFunction fieldEnum options: HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE

activity.result

object

required

The result of the activity

Show result details

activity.result.signRawPayloadsResult

object

required

The signRawPayloadsResult object

Show signRawPayloadsResult details

activity.result.signRawPayloadsResult.signatures

array

signatures field

Show signatures details

activity.result.signRawPayloadsResult.signatures.r

string

required

Component of an ECSDA signature.

activity.result.signRawPayloadsResult.signatures.s

string

required

Component of an ECSDA signature.

activity.result.signRawPayloadsResult.signatures.v

string

required

Component of an ECSDA signature.

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 --request POST \
  --url https://api.turnkey.com/public/v1/submit/sign_raw_payloads \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "payloads": [
            "<string>"
        ],
        "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
        "hashFunction": "<HASH_FUNCTION_NO_OP>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "signRawPayloadsIntent": {
            "signWith": "<string>",
            "payloads": [
              "<string>"
            ],
            "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
            "hashFunction": "<HASH_FUNCTION_NO_OP>"
          }
        },
        "result": {
          "signRawPayloadsResult": {
            "signatures": [
              {
                "r": "<string>",
                "s": "<string>",
                "v": "<string>"
              }
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

Sign raw payload Sign transaction

Activities

Queries

Sign raw payloads

Authorizations

Body

Response