Tatum
Powered by Redocly

Key Management System

An endpoint used to handle operations connected to Tatum KMS. It provides a list of a pending transaction to sign, options to complete a transaction after signature, obtain transaction details with the result of the blockchain operation via transaction ID.
In the Tatum KMS tool, each managed wallet or private key is assigned a unique signature Id that represents the specific wallet / private key. This signature Id is then used in a request to identify specific wallet.
Tatum API accepts 3 representations of signature Ids in its requests:

  • signatureId represents mnemonic type of the wallet. In API calls like /v3/offchain/bitcoin/transfer, the signatureId present in the request should represent the mnemonic type of the wallet.
  • signatureId represents privateKey type of the wallet. In API calls like /v3/bitcoin/transaction, the signatureId present in the request should represent the private key type of the wallet.
  • signatureId represents mnemonic and index type of the wallet. In API calls like /v3/offchain/ethereum/transfer, in addition to the signatureId, there should be the index of the specific private key from the mnemonic to be used.

Get pending transactions to sign

1 credit per API call.


Get list of pending transaction to be signed and broadcast using Tatum KMS.

SecurityX-API-Key
Request
path Parameters
chain
required
string = 24 characters

Blockchain to get pending transactions for.

Enum: "BNB" "BTC" "ETH" "XLM" "XRP" "BCH" "LTC" "DOGE" "VET" "BSC" "ADA" "MATIC" "CELO" "FLOW" "TRON" "ONE" "XDC" "EGLD" "KLAY" "LUNA" "SOL"
query Parameters
signatures
string

Signature IDs of the KMS which invokes this endpoint. If multiple, they should be separated by comma.

Example: signatures=6d78dad2-518f-4e76-8255-8f1df0de6884,6d78dad2-518f-4e76-8255-8f1df0de6885,6d78dad2-518f-4e76-8255-8f1df0de6886
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

get/v3/kms/pending/{chain}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/kms/pending/{chain}?signatures=6d78dad2-518f-4e76-8255-8f1df0de6884%2C6d78dad2-518f-4e76-8255-8f1df0de6885%2C6d78dad2-518f-4e76-8255-8f1df0de6886' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Complete pending transaction to sign

2 credits per API call.


Mark pending transaction to sign as a complete and update it with a transactionID from the blockchain.

SecurityX-API-Key
Request
path Parameters
id
required
string = 24 characters

ID of pending transaction

Example: f91827364f91827364ajdur7
txId
required
string [ 10 .. 80 ] characters

transaction ID of blockchain transaction

Example: 0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326
Responses
204

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

put/v3/kms/{id}/{txId}
Request samples
curl -i -X PUT \
  'https://api-eu1.tatum.io/v3/kms/{id}/{txId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "errorCode": "validation.failed",
  • "message": "Request validation failed. Please see data for additional information.",
  • "statusCode": 400,
  • "data": [
    ]
}

Get transaction details

1 credit per API call.


Get detail of transaction to be signed / that was already signed and contains transactionId.

SecurityX-API-Key
Request
path Parameters
id
required
string = 24 characters

ID of transaction

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v3/kms/{id}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/kms/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "5e6645712b55823de7ea82f1",
  • "chain": "ETH",
  • "hashes": [
    ],
  • "serializedTransaction": "alskdjfq8o27fbkasljfbq8o7b4fqo83f7bqejhafbo8q4f",
  • "withdrawalId": "5e6645712b55823de7ea82f1",
  • "index": 1,
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
  • "withdrawalResponses": [
    ]
}

Delete transaction

2 credits per API call.


Delete transaction to be signed. When deleting offchain transaction, linked withdrawal will be cancelled automatically.

SecurityX-API-Key
Request
path Parameters
id
required
string = 24 characters

ID of transaction

query Parameters
revert
boolean
Default: true

Defines whether fee should be reverted to account balance as well as amount. Defaults to true. Revert true would be typically used when withdrawal was not broadcast to blockchain. False is used usually for Ethereum ERC20 based currencies.

Example: revert=true
Responses
204

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

delete/v3/kms/{id}
Request samples
curl -i -X DELETE \
  'https://api-eu1.tatum.io/v3/kms/{id}?revert=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "errorCode": "validation.failed",
  • "message": "Request validation failed. Please see data for additional information.",
  • "statusCode": 400,
  • "data": [
    ]
}
➔ Next to Malicious address