Documentation Index
Fetch the complete documentation index at: https://turnkey-0e7c1f5b-amir-tx-status-webhooks.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API Key
WebAuthn (Passkey)
Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here.
Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here.
Body
Enum options: ACTIVITY_TYPE_SIGN_RAW_PAYLOADS
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
The parameters object containing the specific intent data for this activity.
A Wallet account address, Private Key address, or Private Key identifier.
An array of raw unsigned payloads to be signed.
Array item type: string
item field
Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8, PAYLOAD_ENCODING_EIP712, PAYLOAD_ENCODING_EIP7702_AUTHORIZATION
Enum options: HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE
Enable to have your activity generate and return App Proofs, enabling verifiability.
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Unique identifier for a given Activity object.
Unique identifier for a given Organization.
The intent of the activity
activity.intent.signRawPayloadsIntent
The signRawPayloadsIntent objectShow signRawPayloadsIntent details
activity.intent.signRawPayloadsIntent.signWith
A Wallet account address, Private Key address, or Private Key identifier.
activity.intent.signRawPayloadsIntent.payloads
An array of raw unsigned payloads to be signed.
activity.intent.signRawPayloadsIntent.payloads.item
activity.intent.signRawPayloadsIntent.encoding
encoding fieldEnum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8, PAYLOAD_ENCODING_EIP712, PAYLOAD_ENCODING_EIP7702_AUTHORIZATION
activity.intent.signRawPayloadsIntent.hashFunction
hashFunction fieldEnum options: HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE
The result of the activity
activity.result.signRawPayloadsResult
The signRawPayloadsResult objectShow signRawPayloadsResult details
activity.result.signRawPayloadsResult.signatures
signatures field
activity.result.signRawPayloadsResult.signatures.r
Component of an ECSDA signature.
activity.result.signRawPayloadsResult.signatures.s
Component of an ECSDA signature.
activity.result.signRawPayloadsResult.signatures.v
Component of an ECSDA signature.
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.
An artifact verifying a User’s action.
Whether the activity can be approved.
Whether the activity can be rejected.
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>"
}
}
}
}