Computes the KCV of the input and returns. This is only valid for AES, DES & DES3 keys.

Prev Next
Post
/crypto/v1/keys/kcv

Computes the KCV of the input and returns. This is only valid for AES, DES & DES3 keys.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Body parameters
Expand All
kcv_method
string

Methods for calculating a Key Checksum Value.

Valid values[ "Encrypt", "Cmac" ]
OneOf
SobjectDescriptorVariantKid
object (SobjectDescriptorVariantKid)
kid
string (uuid) Required
SobjectDescriptorVariantName
object (SobjectDescriptorVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
SobjectDescriptorVariantTransientKey
object (SobjectDescriptorVariantTransientKey)
transient_key
string (byte) Required
SobjectDescriptorVariantInline
object (SobjectDescriptorVariantInline)
inline
object Required
value
string (byte) Required
obj_type
string Required

Type of security object.

Valid values[ "AES", "ARIA", "DES", "DES3", "SEED", "RSA", "DSA", "EC", "KCDSA", "ECKCDSA", "BIP32", "BLS", "OPAQUE", "HMAC", "LEDABETA", "ROUND5BETA", "SECRET", "LMS", "XMSS", "MLDSA", "MLDSABETA", "MLKEM", "MLKEMBETA", "CERTIFICATE", "PBE" ]
Responses
2XX

Success result

object
kid
string (uuid) | null

UUID, only for persistent keys

kcv
string

Key Checksum Value. Could be one of following two variants:

  • Encrypt KCV: 24-bit checksum as a 6-character case-insensitive hex string (Default)
  • Cmac KCV: 40-bit checksum as a 10-character case-insensitive hex string