Sign Raw Payload

Sign a raw payload

POST

/

public

/

v1

/

submit

/

sign_raw_payload

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_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

parameters field

Show details

parameters.signWith

string

required

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

parameters.payload

string

required

Raw unsigned payload to be signed.

parameters.encoding

enum<string>

required

Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8

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

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.signRawPayloadIntent

object

required

The signRawPayloadIntent object

Show signRawPayloadIntent details

activity.intent.signRawPayloadIntent.privateKeyId

string

required

Unique identifier for a given Private Key.

activity.intent.signRawPayloadIntent.payload

string

required

Raw unsigned payload to be signed.

activity.intent.signRawPayloadIntent.encoding

enum

required

encoding field

Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8

activity.intent.signRawPayloadIntent.hashFunction

enum

required

hashFunction field

Enum 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.signRawPayloadResult

object

required

The signRawPayloadResult object

Show signRawPayloadResult details

activity.result.signRawPayloadResult.r

string

required

Component of an ECSDA signature.

activity.result.signRawPayloadResult.s

string

required

Component of an ECSDA signature.

activity.result.signRawPayloadResult.v

string

required

Component of an ECSDA signature.

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "signRawPayloadIntent": {
            "privateKeyId": "<string>",
            "payload": "<string>",
            "encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
            "hashFunction": "<HASH_FUNCTION_NO_OP>"
          }
        },
        "result": {
          "signRawPayloadResult": {
            "r": "<string>",
            "s": "<string>",
            "v": "<string>"
          }
        }
      }
    }
  }
}