Run Social Profile Analysis

POST/v1/social-profile-analysis

Requires X-API-Key or Authorization: Bearer with a provisioned API key.

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.

Request body

Field	Type	Required	Description
`analysisTypes`	array<`AnalysisType`>	No	Analysistypes Default: `["match"]`
`behavioralAnalysis`	`BehavioralAnalysisConfig` or null	No	—
`match`	`SocialProfileAnalysisMatchConfig`	Yes	—
`responseMode`	`ResponseMode`	No	Default: `"sync"`
`subject`	`SocialProfileAnalysisSubject`	Yes	—

Request examples

Known-profile match analysis

Analyze known social profile URLs against natural-language match criteria.

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

Responses

`200`

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

Schema: SocialProfileAnalysisResult or JobEnvelope_SocialProfileAnalysisResult_

`422`

Validation Error

Field	Type	Required	Description
`detail`	array<`ValidationError`>	No	Detail

OpenAPI

Download the full OpenAPI contract from /openapi.yaml.