Updated on February 22, 2024

Managing Custom PII Tags and Configuring Whitelist Endpoint Details

This endpoint enables users to add or update a custom PII tag and configure the endpoint details for retrieving the list of PII elements for that Particular tag(Whitelist).

Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token

Route/metadata/add-or-update/custom-tag/pi-list-endpoint.

Request Type: PUT.

Input Structure:

The input structure consists of a JSON object with a data field containing:

tag_type: The type of the custom PII tag.

pi_elements_list_endpoint_details: Details of the endpoint for retrieving the list of PII elements for that Particular tag(Whitelist). , including URL, method, and headers(if Applicable)

Code Snippet

{
   "data":{
      "tag_type":"CUSTOMER_ID",
      "pi_elements_list_endpoint_details":{
         "url":"<url>",
         "method":"GET",
         "headers":{
            "Authorization":"Bearer <access_token>"
         }
      }
   }
}

Response:

Upon successful addition or update, the response contains a JSON object with:

  • A data field containing a success message indicating that the custom PII tag has been added or updated successfully.
{
   "data":{
      "message":"custom tag CUSTOMER_ID added or updated successfully."
   },
   "success":"true",
   "error":{
      "message":""
   }
}

 

What are your feelings
Scroll to Top