Identities

Detokenize multiple fields

Read the original values of tokenized identity fields.

POST/identities/{identity_id}/detokenize

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 tokens.

Body

fieldsstring[]body

PascalCase names to read. Omit this, or send [], to read every tokenized field.

Response

fieldsobjectrequired

Map of field names to their original values. When you send fields, the keys are the names you sent.

curl -X POST "http://localhost:5001/identities/{identity_id}/detokenize" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": [
      "FirstName",
      "LastName",
      "EmailAddress",
      "PhoneNumber"
    ]
  }'

{
  "fields": {
    "FirstName": "Alice",
    "LastName": "Smith",
    "EmailAddress": "alice.smith@example.com",
    "PhoneNumber": "+1234567890"
  }
}

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