v10

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

pii-expansion

Create and stream a PII expansion job

Create a persisted PII-expansion job and immediately stream typed server-sent events until completion. Use the X-Job-Id response header to reconnect at GET /v1/pii-expansion/jobs/{job_id}/stream with Last-Event-ID.

post/v1/pii-expansion/stream

Request body

depth'standard' | 'deep'

maxCandidatesinteger

Example request

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

Response

Successful Response

{"stackTrail":"paths:/v1/pii-expansion/stream:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}