Sign in

v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-31116192.0 KB
social-profile-analysis

Run Social Profile Analysis

Create a Social Profile Analysis job for known social profile URLs. The base Match layer returns matched records; optional Behavioral Analysis adds interpretation over those matched records. When responseMode is sync, the API waits for an inline result until the configured timeout. Every response includes X-Job-Id.

post/v1/social-profile-analysis

Request body

analysisTypesAnalysisType[]
responseMode'sync' | 'async'

Example request

{
  "analysisTypes": [
    "match"
  ],
  "match": {
    "criteria": [
      "fraud",
      "theft",
      "crime"
    ],
    "maxRecords": 25
  },
  "responseMode": "sync",
  "subject": {
    "name": "Jared Gizersky",
    "socialMediaUrls": [
      "https://x.com/jaredg"
    ]
  }
}

Response

Matched social records and optional behavioral analysis when completed inline, otherwise a job envelope.

OR