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:
Get list of pending transaction to be signed and broadcast using Tatum KMS.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
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'
[- {
- "id": "5e6645712b55823de7ea82f1",
- "chain": "ETH",
- "hashes": [
- "1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb"
], - "serializedTransaction": "alskdjfq8o27fbkasljfbq8o7b4fqo83f7bqejhafbo8q4f",
- "withdrawalId": "5e6645712b55823de7ea82f1",
- "index": 1,
- "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
- "withdrawalResponses": [
- {
- "address": {
- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}, - "amount": 0,
- "vIn": "string",
- "vInIndex": 0,
- "scriptPubKey": "string"
}
]
}
]
Mark pending transaction to sign as a complete and update it with a transactionID from the blockchain.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
curl -i -X PUT \ 'https://api-eu1.tatum.io/v3/kms/{id}/{txId}' \ -H 'x-api-key: YOUR_API_KEY_HERE'
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}
Get detail of transaction to be signed / that was already signed and contains transactionId.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
curl -i -X GET \ 'https://api-eu1.tatum.io/v3/kms/{id}' \ -H 'x-api-key: YOUR_API_KEY_HERE'
{- "id": "5e6645712b55823de7ea82f1",
- "chain": "ETH",
- "hashes": [
- "1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb"
], - "serializedTransaction": "alskdjfq8o27fbkasljfbq8o7b4fqo83f7bqejhafbo8q4f",
- "withdrawalId": "5e6645712b55823de7ea82f1",
- "index": 1,
- "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
- "withdrawalResponses": [
- {
- "address": {
- "address": "7c21ed165e294db78b95f0f181086d6f",
- "currency": "BTC",
- "derivationKey": 2147483647,
- "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
- "destinationTag": 5,
- "memo": "5",
- "message": "5"
}, - "amount": 0,
- "vIn": "string",
- "vInIndex": 0,
- "scriptPubKey": "string"
}
]
}
Delete transaction to be signed. When deleting offchain transaction, linked withdrawal will be cancelled automatically.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
curl -i -X DELETE \ 'https://api-eu1.tatum.io/v3/kms/{id}?revert=true' \ -H 'x-api-key: YOUR_API_KEY_HERE'
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}