API Reference
API Reference

Detect personally identifiable information (PII) from an image

post
https://{endpoint}/detect-pii
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

The image file, can be a JPG, PNG or PDF file Either specify this or provide the image_url parameter

string

URL of the image to be processed in jpg or png format, or URL of a pdf file

number
Defaults to 150

DPI of the uploaded pdf file

string
enum
Defaults to google

OCR Engine

Allowed:
string
enum

PII detection mode. If it is set to redact, redacted_image field will be added to the output response.

Allowed:
string

Categories of PII entity to detect. Default to include all categories. Possible value includes names,addresses, telephone_numbers, emails and identity_numbers. Multiple value can be joined by ,.

Responses

Updated 4 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago