PaymentCryptographyDataPlane / Client / verify_pin_data

verify_pin_data#

PaymentCryptographyDataPlane.Client.verify_pin_data(**kwargs)#

Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.

This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

Cross-account use: This operation can’t be used across different Amazon Web Services accounts.

Related operations:

GeneratePinData
TranslatePinData

Request Syntax

response = client.verify_pin_data(
    DukptAttributes={
        'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
        'KeySerialNumber': 'string'
    },
    EncryptedPinBlock='string',
    EncryptionKeyIdentifier='string',
    PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_3',
    PinDataLength=123,
    PrimaryAccountNumber='string',
    VerificationAttributes={
        'Ibm3624Pin': {
            'DecimalizationTable': 'string',
            'PinOffset': 'string',
            'PinValidationData': 'string',
            'PinValidationDataPadCharacter': 'string'
        },
        'VisaPin': {
            'PinVerificationKeyIndex': 123,
            'VerificationValue': 'string'
        }
    },
    VerificationKeyIdentifier='string'
)

Parameters:

DukptAttributes (dict) –
The attributes and values for the DUKPT encrypted PIN block data.
- DukptDerivationType (string) – [REQUIRED]
  
  The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can’t use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
- KeySerialNumber (string) – [REQUIRED]
  
  The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
EncryptedPinBlock (string) –
[REQUIRED]

The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
EncryptionKeyIdentifier (string) –
[REQUIRED]

The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
PinBlockFormat (string) –
[REQUIRED]

The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
PinDataLength (integer) – The length of PIN being verified.
PrimaryAccountNumber (string) –
[REQUIRED]

The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
VerificationAttributes (dict) –
[REQUIRED]

The attributes and values for PIN data verification.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Ibm3624Pin, VisaPin.
- Ibm3624Pin (dict) –
  
  Parameters that are required to generate or verify Ibm3624 PIN.
  - DecimalizationTable (string) – [REQUIRED]
    
    The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
  - PinOffset (string) – [REQUIRED]
    
    The PIN offset value.
  - PinValidationData (string) – [REQUIRED]
    
    The unique data for cardholder identification.
  - PinValidationDataPadCharacter (string) – [REQUIRED]
    
    The padding character for validation data.
- VisaPin (dict) –
  
  Parameters that are required to generate or verify Visa PIN.
  - PinVerificationKeyIndex (integer) – [REQUIRED]
    
    The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
  - VerificationValue (string) – [REQUIRED]
    
    Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
VerificationKeyIdentifier (string) –
[REQUIRED]

The keyARN of the PIN verification key.

Return type:

dict

Returns:

Response Syntax

{
    'EncryptionKeyArn': 'string',
    'EncryptionKeyCheckValue': 'string',
    'VerificationKeyArn': 'string',
    'VerificationKeyCheckValue': 'string'
}

Response Structure

(dict) –
- EncryptionKeyArn (string) –
  
  The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
- EncryptionKeyCheckValue (string) –
  
  The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
- VerificationKeyArn (string) –
  
  The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
- VerificationKeyCheckValue (string) –
  
  The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

Exceptions

PaymentCryptographyDataPlane.Client.exceptions.ValidationException
PaymentCryptographyDataPlane.Client.exceptions.VerificationFailedException
PaymentCryptographyDataPlane.Client.exceptions.AccessDeniedException
PaymentCryptographyDataPlane.Client.exceptions.ResourceNotFoundException
PaymentCryptographyDataPlane.Client.exceptions.ThrottlingException
PaymentCryptographyDataPlane.Client.exceptions.InternalServerException