kmd REST Models

APIV1DELETEKeyResponse

APIV1DELETEKeyResponse is the response to DELETE /v1/key friendly:DeleteKeyResponse
error (optional)
Boolean
message (optional)
String

APIV1DELETEMultisigResponse

APIV1DELETEMultisigResponse is the response to POST /v1/multisig/delete` friendly:DeleteMultisigResponse
error (optional)
Boolean
message (optional)
String

APIV1GETWalletsResponse

APIV1GETWalletsResponse is the response to GET /v1/wallets friendly:ListWalletsResponse
error (optional)
Boolean
message (optional)
String
wallets (optional)

APIV1POSTKeyExportResponse

APIV1POSTKeyExportResponse is the reponse to POST /v1/key/export friendly:ExportKeyResponse
error (optional)
Boolean
message (optional)
String
private_key (optional)
byte[] format: binary

APIV1POSTKeyImportResponse

APIV1POSTKeyImportResponse is the repsonse to POST /v1/key/import friendly:ImportKeyResponse
address (optional)
String
error (optional)
Boolean
message (optional)
String

APIV1POSTKeyListResponse

APIV1POSTKeyListResponse is the response to POST /v1/key/list friendly:ListKeysResponse
addresses (optional)
array[String]
error (optional)
Boolean
message (optional)
String

APIV1POSTKeyResponse

APIV1POSTKeyResponse is the response to POST /v1/key friendly:GenerateKeyResponse
address (optional)
String
error (optional)
Boolean
message (optional)
String

APIV1POSTMasterKeyExportResponse

APIV1POSTMasterKeyExportResponse is the reponse to POST /v1/master-key/export friendly:ExportMasterKeyResponse
error (optional)
Boolean
master_derivation_key (optional)
byte[] format: binary
message (optional)
String

APIV1POSTMultisigExportResponse

APIV1POSTMultisigExportResponse is the response to POST /v1/multisig/export friendly:ExportMultisigResponse
error (optional)
Boolean
message (optional)
String
multisig_version (optional)
Integer format: uint8
pks (optional)
array[byte[]] format: binary
threshold (optional)
Integer format: uint8

APIV1POSTMultisigImportResponse

APIV1POSTMultisigImportResponse is the response to POST /v1/multisig/import friendly:ImportMultisigResponse
address (optional)
String
error (optional)
Boolean
message (optional)
String

APIV1POSTMultisigListResponse

APIV1POSTMultisigListResponse is the response to POST /v1/multisig/list friendly:ListMultisigResponse
addresses (optional)
array[String]
error (optional)
Boolean
message (optional)
String

APIV1POSTMultisigTransactionSignResponse

APIV1POSTMultisigTransactionSignResponse is the response to POST /v1/multisig/sign friendly:SignMultisigResponse
error (optional)
Boolean
message (optional)
String
multisig (optional)
byte[] format: binary

APIV1POSTTransactionSignResponse

APIV1POSTTransactionSignResponse is the repsonse to POST /v1/transaction/sign friendly:SignTransactionResponse
error (optional)
Boolean
message (optional)
String
signed_transaction (optional)
byte[] format: binary

APIV1POSTWalletInfoResponse

APIV1POSTWalletInfoResponse is the response to POST /v1/wallet/info friendly:WalletInfoResponse
error (optional)
Boolean
message (optional)
String
wallet_handle (optional)

APIV1POSTWalletInitResponse

APIV1POSTWalletInitResponse is the response to POST /v1/wallet/init friendly:InitWalletHandleTokenResponse
error (optional)
Boolean
message (optional)
String
wallet_handle_token (optional)
String

APIV1POSTWalletReleaseResponse

APIV1POSTWalletReleaseResponse is the response to POST /v1/wallet/release friendly:ReleaseWalletHandleTokenResponse
error (optional)
Boolean
message (optional)
String

APIV1POSTWalletRenameResponse

APIV1POSTWalletRenameResponse is the response to POST /v1/wallet/rename friendly:RenameWalletResponse
error (optional)
Boolean
message (optional)
String
wallet (optional)

APIV1POSTWalletRenewResponse

APIV1POSTWalletRenewResponse is the response to POST /v1/wallet/renew friendly:RenewWalletHandleTokenResponse
error (optional)
Boolean
message (optional)
String
wallet_handle (optional)

APIV1POSTWalletResponse

APIV1POSTWalletResponse is the response to POST /v1/wallet friendly:CreateWalletResponse
error (optional)
Boolean
message (optional)
String
wallet (optional)

APIV1Request

APIV1Request is the interface that all API V1 requests must satisfy
 

APIV1RequestEnvelope

APIV1RequestEnvelope is a common envelope that all API V1 requests must embed
 

APIV1Wallet

APIV1Wallet is the API's representation of a wallet
driver_name (optional)
String
driver_version (optional)
Integer format: uint32
id (optional)
String
mnemonic_ux (optional)
Boolean
name (optional)
String
supported_txs (optional)

APIV1WalletHandle

APIV1WalletHandle includes the wallet the handle corresponds to and the number of number of seconds to expiration
expires_seconds (optional)
Long format: int64
wallet (optional)

CreateWalletRequest

APIV1POSTWalletRequest is the request for POST /v1/wallet
master_derivation_key (optional)
byte[] format: binary
wallet_driver_name (optional)
String
wallet_name (optional)
String
wallet_password (optional)
String

DeleteKeyRequest

APIV1DELETEKeyRequest is the request for DELETE /v1/key
address (optional)
String
wallet_handle_token (optional)
String
wallet_password (optional)
String

DeleteMultisigRequest

APIV1DELETEMultisigRequest is the request for DELETE /v1/multisig
address (optional)
String
wallet_handle_token (optional)
String
wallet_password (optional)
String

ExportKeyRequest

APIV1POSTKeyExportRequest is the request for POST /v1/key/export
address (optional)
String
wallet_handle_token (optional)
String
wallet_password (optional)
String

ExportMasterKeyRequest

APIV1POSTMasterKeyExportRequest is the request for POST /v1/master-key/export
wallet_handle_token (optional)
String
wallet_password (optional)
String

ExportMultisigRequest

APIV1POSTMultisigExportRequest is the request for POST /v1/multisig/export
address (optional)
String
wallet_handle_token (optional)
String

GenerateKeyRequest

APIV1POSTKeyRequest is the request for POST /v1/key
display_mnemonic (optional)
Boolean
wallet_handle_token (optional)
String

ImportKeyRequest

APIV1POSTKeyImportRequest is the request for POST /v1/key/import
private_key (optional)
wallet_handle_token (optional)
String

ImportMultisigRequest

APIV1POSTMultisigImportRequest is the request for POST /v1/multisig/import
multisig_version (optional)
Integer format: uint8
pks (optional)
threshold (optional)
Integer format: uint8
wallet_handle_token (optional)
String

InitWalletHandleTokenRequest

APIV1POSTWalletInitRequest is the request for POST /v1/wallet/init
wallet_id (optional)
String
wallet_password (optional)
String

ListKeysRequest

APIV1POSTKeyListRequest is the request for POST /v1/key/list
wallet_handle_token (optional)
String

ListMultisigRequest

APIV1POSTMultisigListRequest is the request for POST /v1/multisig/list
wallet_handle_token (optional)
String

ListWalletsRequest

APIV1GETWalletsRequest is the request for GET /v1/wallets
 

MultisigSig

MultisigSig is the structure that holds multiple Subsigs
Subsigs (optional)
Threshold (optional)
Integer format: uint8
Version (optional)
Integer format: uint8

MultisigSubsig

MultisigSubsig is a struct that holds a pair of public key and signatures signatures may be empty
Key (optional)
Sig (optional)

PrivateKey

 
 

PublicKey

 
 

ReleaseWalletHandleTokenRequest

APIV1POSTWalletReleaseRequest is the request for POST /v1/wallet/release
wallet_handle_token (optional)
String

RenameWalletRequest

APIV1POSTWalletRenameRequest is the request for POST /v1/wallet/rename
wallet_id (optional)
String
wallet_name (optional)
String
wallet_password (optional)
String

RenewWalletHandleTokenRequest

APIV1POSTWalletRenewRequest is the request for POST /v1/wallet/renew
wallet_handle_token (optional)
String

SignMultisigRequest

APIV1POSTMultisigTransactionSignRequest is the request for POST /v1/multisig/sign
partial_multisig (optional)
public_key (optional)
transaction (optional)
byte[] format: binary
wallet_handle_token (optional)
String
wallet_password (optional)
String

SignTransactionRequest

APIV1POSTTransactionSignRequest is the request for POST /v1/transaction/sign
transaction (optional)
byte[] format: binary
wallet_handle_token (optional)
String
wallet_password (optional)
String

Signature

 
 

TxType

TxType is the type of the transaction written to the ledger
 

VersionsRequest

VersionsRequest is the request for GET /versions
 

VersionsResponse

VersionsResponse is the response to GET /versions friendly:VersionsResponse
versions (optional)
array[String]

WalletInfoRequest

APIV1POSTWalletInfoRequest is the request for POST /v1/wallet/info
wallet_handle_token (optional)
String