Request PIN Control access token by plasticId.

This operation is used to create the PIN control access token.

The successful response from this call returns an id, a pinURL for mobile device webview and pinFrameURL for an iframe in desktop browser flow. Id is valid for 30 seconds.

For mobile webview, device should be instructed to do a POST call to the pinURL with the content of the id in a form field named controlId.

For desktop browser flow, iframe should be opened to pinFrameURL with query parameter key, which needs to be agreed with Enfuce beforehand. After iframe has been loaded, browser should make a window.postMessage() call to the iframe. The message object should contain fields operation (with value view-pin or set-pin) and controlId.

POST

plastic

{plasticId}

Request PIN Control access token by plasticId.

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/pincontrol/v2/plastic/{plasticId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "VIEW_PIN"
}
'

{
  "id": "<string>",
  "pinURL": "<string>",
  "pinFrameURL": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plasticId

string<biginteger>

required

The id of the plastic for which the PIN should be accessed

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The related PIN control request data

scope

enum<string>

required

Describes the scope of the operation that is authorized by the user.

Available options:

VIEW_PIN,

SET_PIN

Response

Successful creation of the access token

string

required

The ID of this PIN Control access token.

pinURL

string

The URL that the cardholder's mobile device webview should browse to for accessing the PIN.

pinFrameURL

string

The URL of the iframe for desktop browser based flows for accessing PIN.

⌘I

Request PIN Control access token by plasticId.

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/pincontrol/v2/plastic/{plasticId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "VIEW_PIN"
}
'

{
  "id": "<string>",
  "pinURL": "<string>",
  "pinFrameURL": "<string>"
}