1 of 1

Redact text strings

You can use the Tonic Textual REST API to redact text strings, including:

Plain text
JSON
XML
HTML

Textual provides a specific endpoint for each format. For JSON, XML, and HTML, Textual only redacts the text values. It preserves the underlying structure.

Redact text strings

You can use the Tonic Textual REST API to redact text strings, including:

Plain text
JSON
XML
HTML

Textual provides a specific endpoint for each format. For JSON, XML, and HTML, Textual only redacts the text values. It preserves the underlying structure.

Returns a list of supported entity types

get

/api/Redact/pii_types

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Redact/pii_types'

200

[
  "NUMERIC_VALUE"
]

Redact entities in plain text

Returns a modified version of the provided text string that redacts or synthesizes the detected entity values.

post

/api/Redact

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Redact' \
  --header 'Content-Type: application/json' \
  --data '{
    "generatorConfig": {
      "NAME_GIVEN": "Redaction",
      "NAME_FAMILY": "Redaction"
    },
    "generatorDefault": "Off",
    "docXImagePolicy": "Redact",
    "docXCommentPolicy": "Remove",
    "pdfSignaturePolicy": "Redact",
    "docXTablePolicy": "Redact",
    "labelBlockLists": {
      "NAME_FAMILY": {
        "strings": [],
        "regexes": [
          ".*\\s(disease|syndrom|disorder)"
        ]
      }
    },
    "labelAllowLists": {
      "HEALTHCARE_ID": {
        "strings": [],
        "regexes": [
          "[a-z]{2}\\d{9}"
        ]
      }
    },
    "customModels": [
      "text"
    ],
    "datasetGeneratorMetadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "recordApiRequestOptions": {
      "record": true,
      "retentionTimeInHours": 1,
      "tags": [
        "text"
      ]
    },
    "customPiiEntityIds": [
      "text"
    ],
    "text": "My name is John Smith"
  }'

200

{
  "originalText": "text",
  "redactedText": "text",
  "usage": 1,
  "deIdentifyResults": [
    {
      "start": 1,
      "end": 1,
      "newStart": 1,
      "newEnd": 1,
      "label": "text",
      "text": "text",
      "newText": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "jsonPath": "text",
      "xmlPath": "text",
      "idx": 1
    }
  ]
}

Redact plain text entities in bulk

Returns a modified version of the provided text string that redacts or synthesizes the detected entity values.

post

/api/Redact/bulk

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Redact/bulk' \
  --header 'Content-Type: application/json' \
  --data '{
    "generatorConfig": {
      "NAME_GIVEN": "Redaction",
      "NAME_FAMILY": "Redaction"
    },
    "generatorDefault": "Off",
    "docXImagePolicy": "Redact",
    "docXCommentPolicy": "Remove",
    "pdfSignaturePolicy": "Redact",
    "docXTablePolicy": "Redact",
    "labelBlockLists": {
      "NAME_FAMILY": {
        "strings": [],
        "regexes": [
          ".*\\s(disease|syndrom|disorder)"
        ]
      }
    },
    "labelAllowLists": {
      "HEALTHCARE_ID": {
        "strings": [],
        "regexes": [
          "[a-z]{2}\\d{9}"
        ]
      }
    },
    "customModels": [
      "text"
    ],
    "datasetGeneratorMetadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "recordApiRequestOptions": {
      "record": true,
      "retentionTimeInHours": 1,
      "tags": [
        "text"
      ]
    },
    "customPiiEntityIds": [
      "text"
    ],
    "bulkText": [
      "text"
    ]
  }'

200

{
  "bulkText": [
    "text"
  ],
  "bulkRedactedText": [
    "text"
  ],
  "usage": 1,
  "deIdentifyResults": [
    {
      "start": 1,
      "end": 1,
      "newStart": 1,
      "newEnd": 1,
      "label": "text",
      "text": "text",
      "newText": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "jsonPath": "text",
      "xmlPath": "text",
      "idx": 1
    }
  ]
}

Redact entities in JSON and preserve the JSON structure

Returns a modified version of the JSON that redacts or synthesizes the detected entity values. The redacted JSON has the same structure as the input JSON. Only the primitive JSON values, such as strings and numbers, are modified.

post

/api/Redact/json

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Redact/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "generatorConfig": {
      "NAME_GIVEN": "Redaction",
      "NAME_FAMILY": "Redaction"
    },
    "generatorDefault": "Off",
    "docXImagePolicy": "Redact",
    "docXCommentPolicy": "Remove",
    "pdfSignaturePolicy": "Redact",
    "docXTablePolicy": "Redact",
    "labelBlockLists": {
      "NAME_FAMILY": {
        "strings": [],
        "regexes": [
          ".*\\s(disease|syndrom|disorder)"
        ]
      }
    },
    "labelAllowLists": {
      "HEALTHCARE_ID": {
        "strings": [],
        "regexes": [
          "[a-z]{2}\\d{9}"
        ]
      }
    },
    "customModels": [
      "text"
    ],
    "datasetGeneratorMetadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "customPiiEntityIds": [
      "text"
    ],
    "jsonText": "{\"Name\": \"John Smith\", \"Description\": \"John lives in Atlanta, Ga.\"}",
    "jsonPathAllowLists": {
      "NAME_GIVEN": [
        "$.name.first"
      ]
    },
    "recordApiRequestOptions": {
      "record": true,
      "retentionTimeInHours": 1,
      "tags": [
        "text"
      ]
    }
  }'

200

{
  "originalText": "text",
  "redactedText": "text",
  "usage": 1,
  "deIdentifyResults": [
    {
      "start": 1,
      "end": 1,
      "newStart": 1,
      "newEnd": 1,
      "label": "text",
      "text": "text",
      "newText": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "jsonPath": "text",
      "xmlPath": "text",
      "idx": 1
    }
  ]
}

Redact entities in XML and preserve the XML structure

Returns a modified version of the XML that redacts or synthesizes the detected entity values. The redacted XML has the same structure as the input XML. Only the XML inner text and attribute values are modified.

post

/api/Redact/xml

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Redact/xml' \
  --header 'Content-Type: application/json' \
  --data '{
    "generatorConfig": {
      "NAME_GIVEN": "Redaction",
      "NAME_FAMILY": "Redaction"
    },
    "generatorDefault": "Off",
    "docXImagePolicy": "Redact",
    "docXCommentPolicy": "Remove",
    "pdfSignaturePolicy": "Redact",
    "docXTablePolicy": "Redact",
    "labelBlockLists": {
      "NAME_FAMILY": {
        "strings": [],
        "regexes": [
          ".*\\s(disease|syndrom|disorder)"
        ]
      }
    },
    "labelAllowLists": {
      "HEALTHCARE_ID": {
        "strings": [],
        "regexes": [
          "[a-z]{2}\\d{9}"
        ]
      }
    },
    "customModels": [
      "text"
    ],
    "datasetGeneratorMetadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "customPiiEntityIds": [
      "text"
    ],
    "xmlText": "\n            <note>\n            <to>Tove</to>\n            <from>Jani</from>\n            <heading>Reminder</heading>\n            <body>Don't forget me this weekend!</body>\n            </note>\n            ",
    "recordApiRequestOptions": {
      "record": true,
      "retentionTimeInHours": 1,
      "tags": [
        "text"
      ]
    }
  }'

200

{
  "originalText": "text",
  "redactedText": "text",
  "usage": 1,
  "deIdentifyResults": [
    {
      "start": 1,
      "end": 1,
      "newStart": 1,
      "newEnd": 1,
      "label": "text",
      "text": "text",
      "newText": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "jsonPath": "text",
      "xmlPath": "text",
      "idx": 1
    }
  ]
}

Redact entities in HTML and preserve the HTML structure

Returns a modified version of the HTML that redacts or synthesizes the detected entity values. The redacted HTML has the same structure as the input HTML. Only the text contained in the HTML elements is modified.

post

/api/Redact/html

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Redact/html' \
  --header 'Content-Type: application/json' \
  --data '{
    "generatorConfig": {
      "NAME_GIVEN": "Redaction",
      "NAME_FAMILY": "Redaction"
    },
    "generatorDefault": "Off",
    "docXImagePolicy": "Redact",
    "docXCommentPolicy": "Remove",
    "pdfSignaturePolicy": "Redact",
    "docXTablePolicy": "Redact",
    "labelBlockLists": {
      "NAME_FAMILY": {
        "strings": [],
        "regexes": [
          ".*\\s(disease|syndrom|disorder)"
        ]
      }
    },
    "labelAllowLists": {
      "HEALTHCARE_ID": {
        "strings": [],
        "regexes": [
          "[a-z]{2}\\d{9}"
        ]
      }
    },
    "customModels": [
      "text"
    ],
    "datasetGeneratorMetadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "customPiiEntityIds": [
      "text"
    ],
    "htmlText": "\n            <!DOCTYPE html>\n            <html>\n            <body>\n            <h1>Account Information</h1>\n            <p>Account Holder: John Smith</p>\n            </body>\n            </html>\n            ",
    "recordApiRequestOptions": {
      "record": true,
      "retentionTimeInHours": 1,
      "tags": [
        "text"
      ]
    }
  }'

200

{
  "originalText": "text",
  "redactedText": "text",
  "usage": 1,
  "deIdentifyResults": [
    {
      "start": 1,
      "end": 1,
      "newStart": 1,
      "newEnd": 1,
      "label": "text",
      "text": "text",
      "newText": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "jsonPath": "text",
      "xmlPath": "text",
      "idx": 1
    }
  ]
}

Redact text strings

Redact text strings

Returns a list of supported entity types

Redact entities in plain text

Show child attributes

Redact plain text entities in bulk

Show child attributes

Redact entities in JSON and preserve the JSON structure

Show child attributes

Redact entities in XML and preserve the XML structure

Show child attributes

Redact entities in HTML and preserve the HTML structure

Show child attributes