Spark claim transfer

Verify the sender’s signature, decrypt the leaf key ciphertext, derive the receiver’s new leaf key, and produce encrypted claim packages for Spark Operators — all inside the Turnkey enclave.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SPARK_CLAIM_TRANSFER

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.packageRequest · object · required

Wraps the claim descriptor.

Show packageRequest details

parameters.packageRequest.claim · object · required

The claim descriptor specifying the transfer to claim and the leaves to take ownership of.

Show claim details

parameters.packageRequest.claim.operatorRecipients · array · required

The Spark Operators that will receive the receiver’s encrypted claim tweak shares. Each operator’s share is ECIES-encrypted to its individual encryption public key.

Show item details

parameters.packageRequest.claim.leaves · array · required

The individual leaves being claimed. Each entry provides the ECIES-encrypted current leaf key (stored by the Spark Operators on the sender’s behalf) and the sender’s per-leaf authorization signature.

Show item details

generateAppProofs · boolean

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

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/spark_claim_transfer \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SPARK_CLAIM_TRANSFER",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<receiver-spark-address>",
        "packageRequest": {
            "claim": {
                "transferId": "<uuid>",
                "senderIdentityPublicKey": "<sender-identity-pubkey-hex>",
                "threshold": 2,
                "operatorRecipients": [
                    { "operatorId": "SO1", "encryptionPublicKey": "<so1-pubkey-hex>" },
                    { "operatorId": "SO2", "encryptionPublicKey": "<so2-pubkey-hex>" }
                ],
                "leaves": [
                    {
                        "leafId": "<leaf-id>",
                        "ciphertext": "<ecies-blob-hex>",
                        "senderSignature": "<compact-ecdsa-sig-hex>"
                    }
                ]
            }
        }
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SPARK_CLAIM_TRANSFER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "claimSparkTransferIntent": {
            "signWith": "<receiver-spark-address>",
            "packageRequest": "<object>"
          }
        },
        "result": {
          "claimSparkTransferResult": {
            "operatorPackages": [
              { "operatorId": "SO1", "encryptedPackage": "<hex>" },
              { "operatorId": "SO2", "encryptedPackage": "<hex>" }
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}