{ "components": { "schemas": { "AnalysisType": { "enum": [ "match", "behavioral_analysis" ], "title": "AnalysisType", "type": "string" }, "ApiError": { "additionalProperties": false, "description": "Standard API error payload.", "properties": { "code": { "minLength": 1, "title": "Code", "type": "string" }, "message": { "minLength": 1, "title": "Message", "type": "string" }, "retryable": { "default": false, "title": "Retryable", "type": "boolean" } }, "required": [ "code", "message" ], "title": "ApiError", "type": "object" }, "ApiWarning": { "additionalProperties": false, "description": "Non-fatal warning returned alongside results or job state.", "properties": { "code": { "minLength": 1, "title": "Code", "type": "string" }, "message": { "minLength": 1, "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "ApiWarning", "type": "object" }, "BehavioralAnalysisConfig": { "additionalProperties": false, "description": "Optional interpretation layer that uses Match output as input.", "properties": { "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "focus": { "items": { "type": "string" }, "title": "Focus", "type": "array" }, "targetContext": { "anyOf": [ { "$ref": "#/components/schemas/TargetContext" }, { "type": "null" } ] }, "timeBucket": { "$ref": "#/components/schemas/TimeBucket", "default": "week" } }, "title": "BehavioralAnalysisConfig", "type": "object" }, "BehavioralAnalysisResult": { "additionalProperties": false, "properties": { "accountsDrivingActivity": { "items": { "type": "string" }, "title": "Accountsdrivingactivity", "type": "array" }, "confidence": { "default": 0.0, "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "type": "number" }, "explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Explanation" }, "keyRecordIds": { "items": { "type": "string" }, "title": "Keyrecordids", "type": "array" }, "keySignals": { "items": { "type": "string" }, "title": "Keysignals", "type": "array" }, "limits": { "items": { "type": "string" }, "title": "Limits", "type": "array" }, "riskAssessment": { "$ref": "#/components/schemas/RiskAssessment" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" }, "timeline": { "items": { "$ref": "#/components/schemas/BehavioralTimelineItem" }, "title": "Timeline", "type": "array" } }, "required": [ "summary", "riskAssessment" ], "title": "BehavioralAnalysisResult", "type": "object" }, "BehavioralTimelineItem": { "additionalProperties": false, "properties": { "period": { "minLength": 1, "title": "Period", "type": "string" }, "recordIds": { "items": { "type": "string" }, "title": "Recordids", "type": "array" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" } }, "required": [ "period", "summary" ], "title": "BehavioralTimelineItem", "type": "object" }, "BodyTypeBuild": { "enum": [ "Slim", "Average", "Athletic / Fit", "Muscular", "Heavyset", "Unknown" ], "title": "BodyTypeBuild", "type": "string" }, "Capability": { "enum": [ "web_search", "pii_expansion", "social_profile_analysis" ], "title": "Capability", "type": "string" }, "ConfidenceCategory": { "enum": [ "likely", "uncertain" ], "title": "ConfidenceCategory", "type": "string" }, "DriversLicenseState": { "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "title": "DriversLicenseState", "type": "string" }, "EmploymentStatus": { "enum": [ "Employee", "Contractor", "Former Employee", "Terminated", "Applicant", "Unknown" ], "title": "EmploymentStatus", "type": "string" }, "ExpansionDepth": { "enum": [ "standard", "deep" ], "title": "ExpansionDepth", "type": "string" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "JobEnvelope_PiiExpansionResult_": { "additionalProperties": false, "properties": { "capability": { "$ref": "#/components/schemas/Capability" }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ApiError" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "jobId": { "minLength": 1, "title": "Jobid", "type": "string" }, "progress": { "anyOf": [ { "$ref": "#/components/schemas/JobProgress" }, { "type": "null" } ] }, "result": { "anyOf": [ { "$ref": "#/components/schemas/PiiExpansionResult" }, { "type": "null" } ] }, "resultUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resulturl" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "streamUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Streamurl" }, "submittedAt": { "format": "date-time", "title": "Submittedat", "type": "string" }, "summary": { "anyOf": [ { "$ref": "#/components/schemas/JobSummary" }, { "type": "null" } ] }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" } }, "required": [ "jobId", "capability", "status", "submittedAt" ], "title": "JobEnvelope[PiiExpansionResult]", "type": "object" }, "JobEnvelope_SocialProfileAnalysisResult_": { "additionalProperties": false, "properties": { "capability": { "$ref": "#/components/schemas/Capability" }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ApiError" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "jobId": { "minLength": 1, "title": "Jobid", "type": "string" }, "progress": { "anyOf": [ { "$ref": "#/components/schemas/JobProgress" }, { "type": "null" } ] }, "result": { "anyOf": [ { "$ref": "#/components/schemas/SocialProfileAnalysisResult" }, { "type": "null" } ] }, "resultUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resulturl" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "streamUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Streamurl" }, "submittedAt": { "format": "date-time", "title": "Submittedat", "type": "string" }, "summary": { "anyOf": [ { "$ref": "#/components/schemas/JobSummary" }, { "type": "null" } ] }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" } }, "required": [ "jobId", "capability", "status", "submittedAt" ], "title": "JobEnvelope[SocialProfileAnalysisResult]", "type": "object" }, "JobEnvelope_WebSearchResult_": { "additionalProperties": false, "properties": { "capability": { "$ref": "#/components/schemas/Capability" }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ApiError" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "jobId": { "minLength": 1, "title": "Jobid", "type": "string" }, "progress": { "anyOf": [ { "$ref": "#/components/schemas/JobProgress" }, { "type": "null" } ] }, "result": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchResult" }, { "type": "null" } ] }, "resultUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resulturl" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "streamUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Streamurl" }, "submittedAt": { "format": "date-time", "title": "Submittedat", "type": "string" }, "summary": { "anyOf": [ { "$ref": "#/components/schemas/JobSummary" }, { "type": "null" } ] }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" } }, "required": [ "jobId", "capability", "status", "submittedAt" ], "title": "JobEnvelope[WebSearchResult]", "type": "object" }, "JobProgress": { "additionalProperties": false, "description": "Progress metadata for long-running jobs.", "properties": { "completedSteps": { "default": 0, "minimum": 0.0, "title": "Completedsteps", "type": "integer" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "stage": { "minLength": 1, "title": "Stage", "type": "string" }, "totalSteps": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Totalsteps" } }, "required": [ "stage" ], "title": "JobProgress", "type": "object" }, "JobStatus": { "enum": [ "queued", "running", "completed", "failed", "expired" ], "title": "JobStatus", "type": "string" }, "JobSummary": { "additionalProperties": false, "description": "Summary counters for a completed or running job.", "properties": { "itemsFound": { "default": 0, "minimum": 0.0, "title": "Itemsfound", "type": "integer" }, "itemsReturned": { "default": 0, "minimum": 0.0, "title": "Itemsreturned", "type": "integer" } }, "title": "JobSummary", "type": "object" }, "MatchAnalysisResult": { "additionalProperties": false, "properties": { "matchedRecords": { "items": { "$ref": "#/components/schemas/SocialMatchedRecord" }, "title": "Matchedrecords", "type": "array" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" } }, "required": [ "summary" ], "title": "MatchAnalysisResult", "type": "object" }, "MatchedInputReference": { "additionalProperties": false, "description": "User input that contributed to a normalized item match.", "properties": { "inputType": { "$ref": "#/components/schemas/MatchedInputType" }, "value": { "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "inputType", "value" ], "title": "MatchedInputReference", "type": "object" }, "MatchedInputType": { "enum": [ "name", "alias", "adverse_term", "keyword", "region", "email", "phone", "address", "username", "domain", "location", "employer", "social_url", "seed_url", "date_of_birth", "place_of_birth", "age", "gender", "drivers_license_state", "employment_role", "employment_department", "employment_location", "employment_status" ], "title": "MatchedInputType", "type": "string" }, "MilitaryStatus": { "enum": [ "No Military Service", "Active Duty", "Reserve", "National Guard", "Veteran", "Unknown" ], "title": "MilitaryStatus", "type": "string" }, "PiiExpansionItem": { "additionalProperties": false, "description": "Normalized identity-candidate output for PII expansion.", "properties": { "confidenceCategory": { "$ref": "#/components/schemas/ConfidenceCategory" }, "emails": { "items": { "type": "string" }, "title": "Emails", "type": "array" }, "fullName": { "minLength": 1, "title": "Fullname", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "label": { "minLength": 1, "title": "Label", "type": "string" }, "matchRationale": { "items": { "type": "string" }, "title": "Matchrationale", "type": "array" }, "matchedInputs": { "items": { "$ref": "#/components/schemas/MatchedInputReference" }, "title": "Matchedinputs", "type": "array" }, "normalizedAttributes": { "$ref": "#/components/schemas/SanitizedNormalizedAttributes" }, "phones": { "items": { "type": "string" }, "title": "Phones", "type": "array" }, "riskFlags": { "items": { "type": "string" }, "title": "Riskflags", "type": "array" }, "safeMetadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ] }, "title": "Safemetadata", "type": "object" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" }, "type": { "const": "identity_candidate", "default": "identity_candidate", "title": "Type", "type": "string" }, "usernames": { "items": { "type": "string" }, "title": "Usernames", "type": "array" } }, "required": [ "id", "label", "summary", "confidenceCategory", "fullName" ], "title": "PiiExpansionItem", "type": "object" }, "PiiExpansionRequest": { "additionalProperties": false, "description": "Supported request payload for v1 PII expansion.", "examples": [ { "depth": "standard", "maxCandidates": 10, "seeds": { "emails": [ "john.smith@example.com" ], "phones": [ "+15555550100" ], "usernames": [ "johnsmith" ] }, "subject": { "name": "John Smith" } } ], "properties": { "depth": { "$ref": "#/components/schemas/ExpansionDepth", "default": "standard" }, "maxCandidates": { "default": 10, "maximum": 25.0, "minimum": 1.0, "title": "Maxcandidates", "type": "integer" }, "seeds": { "$ref": "#/components/schemas/PiiExpansionSeeds" }, "subject": { "$ref": "#/components/schemas/PiiExpansionSubject" } }, "required": [ "subject" ], "title": "PiiExpansionRequest", "type": "object" }, "PiiExpansionResult": { "additionalProperties": false, "description": "Inline or final PII expansion result payload.", "properties": { "capability": { "const": "pii_expansion", "default": "pii_expansion", "title": "Capability", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/PiiExpansionItem" }, "title": "Items", "type": "array" }, "limit": { "default": 25, "maximum": 25.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "total": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Total" }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" } }, "title": "PiiExpansionResult", "type": "object" }, "PiiExpansionRunRequest": { "additionalProperties": false, "description": "Run endpoint payload for PII expansion.", "examples": [ { "depth": "standard", "maxCandidates": 10, "responseMode": "sync", "seeds": { "emails": [ "john.smith@example.com" ], "phones": [ "+15555550100" ], "usernames": [ "johnsmith" ] }, "subject": { "name": "John Smith" } } ], "properties": { "depth": { "$ref": "#/components/schemas/ExpansionDepth", "default": "standard" }, "maxCandidates": { "default": 10, "maximum": 25.0, "minimum": 1.0, "title": "Maxcandidates", "type": "integer" }, "responseMode": { "$ref": "#/components/schemas/ResponseMode", "default": "sync" }, "seeds": { "$ref": "#/components/schemas/PiiExpansionSeeds" }, "subject": { "$ref": "#/components/schemas/PiiExpansionSubject" } }, "required": [ "subject" ], "title": "PiiExpansionRunRequest", "type": "object" }, "PiiExpansionSeeds": { "additionalProperties": false, "description": "Supported seed types for v1 identity expansion.", "properties": { "emails": { "items": { "type": "string" }, "title": "Emails", "type": "array" }, "phones": { "items": { "type": "string" }, "title": "Phones", "type": "array" }, "usernames": { "items": { "type": "string" }, "title": "Usernames", "type": "array" } }, "title": "PiiExpansionSeeds", "type": "object" }, "PiiExpansionSubject": { "additionalProperties": false, "description": "Subject details supported by v1 PII expansion.", "properties": { "aliases": { "items": { "type": "string" }, "title": "Aliases", "type": "array" }, "name": { "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "PiiExpansionSubject", "type": "object" }, "ResponseMode": { "enum": [ "sync", "async" ], "title": "ResponseMode", "type": "string" }, "RiskAssessment": { "additionalProperties": false, "properties": { "confidence": { "default": 0.0, "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "type": "number" }, "level": { "$ref": "#/components/schemas/RiskLevel", "default": "unknown" }, "rationale": { "minLength": 1, "title": "Rationale", "type": "string" } }, "required": [ "rationale" ], "title": "RiskAssessment", "type": "object" }, "RiskLevel": { "enum": [ "none", "low", "medium", "high", "unknown" ], "title": "RiskLevel", "type": "string" }, "SanitizedNormalizedAttributes": { "additionalProperties": false, "description": "Sanitized, connector-agnostic normalized attributes.", "properties": { "addresses": { "items": { "type": "string" }, "title": "Addresses", "type": "array" }, "dates": { "items": { "type": "string" }, "title": "Dates", "type": "array" }, "domains": { "items": { "type": "string" }, "title": "Domains", "type": "array" }, "emails": { "items": { "type": "string" }, "title": "Emails", "type": "array" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "locations": { "items": { "type": "string" }, "title": "Locations", "type": "array" }, "names": { "items": { "type": "string" }, "title": "Names", "type": "array" }, "organizations": { "items": { "type": "string" }, "title": "Organizations", "type": "array" }, "phones": { "items": { "type": "string" }, "title": "Phones", "type": "array" }, "profileHandles": { "items": { "type": "string" }, "title": "Profilehandles", "type": "array" }, "usernames": { "items": { "type": "string" }, "title": "Usernames", "type": "array" } }, "title": "SanitizedNormalizedAttributes", "type": "object" }, "ServiceStatusResponse": { "additionalProperties": false, "description": "Standard health and readiness response.", "properties": { "environment": { "title": "Environment", "type": "string" }, "service": { "title": "Service", "type": "string" }, "status": { "default": "ok", "title": "Status", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "service", "version", "environment" ], "title": "ServiceStatusResponse", "type": "object" }, "SocialAnalysisTimeRange": { "additionalProperties": false, "properties": { "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start" } }, "title": "SocialAnalysisTimeRange", "type": "object" }, "SocialDataType": { "enum": [ "posts", "comments", "bio", "media_ocr", "links", "relationships" ], "title": "SocialDataType", "type": "string" }, "SocialMatchedRecord": { "additionalProperties": false, "description": "Matched social record returned by the base Match layer.", "properties": { "confidence": { "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "type": "number" }, "confidenceCategory": { "$ref": "#/components/schemas/ConfidenceCategory" }, "evidenceExcerpt": { "minLength": 1, "title": "Evidenceexcerpt", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "label": { "minLength": 1, "title": "Label", "type": "string" }, "matchRationale": { "items": { "type": "string" }, "title": "Matchrationale", "type": "array" }, "matchedCriteria": { "items": { "type": "string" }, "title": "Matchedcriteria", "type": "array" }, "matchedInputs": { "items": { "$ref": "#/components/schemas/MatchedInputReference" }, "title": "Matchedinputs", "type": "array" }, "normalizedAttributes": { "$ref": "#/components/schemas/SanitizedNormalizedAttributes" }, "platform": { "$ref": "#/components/schemas/SocialPlatform" }, "publishedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publishedat" }, "reasonForMatch": { "minLength": 1, "title": "Reasonformatch", "type": "string" }, "safeMetadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ] }, "title": "Safemetadata", "type": "object" }, "sourceProfileUrl": { "minLength": 1, "title": "Sourceprofileurl", "type": "string" }, "sourceRecord": { "additionalProperties": true, "title": "Sourcerecord", "type": "object" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "type": { "enum": [ "post", "comment", "media", "link", "profile_field", "relationship", "video" ], "title": "Type", "type": "string" } }, "required": [ "id", "type", "label", "summary", "confidenceCategory", "platform", "sourceProfileUrl", "evidenceExcerpt", "confidence", "reasonForMatch" ], "title": "SocialMatchedRecord", "type": "object" }, "SocialPlatform": { "enum": [ "x", "instagram", "telegram", "youtube", "facebook" ], "title": "SocialPlatform", "type": "string" }, "SocialProfileAnalysisMatchConfig": { "additionalProperties": false, "description": "Base Match configuration for selecting relevant records.", "properties": { "confidenceThreshold": { "default": 0.6, "maximum": 1.0, "minimum": 0.0, "title": "Confidencethreshold", "type": "number" }, "criteria": { "items": { "type": "string" }, "title": "Criteria", "type": "array" }, "customPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customprompt" }, "dataTypes": { "default": [ "posts", "comments", "bio", "media_ocr", "links" ], "items": { "$ref": "#/components/schemas/SocialDataType" }, "title": "Datatypes", "type": "array" }, "maxRecords": { "default": 25, "maximum": 100.0, "minimum": 1.0, "title": "Maxrecords", "type": "integer" }, "timeRange": { "anyOf": [ { "$ref": "#/components/schemas/SocialAnalysisTimeRange" }, { "type": "null" } ] } }, "title": "SocialProfileAnalysisMatchConfig", "type": "object" }, "SocialProfileAnalysisRequest": { "additionalProperties": false, "description": "Social Profile Analysis request payload.", "examples": [ { "analysisTypes": [ "match" ], "match": { "criteria": [ "fraud", "theft", "crime" ], "maxRecords": 25 }, "subject": { "name": "John Smith", "socialMediaUrls": [ "https://x.com/johnsmith" ] } } ], "properties": { "analysisTypes": { "default": [ "match" ], "items": { "$ref": "#/components/schemas/AnalysisType" }, "title": "Analysistypes", "type": "array" }, "behavioralAnalysis": { "anyOf": [ { "$ref": "#/components/schemas/BehavioralAnalysisConfig" }, { "type": "null" } ] }, "match": { "$ref": "#/components/schemas/SocialProfileAnalysisMatchConfig" }, "subject": { "$ref": "#/components/schemas/SocialProfileAnalysisSubject" } }, "required": [ "subject", "match" ], "title": "SocialProfileAnalysisRequest", "type": "object" }, "SocialProfileAnalysisResult": { "additionalProperties": false, "description": "Inline or final Social Profile Analysis result payload.", "properties": { "analysisTypes": { "default": [ "match" ], "items": { "$ref": "#/components/schemas/AnalysisType" }, "title": "Analysistypes", "type": "array" }, "behavioralAnalysis": { "anyOf": [ { "$ref": "#/components/schemas/BehavioralAnalysisResult" }, { "type": "null" } ] }, "capability": { "const": "social_profile_analysis", "default": "social_profile_analysis", "title": "Capability", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/SocialMatchedRecord" }, "title": "Items", "type": "array" }, "limit": { "default": 25, "maximum": 100.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "match": { "$ref": "#/components/schemas/MatchAnalysisResult" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "subject": { "$ref": "#/components/schemas/SocialProfileAnalysisSubject" }, "total": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Total" }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" }, "workflowType": { "const": "social_profile_analysis", "default": "social_profile_analysis", "title": "Workflowtype", "type": "string" } }, "required": [ "subject", "match" ], "title": "SocialProfileAnalysisResult", "type": "object" }, "SocialProfileAnalysisRunRequest": { "additionalProperties": false, "description": "Run endpoint payload for Social Profile Analysis.", "examples": [ { "analysisTypes": [ "match" ], "match": { "criteria": [ "fraud", "theft", "crime" ], "maxRecords": 25 }, "responseMode": "sync", "subject": { "name": "John Smith", "socialMediaUrls": [ "https://x.com/johnsmith" ] } } ], "properties": { "analysisTypes": { "default": [ "match" ], "items": { "$ref": "#/components/schemas/AnalysisType" }, "title": "Analysistypes", "type": "array" }, "behavioralAnalysis": { "anyOf": [ { "$ref": "#/components/schemas/BehavioralAnalysisConfig" }, { "type": "null" } ] }, "match": { "$ref": "#/components/schemas/SocialProfileAnalysisMatchConfig" }, "responseMode": { "$ref": "#/components/schemas/ResponseMode", "default": "sync" }, "subject": { "$ref": "#/components/schemas/SocialProfileAnalysisSubject" } }, "required": [ "subject", "match" ], "title": "SocialProfileAnalysisRunRequest", "type": "object" }, "SocialProfileAnalysisSubject": { "additionalProperties": false, "description": "Known profile subject for social profile analysis.", "properties": { "name": { "minLength": 1, "title": "Name", "type": "string" }, "socialMediaUrls": { "items": { "format": "uri", "minLength": 1, "type": "string" }, "minItems": 1, "title": "Socialmediaurls", "type": "array" } }, "required": [ "name" ], "title": "SocialProfileAnalysisSubject", "type": "object" }, "SubjectEthnicity": { "enum": [ "American Indian or Alaska Native", "Asian", "Black or African American", "Hispanic or Latino", "Middle Eastern or North African", "Native Hawaiian or Other Pacific Islander", "White", "Other", "Unknown" ], "title": "SubjectEthnicity", "type": "string" }, "SubjectGender": { "enum": [ "Male", "Female", "Non-binary", "Other", "Unknown" ], "title": "SubjectGender", "type": "string" }, "TargetContext": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "type": { "$ref": "#/components/schemas/TargetContextType", "default": "other" } }, "required": [ "name" ], "title": "TargetContext", "type": "object" }, "TargetContextType": { "enum": [ "person", "organization", "school", "company", "public_figure", "event", "location", "institution", "other" ], "title": "TargetContextType", "type": "string" }, "TimeBucket": { "enum": [ "day", "week", "month" ], "title": "TimeBucket", "type": "string" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "WebContentType": { "enum": [ "article", "post", "video", "forum_thread", "paste", "other" ], "title": "WebContentType", "type": "string" }, "WebPlatform": { "enum": [ "web", "news", "x", "reddit", "youtube", "telegram" ], "title": "WebPlatform", "type": "string" }, "WebSearchDateRange": { "additionalProperties": false, "description": "Date-range filter for web search.", "properties": { "from": { "format": "date", "title": "From", "type": "string" }, "to": { "format": "date", "title": "To", "type": "string" } }, "required": [ "from", "to" ], "title": "WebSearchDateRange", "type": "object" }, "WebSearchItem": { "additionalProperties": false, "description": "Normalized web/media result item.", "properties": { "confidenceCategory": { "$ref": "#/components/schemas/ConfidenceCategory" }, "contentType": { "$ref": "#/components/schemas/WebContentType" }, "displayDomain": { "minLength": 1, "title": "Displaydomain", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "label": { "minLength": 1, "title": "Label", "type": "string" }, "matchRationale": { "items": { "type": "string" }, "title": "Matchrationale", "type": "array" }, "matchedInputs": { "items": { "$ref": "#/components/schemas/MatchedInputReference" }, "title": "Matchedinputs", "type": "array" }, "normalizedAttributes": { "$ref": "#/components/schemas/SanitizedNormalizedAttributes" }, "publishedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publishedat" }, "resultUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full URL for web/media hits. Web results intentionally expose the source URL so investigators can review the underlying page.", "title": "Resulturl" }, "safeMetadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ] }, "title": "Safemetadata", "type": "object" }, "sourceType": { "$ref": "#/components/schemas/WebSourceType" }, "summary": { "minLength": 1, "title": "Summary", "type": "string" }, "type": { "const": "web_hit", "default": "web_hit", "title": "Type", "type": "string" } }, "required": [ "id", "label", "summary", "confidenceCategory", "sourceType", "displayDomain", "contentType" ], "title": "WebSearchItem", "type": "object" }, "WebSearchRequest": { "additionalProperties": false, "description": "Supported request payload for the web/media capability.", "examples": [ { "adverseTerms": [ "fraud", "theft", "crime" ], "subject": { "name": "John Smith", "type": "person" } } ], "properties": { "adverseTerms": { "description": "Optional adverse-media terms to search alongside the subject. The service also uses a built-in adverse/legal/regulatory term pack.", "items": { "type": "string" }, "title": "Adverseterms", "type": "array" }, "dateRange": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchDateRange" }, { "type": "null" } ] }, "maxResults": { "default": 50, "maximum": 100.0, "minimum": 1.0, "title": "Maxresults", "type": "integer" }, "platformFilters": { "default": [ "web", "news" ], "items": { "$ref": "#/components/schemas/WebPlatform" }, "title": "Platformfilters", "type": "array" }, "seedUrls": { "items": { "format": "uri", "minLength": 1, "type": "string" }, "title": "Seedurls", "type": "array" }, "socialAccounts": { "items": { "$ref": "#/components/schemas/WebSearchSocialAccount" }, "title": "Socialaccounts", "type": "array" }, "subject": { "$ref": "#/components/schemas/WebSearchSubject" } }, "required": [ "subject" ], "title": "WebSearchRequest", "type": "object" }, "WebSearchResult": { "additionalProperties": false, "description": "Inline or final web/media result payload.", "properties": { "capability": { "const": "web_search", "default": "web_search", "title": "Capability", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/WebSearchItem" }, "title": "Items", "type": "array" }, "limit": { "default": 50, "maximum": 100.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "total": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Total" }, "warnings": { "items": { "$ref": "#/components/schemas/ApiWarning" }, "title": "Warnings", "type": "array" } }, "title": "WebSearchResult", "type": "object" }, "WebSearchRunRequest": { "additionalProperties": false, "description": "Run endpoint payload for web search.", "examples": [ { "adverseTerms": [ "fraud", "theft", "crime" ], "responseMode": "sync", "subject": { "name": "John Smith", "type": "person" } } ], "properties": { "adverseTerms": { "description": "Optional adverse-media terms to search alongside the subject. The service also uses a built-in adverse/legal/regulatory term pack.", "items": { "type": "string" }, "title": "Adverseterms", "type": "array" }, "dateRange": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchDateRange" }, { "type": "null" } ] }, "maxResults": { "default": 50, "maximum": 100.0, "minimum": 1.0, "title": "Maxresults", "type": "integer" }, "platformFilters": { "default": [ "web", "news" ], "items": { "$ref": "#/components/schemas/WebPlatform" }, "title": "Platformfilters", "type": "array" }, "responseMode": { "$ref": "#/components/schemas/ResponseMode", "default": "sync" }, "seedUrls": { "items": { "format": "uri", "minLength": 1, "type": "string" }, "title": "Seedurls", "type": "array" }, "socialAccounts": { "items": { "$ref": "#/components/schemas/WebSearchSocialAccount" }, "title": "Socialaccounts", "type": "array" }, "subject": { "$ref": "#/components/schemas/WebSearchSubject" } }, "required": [ "subject" ], "title": "WebSearchRunRequest", "type": "object" }, "WebSearchSocialAccount": { "additionalProperties": false, "description": "Exact social account hint to enrich web/media context.", "properties": { "platform": { "anyOf": [ { "$ref": "#/components/schemas/SocialPlatform" }, { "type": "null" } ] }, "profileUrl": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Profileurl" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "title": "WebSearchSocialAccount", "type": "object" }, "WebSearchSubject": { "additionalProperties": false, "description": "Search subject definition for web/media lookups.", "properties": { "aliases": { "items": { "type": "string" }, "title": "Aliases", "type": "array" }, "approximateAge": { "anyOf": [ { "maximum": 130.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Approximateage" }, "bodyTypeBuild": { "anyOf": [ { "$ref": "#/components/schemas/BodyTypeBuild" }, { "type": "null" } ] }, "dateOfBirth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Dateofbirth" }, "driversLicenseState": { "anyOf": [ { "$ref": "#/components/schemas/DriversLicenseState" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "format": "email", "title": "Emailaddress" }, "employer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employer" }, "employmentDateOfHire": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Employmentdateofhire" }, "employmentDepartment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employmentdepartment" }, "employmentLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employmentlocation" }, "employmentRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employmentrole" }, "employmentStatus": { "anyOf": [ { "$ref": "#/components/schemas/EmploymentStatus" }, { "type": "null" } ] }, "ethnicity": { "anyOf": [ { "$ref": "#/components/schemas/SubjectEthnicity" }, { "type": "null" } ] }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/SubjectGender" }, { "type": "null" } ] }, "imageFileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Imagefileid" }, "imageUrl": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Imageurl" }, "languages": { "items": { "type": "string" }, "title": "Languages", "type": "array" }, "militaryStatus": { "anyOf": [ { "$ref": "#/components/schemas/MilitaryStatus" }, { "type": "null" } ] }, "mobilePhoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobilephonenumber" }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "placeOfBirth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Placeofbirth" }, "regions": { "items": { "type": "string" }, "title": "Regions", "type": "array" }, "socialMediaUrls": { "items": { "$ref": "#/components/schemas/WebSearchSubjectSocialMediaUrl" }, "title": "Socialmediaurls", "type": "array" }, "terminationDate": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Terminationdate" }, "type": { "$ref": "#/components/schemas/WebSubjectType" } }, "required": [ "type", "name" ], "title": "WebSearchSubject", "type": "object" }, "WebSearchSubjectSocialMediaUrl": { "additionalProperties": false, "description": "Known social profile URL that belongs to the requested subject.", "properties": { "platform": { "anyOf": [ { "$ref": "#/components/schemas/SocialPlatform" }, { "type": "null" } ] }, "url": { "format": "uri", "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebSearchSubjectSocialMediaUrl", "type": "object" }, "WebSourceType": { "enum": [ "web", "news", "social", "registry", "person_record", "derived" ], "title": "WebSourceType", "type": "string" }, "WebSubjectType": { "enum": [ "person", "organization", "keyword" ], "title": "WebSubjectType", "type": "string" } }, "securitySchemes": { "ApiKeyAuth": { "description": "Primary authentication header. Send the provisioned API key as `X-API-Key: `.", "in": "header", "name": "X-API-Key", "type": "apiKey" }, "BearerApiKey": { "description": "Alternative authentication form. Send the provisioned API key as `Authorization: Bearer `.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "API-first OSINT service for customer intelligence workflows.\n\nAuthentication: send the provisioned API key as `X-API-Key: ` or `Authorization: Bearer `.\n\nAll capability responses return normalized, deduplicated, connector-agnostic outputs. Provider provenance\nand connector-specific identifiers are intentionally excluded from public result payloads. Raw source URLs are\nexcluded except for web/media hits, where `resultUrl` intentionally exposes the full page URL.\n\nEach capability supports inline execution, async job lookup, and server-sent event streaming.", "summary": "Deployable API-first intelligence service for web search, PII expansion, and social profile analysis.", "title": "intelligence-api", "version": "0.1.0" }, "openapi": "3.1.0", "paths": { "/healthz": { "get": { "operationId": "healthz_healthz_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusResponse" } } }, "description": "Successful Response" } }, "summary": "Service liveness check", "tags": [ "system" ] } }, "/readyz": { "get": { "operationId": "readyz_readyz_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusResponse" } } }, "description": "Successful Response" } }, "summary": "Service readiness check", "tags": [ "system" ] } }, "/v1/pii-expansion": { "post": { "description": "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.", "operationId": "run_pii_expansion_v1_pii_expansion_post", "requestBody": { "content": { "application/json": { "examples": { "seededIdentityExpansion": { "description": "Expand from one or more supported email, phone, or username seeds.", "summary": "Seeded identity expansion", "value": { "depth": "standard", "maxCandidates": 10, "responseMode": "sync", "seeds": { "emails": [ "john.smith@example.com" ], "phones": [ "+15555550100" ], "usernames": [ "johnsmith" ] }, "subject": { "name": "John Smith" } } } }, "schema": { "$ref": "#/components/schemas/PiiExpansionRunRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PiiExpansionResult" }, { "$ref": "#/components/schemas/JobEnvelope_PiiExpansionResult_" } ], "title": "Response Run Pii Expansion V1 Pii Expansion Post" } } }, "description": "Normalized identity and related social-candidate results when completed inline, otherwise a job envelope." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Run PII expansion", "tags": [ "pii-expansion" ] } }, "/v1/pii-expansion/jobs/{job_id}": { "get": { "description": "Read the persisted job envelope for one PII-expansion run. When the job has completed, the `result` field contains a paginated page of normalized items controlled by the `limit` and `cursor` query parameters.", "operationId": "get_pii_expansion_job_v1_pii_expansion_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobEnvelope_PiiExpansionResult_" } } }, "description": "Persisted job state with an optional paginated result page." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Read a PII expansion job", "tags": [ "pii-expansion" ] } }, "/v1/pii-expansion/stream": { "post": { "description": "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`.", "operationId": "stream_pii_expansion_v1_pii_expansion_stream_post", "requestBody": { "content": { "application/json": { "examples": { "seededIdentityExpansion": { "description": "Expand from one or more supported email, phone, or username seeds.", "summary": "Seeded identity expansion", "value": { "depth": "standard", "maxCandidates": 10, "seeds": { "emails": [ "john.smith@example.com" ], "phones": [ "+15555550100" ], "usernames": [ "johnsmith" ] }, "subject": { "name": "John Smith" } } } }, "schema": { "$ref": "#/components/schemas/PiiExpansionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Create and stream a PII expansion job", "tags": [ "pii-expansion" ] } }, "/v1/social-profile-analysis": { "post": { "description": "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`.", "operationId": "run_social_profile_analysis_v1_social_profile_analysis_post", "requestBody": { "content": { "application/json": { "examples": { "knownProfileMatch": { "description": "Analyze known social profile URLs against natural-language match criteria.", "summary": "Known-profile match analysis", "value": { "analysisTypes": [ "match" ], "match": { "criteria": [ "fraud", "theft", "crime" ], "maxRecords": 25 }, "responseMode": "sync", "subject": { "name": "John Smith", "socialMediaUrls": [ "https://x.com/johnsmith" ] } } } }, "schema": { "$ref": "#/components/schemas/SocialProfileAnalysisRunRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SocialProfileAnalysisResult" }, { "$ref": "#/components/schemas/JobEnvelope_SocialProfileAnalysisResult_" } ], "title": "Response Run Social Profile Analysis V1 Social Profile Analysis Post" } } }, "description": "Matched social records and optional behavioral analysis when completed inline, otherwise a job envelope." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Run Social Profile Analysis", "tags": [ "social-profile-analysis" ] } }, "/v1/social-profile-analysis/jobs/{job_id}": { "get": { "description": "Read the persisted job envelope for one Social Profile Analysis run. When complete, `result.match.matchedRecords` and `result.items` contain the requested matched-record page.", "operationId": "get_social_profile_analysis_job_v1_social_profile_analysis_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobEnvelope_SocialProfileAnalysisResult_" } } }, "description": "Persisted job state with an optional paginated Social Profile Analysis result." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Read a Social Profile Analysis job", "tags": [ "social-profile-analysis" ] } }, "/v1/social-profile-analysis/stream": { "post": { "description": "Create a persisted Social Profile Analysis job and stream typed server-sent events until completion. Use the `X-Job-Id` response header to reconnect at `GET /v1/social-profile-analysis/jobs/{job_id}/stream`.", "operationId": "stream_social_profile_analysis_v1_social_profile_analysis_stream_post", "requestBody": { "content": { "application/json": { "examples": { "knownProfileMatch": { "description": "Analyze known social profile URLs against natural-language match criteria.", "summary": "Known-profile match analysis", "value": { "analysisTypes": [ "match" ], "match": { "criteria": [ "fraud", "theft", "crime" ], "maxRecords": 25 }, "subject": { "name": "John Smith", "socialMediaUrls": [ "https://x.com/johnsmith" ] } } } }, "schema": { "$ref": "#/components/schemas/SocialProfileAnalysisRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Create and stream a Social Profile Analysis job", "tags": [ "social-profile-analysis" ] } }, "/v1/web-search": { "post": { "description": "Create a web-search 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.", "operationId": "run_web_search_v1_web_search_post", "requestBody": { "content": { "application/json": { "examples": { "personAdverseMedia": { "description": "Search public web/media with built-in adverse discovery for a person subject.", "summary": "Person web/media search", "value": { "adverseTerms": [ "fraud", "theft", "crime" ], "responseMode": "sync", "subject": { "name": "John Smith", "type": "person" } } } }, "schema": { "$ref": "#/components/schemas/WebSearchRunRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchResult" }, { "$ref": "#/components/schemas/JobEnvelope_WebSearchResult_" } ], "title": "Response Run Web Search V1 Web Search Post" } } }, "description": "Normalized search hits when completed inline, otherwise a job envelope." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Run web/media search", "tags": [ "web-search" ] } }, "/v1/web-search/jobs/{job_id}": { "get": { "description": "Read the persisted job envelope for one web-search run. When the job has completed, the `result` field contains a paginated page of normalized items controlled by the `limit` and `cursor` query parameters.", "operationId": "get_web_search_job_v1_web_search_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobEnvelope_WebSearchResult_" } } }, "description": "Persisted job state with an optional paginated result page." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Read a web/media search job", "tags": [ "web-search" ] } }, "/v1/web-search/stream": { "post": { "description": "Create a persisted web-search job and immediately stream typed server-sent events until completion. Use the `X-Job-Id` response header to reconnect at `GET /v1/web-search/jobs/{job_id}/stream` with `Last-Event-ID`.", "operationId": "stream_web_search_v1_web_search_stream_post", "requestBody": { "content": { "application/json": { "examples": { "personAdverseMedia": { "description": "Search public web/media with built-in adverse discovery for a person subject.", "summary": "Person web/media search", "value": { "adverseTerms": [ "fraud", "theft", "crime" ], "subject": { "name": "John Smith", "type": "person" } } } }, "schema": { "$ref": "#/components/schemas/WebSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "BearerApiKey": [] }, { "ApiKeyAuth": [] } ], "summary": "Create and stream a web/media search job", "tags": [ "web-search" ] } } }, "servers": [ { "description": "Production Intelligence API", "url": "https://api.ie.intrace.ai" } ], "tags": [ { "description": "Search public web, news, and supported public social surfaces for adverse-media or subject-mention hits.", "name": "web-search" }, { "description": "Expand known identifiers (email, phone, and username) into normalized identity candidates.", "name": "pii-expansion" }, { "description": "Analyze known social profile URLs: base Match returns matching records, optional Behavioral Analysis explains patterns and risk signals.", "name": "social-profile-analysis" }, { "description": "Operational liveness and readiness endpoints.", "name": "system" } ] }