Identities

Tokenize one field

Replace one identity field with a token.

POST/identities/{identity_id}/tokenize/{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 field.

fieldstringrequiredpath

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

Response

messagestringrequired

Confirms the field is now a token.

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

{
  "message": "Field tokenized successfully"
}

{
  "error": "field first_name is not tokenizable",
  "error_detail": {
    "code": "IDT_FIELD_NOT_TOKENIZABLE",
    "message": "field first_name is not tokenizable"
  }
}

{
  "error": "field EmailAddress is already tokenized",
  "error_detail": {
    "code": "IDT_FIELD_ALREADY_TOKENIZED",
    "message": "field EmailAddress is already tokenized"
  }
}