/detokenize

Description

Service exposed to detokenize the best encrypted image generated by the Selphi widget. The service must be sent the string bestImageToken and the transactionID associated with the identity service, previously executed in the OnBoarding flow.

Request:

curl --location '{IDENTITY_API_BASE_URL}/services/detokenize' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
  "bestImageToken": "{BEST_IMAGE_TOKEN}",
  "transactionId": "{TRANSACTION_ID}"
}'

Request parameters:

Parameter	Type (Content)	Required	Description
bestImageToken	String	Yes	Tokenized image sent in the bestImage parameter of the /identity endpoint
transactionId	String	Yes	Transaction ID associated with the operation/validation of the Liveness module obtained in the response of the /identity endpoint

Example response:

200 OK

Content-Type: application/json

{
    "timestamp": "2024-03-19T12:34:28Z",
    "transactionId": "238ee483-60d9-45ea-85bd-a6bc686d70b7",
    "imageBuffer": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCA..."
}

Response fields:

Identifier	Type	Description
timestamp	String	Date and time of the request
transactionId	String	Transaction ID associated with the request processed by the API
imageBuffer	String	Base64 of the open image