pii-expansion

Run PII expansion

Changed on

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

  • Base URL
    https://api.ie.intrace.ai
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

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

Changes

    • warning

      added the new social_profile_analysis enum value to the / response property for the response status

    • info

      removed the social_match enum value from the / response property for the response status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status