Identify Custom PII

Detect occurrences of a configured custom PII tag within input texts and return their positions.

{
  "input_texts": [
    "Customer ID 56789 placed an order",
    "Customer ID 98765 updated profile"
  ],
  "tag_type": "CUSTOMER_ID"
}

curl -X PUT https://<domain>/api/vault/pii-identification/custom \
  -H "Authorization: Bearer <AUTH_TOKEN>" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "input_texts": [
      "Customer ID 56789 placed an order",
      "Customer ID 98765 updated profile"
    ],
    "tag_type": "CUSTOMER_ID"
  }'

{
  "data": [
    {
      "input_text": "Customer ID 56789 placed an order",
      "detected": [
        {
          "type": "CUSTOMER_ID",
          "text": "56789",
          "start": 12,
          "end": 17
        }
      ]
    },
    {
      "input_text": "Customer ID 98765 updated profile",
      "detected": [
        {
          "type": "CUSTOMER_ID",
          "text": "98765",
          "start": 12,
          "end": 17
        }
      ]
    }
  ],
  "success": true,
  "error": { "message": "" }
}

This endpoint identifies occurrences of a custom PII tag inside one or more input texts and returns their positions. The actual identification logic is driven by the configured identification endpoint for the tag.

Endpoint

Method	Endpoint
`PUT`	`https://<domain>/api/vault/pii-identification/custom`

Request body

body

input_textsarray[string]

Required

Array of text strings to scan for the custom PII tag.

body

tag_typestring

Required

Name of the custom tag to detect (e.g., "CUSTOMER_ID").

Response fields

typestring

Required

Custom tag name.

textstring

Required

The extracted value.

startinteger

Required

Start character position in the input text.

endinteger

Required

End character position in the input text.

input_textstring

Required

The original input text that was analyzed.

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI

{ "data": [ { "input_text": "Customer ID 56789 placed an order", "detected": [ { "type": "CUSTOMER_ID", "text": "56789", "start": 12, "end": 17 } ] }, { "input_text": "Customer ID 98765 updated profile", "detected": [ { "type": "CUSTOMER_ID", "text": "98765", "start": 12, "end": 17 } ] } ], "success": true, "error": { "message": "" } }