Create or Update Custom Tags

{
  "data": {
    "tag_type": "CUSTOMER_ID",
    "identification_endpoint_details": {
      "url": "https://example.com/custom-pii/identify",
      "method": "PUT",
      "headers": {
        "Authorization": "Bearer <access_token>"
      }
    }
  }
}

curl -X PUT https://<domain>/api/vault/metadata/add-or-update/custom-tag/identification-endpoint \
  -H "Authorization: Bearer <NAMESPACE_ADMIN_API_KEY>" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "data": {
      "tag_type": "CUSTOMER_ID",
      "identification_endpoint_details": {
        "url": "https://example.com/custom-pii/identify",
        "method": "PUT",
        "headers": {
          "Authorization": "Bearer <access_token>"
        }
      }
    }
  }'

{
  "data": {
    "message": "CUSTOMER_ID created successfully."
  },
  "success": true,
  "error": { "message": "" }
}

Creates or updates a custom PII tag and configures how Protecto should identify it in text.

Endpoint

Method	Endpoint
`PUT`	`https://<domain>/api/vault/metadata/add-or-update/custom-tag/identification-endpoint`

Request body

body

tag_typestring

Required

Unique name for the custom tag (e.g., "CUSTOMER_ID"). This becomes the entity tag used in masked output.

body

identification_endpoint_details.urlstring

Required

URL of your external identification service.

body

identification_endpoint_details.methodstring

Required

HTTP method for the identification endpoint (typically "PUT" or "POST").

body

identification_endpoint_details.headersobject

Authentication headers for your identification endpoint.

Notes

Using the same tag_type as an existing tag will update its configuration
After creation, the tag is immediately available for use in masking
The identification endpoint must be accessible from Protecto infrastructure
See Configure Identification Endpoints for the required endpoint contract

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI