Obfuscating content

warning

This feature is in beta.

The ObfuscationService service exposes a create operation. All parts of the document content corresponding to the search defined in the call will be automatically obfuscated.

Search for areas to obfuscate

The research model used in the call for proposals is as follows:

{
  "accentSensitive": true,
  "caseSensitive": true,
  "regex": true,
  "text": "string"
}

The text is the value or pattern you are looking for. The default value is a pattern. To find the exact value and not a pattern, the value regex must be set to false.

The accentSensitive and caseSensitive parameters indicate that the search should be accent-sensitive and case-sensitive respectively.

Example

The examples below show how to obfuscate a value (in the example: "Demo") and a reason (here hides IBANs in the document).

Case sensitive value

# <CORE_HOST>    FlowerDocs Core base URL
# <TOKEN>        authentication token
# <DOCUMENT_ID>  identifier of the document to be obfuscated

curl -X POST "<CORE_HOST>/rest/documents/<DOCUMENT_ID>/obfuscations" \
  -H "token: <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "accentSensitive": true,
  "caseSensitive": false,
  "regex": false,
  "text": "Demo"
}'

Reason

# <CORE_HOST>    FlowerDocs Core base URL
# <TOKEN>        authentication token
# <DOCUMENT_ID>  identifier of the document to be obfuscated

curl -X POST "<CORE_HOST>/rest/documents/<DOCUMENT_ID>/obfuscations" \
  -H "token: <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "accentSensitive": false,
  "caseSensitive": false,
  "regex": true,
  "text": "IBAN : (.{4}-){3}.{4}"
}'