Set PIN

This operation sets the card PIN. Provided PIN must be in ISO format 1 and encrypted with the tzpk received from the “Get tzpk” API call.

Example flow

Step 1, executed on the CARD-HOLDER DEVICE, encrypting the PIN block with the TZPK

// PIN 1234 in ISO format 1 (xxYYYYxxxxxxxxxx) where YYYY is the PIN var pinBlock = “141234AAAAAAAAAA”; // encrypt pinBlock with previously received tzpk var des = Cipher.getInstance(“DESede/ECB/NoPadding”); des.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(tzpk, “DESede”)); var encryptedPinBlock = des.doFinal(Hex.decode(pinBlock.getBytes()));

Step 2, executed on the CLIENT BACK-END, sending the encrypted PIN block recieved from the device, to the API

// var encryptedPinBlock = // Received from the device // make request pinApiClient.post() .uri(“/pin/v3/set?auditUser=”, “test”) .bodyValue(Map.of( “controlId”, controlId, “pinBlock”, Base64.getEncoder().encodeToString(encryptedPinBlock) )) .retrieve() .bodyToMono(Object.class) .block();

POST

set

Set PIN

curl --request POST \
  --url 'https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "controlId": "83fa5f55-3dd7-453a-8233-4242a6bad179",
  "pinBlock": "tACuB41yyfU="
}
'

import requests

url = "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set"

payload = {
    "controlId": "83fa5f55-3dd7-453a-8233-4242a6bad179",
    "pinBlock": "tACuB41yyfU="
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({controlId: '83fa5f55-3dd7-453a-8233-4242a6bad179', pinBlock: 'tACuB41yyfU='})
};

fetch('https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'controlId' => '83fa5f55-3dd7-453a-8233-4242a6bad179',
    'pinBlock' => 'tACuB41yyfU='
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set"

	payload := strings.NewReader("{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The related PIN control request data

controlId

string

required

Control ID received from PIN control API.

Example:

"83fa5f55-3dd7-453a-8233-4242a6bad179"

pinBlock

string

required

ISO format 1 PIN block 3DES encrypted with temporary PIN encryption key (tzpk). Base64-encoded.

Example:

"tACuB41yyfU="

Response

The response is of type setPinResponse · object.

⌘I

Set PIN

curl --request POST \
  --url 'https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "controlId": "83fa5f55-3dd7-453a-8233-4242a6bad179",
  "pinBlock": "tACuB41yyfU="
}
'

import requests

url = "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set"

payload = {
    "controlId": "83fa5f55-3dd7-453a-8233-4242a6bad179",
    "pinBlock": "tACuB41yyfU="
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({controlId: '83fa5f55-3dd7-453a-8233-4242a6bad179', pinBlock: 'tACuB41yyfU='})
};

fetch('https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'controlId' => '83fa5f55-3dd7-453a-8233-4242a6bad179',
    'pinBlock' => 'tACuB41yyfU='
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set"

	payload := strings.NewReader("{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat1.{{environment}}.ext.{{realm}}.cia.enfuce.com/pin/v3/set")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"controlId\": \"83fa5f55-3dd7-453a-8233-4242a6bad179\",\n  \"pinBlock\": \"tACuB41yyfU=\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}