If you’d like to try it yourself, please visit our free interactive web demo. No code or account is necessary.
How Images Are Processed
Image files are processed as follows:- Non-text PII such as faces and license plates are detected.
- Additionally the image is run through an OCR system to detect any text present.
- The output of the OCR system is then passed to a PII detection module.
- Any PII found in the previous steps is de-identified via blurring or black box redaction.
You can configure the OCR System by setting it as an Environment Variable or sending it in the request object. Check out our OCR Guide to further understand the OCR modes and their usage.
Constraints
- There is limited support for 8-bit PNG images.
- Multi-page TIFF images are only supported on versions >=4.2.1. Earlier versions will process and return the first page of a multi-page TIFF.
Supported File Types
| File Type | Extension | Content Type | Added In |
|---|---|---|---|
| JPEG image | .jpg, .jpeg | image/jpg, image/jpeg | 3.0.0 |
| TIFF image | .tif, .tiff | image/tif, image/tiff | 3.0.0 |
| PNG image | .png | image/png | 3.4.0 |
| BMP image | .bmp | image/bmp, image/x-ms-bmp | 3.4.0 |
| GIF image | .gif | image/gif | 4.2.1 |
Support Matrix
| CPU Container | GPU Container | Community API | Professional API | |
|---|---|---|---|---|
| Supported | Yes | Yes | Up to 10 MiB | No |
Sample Request
Connect with one of our privacy experts to run this code.
Sample Response
Response