Identities

Tokenize multiple fields

Replace several identity fields with tokens in one request.

POST/identities/{identity_id}/tokenize

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

Body

fieldsstring[]requiredbody

PascalCase names to tokenize. Send at least one of FirstName, LastName, OtherNames, EmailAddress, PhoneNumber, Street, or PostCode.

Response

messagestringrequired

Confirms every field in the request is now a token.

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

{
  "message": "Fields tokenized successfully"
}

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