It is designed around a simple workflow:
Create an analysis session
Submit or upload interview data
Sherlock processes the recording
Receive a webhook notification
Retrieve the completed report
Core Concepts
Before using the API, it's important to understand the key objects in Sherlock.
Interview (Session)
The Interview is the primary object in the API.
It represents a recording or interview session submitted for analysis.
Session Report
After analysis is complete, Sherlock generates a Session Report.
This report contains all analysis results and can be retrieved through the API.
Integrity Score
A summary score indicating how closely the interview aligned with expected interview behavior.
The Integrity Score should be considered a decision-support signal and reviewed alongside the supporting evidence provided in the report.
Flags
Flags represent specific patterns, anomalies, or risk indicators detected during analysis.
Examples may include:
Behavioral anomalies
Response consistency concerns
Suspicious interview patterns
Deepfake detection indicators
Deepfake Detection
Sherlock includes advanced identity verification capabilities designed to identify signs of synthetic media manipulation.
Analysis may include:
Synthetic video detection
Face-swapping indicators
Voice cloning indicators
Biometric inconsistencies
Timeline
A chronological record of notable events and observations generated during analysis.
Insights
AI-generated summaries that highlight important observations from the interview.
Insights may include:
Behavioral observations
Risk indicators
Response consistency patterns
Interview integrity findings
API Capabilities
The Sherlock API is organized into four primary capability areas.
1. Session Management
Create and manage analysis sessions.
Use this to:
Create sessions
Retrieve session details
Manage session lifecycle
2. Reports & Insights
Access analysis results generated by Sherlock.
Use this to:
Retrieve Session Reports
Review Integrity Scores
Review Flags and Timeline data
Access AI-generated Insights
Review deepfake detection findings
3. Recordings
Access submitted interview recordings.
Use this to:
Retrieve recordings
Store analysis records
Review interview data
4. Video Analysis
Submit recordings for analysis.
Use this to:
Process interview recordings
Generate fraud detection reports
Retrieve analysis results asynchronously
Typical API Flow
A standard integration follows this sequence:
The report can then be displayed inside your ATS, hiring platform, or internal review workflow.