Check text for personal data

Same detection as redaction but returns only the findings and a clean flag, for gating a pipeline. The redacted text is not returned. Metered as pii.scan.

POST/v1/pii/scan

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

textstringrequired

Up to 1 MiB.

Responses

200

Findings

cleanbooleanrequired

countintegerrequired

entity_typesstring[]required

findingsPiiFinding[]required

Show properties

Array of PiiFinding

entity_typestringrequired

startintegerrequired

Byte offset of the first byte of the span.

endintegerrequired

Byte offset one past the last byte.

scorenumberrequired

0 to 1.

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

502

Upstream service (arXiv, YouTube, web page) failed

string

503

The backing service is not configured or is busy

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

textstring*Up to 1 MiB.

Request

curl -X POST 'https://api.webfold.ai/v1/pii/scan' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "text": "string"
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/pii/scan",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"text\": \"string\"\n}",
)

const response = await fetch("https://api.webfold.ai/v1/pii/scan", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"text\": \"string\"\n}"
});

Response

{
  "clean": true,
  "count": 0,
  "entity_types": [
    "string"
  ],
  "findings": [
    {
      "entity_type": "EMAIL",
      "start": 0,
      "end": 0,
      "score": 0
    }
  ]
}

"string"

"string"

"string"

"string"

"string"