How to Depersonalize Data in Document Reader Web API

Document Reader Web API allows you to depersonalize selected text and graphic fields in the document processing results. You can specify individual field types or enable complete depersonalization for all recognized fields.

The dePersonalize configuration must be included in the processParam object of the processing request.

Depersonalizing Selected Fields

To depersonalize specific fields, provide their numeric identifiers in the following arrays:

• textFieldTypes for text fields
• graphicFieldTypes for graphic fields

Complete lists of the available identifiers are provided in the official documentation:

• TextFieldType enumeration
• GraphicFieldType enumeration

Request Example

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "textFieldTypes": [
          36,
          7
        ],
        "graphicFieldTypes": [
          204,
          201
        ]
      }
    ]
  }
}

Fields Depersonalized in This Example

Text Fields

The identifiers are defined in the official TextFieldType enumeration.

Graphic Fields

The identifiers are defined in the official GraphicFieldType enumeration.

With this configuration, the following data will be depersonalized:

• Optional data
• Personal number
• Signature
• Portrait

Other recognized fields will remain available in the processing results.

Complete Depersonalization

To depersonalize all recognized text and graphic fields, use the allTextFields and allGraphicFields parameters.

Request Example

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "allTextFields": true
      },
      {
        "allGraphicFields": true
      }
    ]
  }
}

This configuration applies depersonalization to all text and graphic fields returned in the document processing results.

Depending on the document and the enabled processing operations, this may include:

• Personal details extracted from the visual inspection zone
• MRZ data
• Barcode data
• Text data obtained from the RFID chip
• Portraits
• Signatures
• Barcode images
• Other supported text and graphic fields

Depersonalizing All Text Fields Only

To depersonalize all text fields while preserving graphic fields, use the following configuration:

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "allTextFields": true
      }
    ]
  }
}

Depersonalizing All Graphic Fields Only

To depersonalize all graphic fields while preserving text fields, use the following configuration:

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "allGraphicFields": true
      }
    ]
  }
}

Combining Selected and Complete Depersonalization

Selected field depersonalization can be combined with complete depersonalization of another field category.

For example, the following request depersonalizes the personal number and optional data while applying depersonalization to all graphic fields:

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "textFieldTypes": [
          7,
          36
        ]
      },
      {
        "allGraphicFields": true
      }
    ]
  }
}

Depersonalizing Additional Fields

To depersonalize other fields, add the required numeric identifiers to the textFieldTypes or graphicFieldTypes arrays.

For example, the following configuration depersonalizes the document number, date of birth, personal number, surname, given names, portrait, and signature:

{
  "processParam": {
    "scenario": "FullProcess",
    "dePersonalize": [
      {
        "textFieldTypes": [
          2,
          5,
          7,
          8,
          9
        ],
        "graphicFieldTypes": [
          201,
          204
        ]
      }
    ]
  }
}

Selected Text Fields

See the complete TextFieldType enumeration for all supported text field identifiers.

Selected Graphic Fields

See the complete GraphicFieldType enumeration for all supported graphic field identifiers.

Additional Graphic Field Examples

The following graphic field identifiers may also be used when configuring selective depersonalization:

The current list of supported values is available in the GraphicFieldType enumeration.

Important Considerations

Depersonalization applies to the corresponding fields in the document processing results. The original document image must still be submitted to the Web API so that the document can be processed.

If the integration stores processing requests, responses, original images, transaction data, or application logs, the corresponding storage and logging configuration should be reviewed separately.

Depersonalizing result fields does not automatically remove personal data from:

• Original request images
• Application logs
• Proxy logs
• Monitoring systems
• Custom storage implemented by the integrating application

Numeric field identifiers should be verified against the documentation for the exact Document Reader Web API version used in the target environment.