Sign in

v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-31116192.0 KB
pii-expansion

Run PII expansion

Create a PII-expansion job and wait for an inline result when responseMode is sync. If the job does not finish before the inline timeout, or when responseMode is async, the API returns a persisted job envelope. Every response includes X-Job-Id for later lookup.

post/v1/pii-expansion

Request body

depth'standard' | 'deep'
maxCandidatesinteger
responseMode'sync' | 'async'

Example request

{
  "depth": "standard",
  "maxCandidates": 10,
  "responseMode": "sync",
  "seeds": {
    "emails": [
      "jared@example.com"
    ],
    "phones": [
      "+15555550100"
    ],
    "usernames": [
      "jaredg"
    ]
  },
  "subject": {
    "name": "Jared Gizersky"
  }
}

Response

Normalized identity and related social-candidate results when completed inline, otherwise a job envelope.

OR