Identities

Detokenize one field

Read the original value of one tokenized identity field.

GET/identities/{identity_id}/detokenize/{field}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

identity_idstringrequiredpath

Id of the identity that holds the token.

fieldstringrequiredpath

PascalCase name of the field to read: FirstName, LastName, OtherNames, EmailAddress, PhoneNumber, Street, or PostCode.

Response

fieldstringrequired

PascalCase name you asked for.

valuestringrequired

Original value of that field.

curl -X GET "http://localhost:5001/identities/{identity_id}/detokenize/EmailAddress" \
  -H "X-blnk-key: <api-key>"

{
  "field": "EmailAddress",
  "value": "[email protected]"
}

{
  "error": "field EmailAddress is not tokenized",
  "error_detail": {
    "code": "IDT_FIELD_NOT_TOKENIZED",
    "message": "field EmailAddress is not tokenized"
  }
}