Key Management System

Get pending transactions to sign

/v3/kms/pending/{chain}

1 credit for every 500 signature IDs per API call

Get the list of pending transactions to sign and broadcast using KMS.

NOTE: This API works only in KMS v5.0 or later. If you use KMS older than v5.0, use this API instead.

post/v3/kms/pending/{chain}

Request

Base URL
https://api.tatum.io
URL
https://api.tatum.io/v3/kms/pending/{chain}
Auth
API key in header x-api-key

Path parameters

chain'ADA' | 'BNB' | 'BTC' | 'ETH' | 'XLM' | 'XRP' | 'BCH' | 'LTC' | 'DOGE' | 'VET' | 'BSC' | 'MATIC' | 'CELO' | 'TRON' | 'ONE' | 'XDC' | 'EGLD' | 'KLAY' | 'SOL' required

Blockchain to get pending transactions for.

Request body

signatureIdsstring[]

List of the signature Ids to be used to sign transactions.

Example request

{
  "signatureIds": [
    "6d78dad2-518f-4e76-8255-8f1df0de6886",
    "26d3883e-4e17-48b3-a0ee-09a3e484ac83"
  ]
}

Response

idstring required

ID of the pending transaction

chain'BNB' | 'BTC' | 'ETH' | 'XLM' | 'XRP' | 'BCH' | 'LTC' | 'DOGE' | 'VET' | 'BSC' | 'MATIC' | 'CELO' | 'TRON' | 'ONE' | 'XDC' | 'EGLD' | 'KLAY' | 'SOL' | 'ADA' required

Blockchain of the transaction

hashesstring[] required

List of the signature Ids to be used to sign transaction. Those hashes should be in order of signing for the BTC, LTC or BCH blockchains.

serializedTransactionstring required

Serialized data of the transaction to be signed. It can be JSON, HEX or any other representation based on the blockchain.

withdrawalIdstring

ID of the pending off-chain withdrawal connected to this transaction

indexnumber

In case of mnemonic type of signature Id, this is the index to the specific account that should be used for signature.

txIdstring

TX hash of successful transaction.

Example response

[
  {
    "id": "5e6645712b55823de7ea82f1",
    "chain": "ETH",
    "hashes": [
      "1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb"
    ],
    "serializedTransaction": "alskdjfq8o27fbkasljfbq8o7b4fqo83f7bqejhafbo8q4f",
    "withdrawalId": "5e6645712b55823de7ea82f1",
    "index": 1,
    "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
    "withdrawalResponses": [
      {
        "address": {
          "address": "7c21ed165e294db78b95f0f181086d6f",
          "currency": "BTC",
          "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
          "destinationTag": 5,
          "memo": "5",
          "message": "5"
        }
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.