Skip to main content
POST
/
v2
/
{plasticId}
Set PIN
curl --request POST \
  --url 'https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v2/{plasticId}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "zpkIndex": "0",
  "pinBlock": "0123456789ABCDEF"
}
'
{}

​
Example

// PIN 1234 in ISO format 1
var pinBlock = "141234AAAAAAAAAA";
// pre-shared zpk
var zpk = Hex.decode("00112233445566778899AABBCCDDEEFF0011223344556677");
// encrypt pinBlock with zpk
var des = Cipher.getInstance("DESede/ECB/NoPadding");
des.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(zpk, "DESede"));
var encryptedPinBlock = Hex.toHexString(des.doFinal(Hex.decode(pinBlock)));
// make request
pinApiClient.post()
        .uri("/pin/v2/{plasticId}?auditUser={user}", 123456, "test")
        .bodyValue(Map.of(
                "zpkIndex", "0",
                "pinBlock", encryptedPinBlock
        ))
        .retrieve()
        .bodyToMono(Object.class)
        .block();

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
plasticId
string<biginteger>
required

The plastic id for given card

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json

The related PIN control request data

​
zpkIndex
string
required

The PIN encryption key (ZPK) index. This index is used to point out which key to use in case there are multiple keys available.

Example:

"0"

​
pinBlock
string
required

ISO format 1 PIN block 3DES encrypted with PIN encryption key in hexadecimal.

Required string length: 16
Example:

"0123456789ABCDEF"

Response

PIN set successfully

The response is of type setPinResponse · object.