Skip to main content
GET
/
v1
/
deepfake-detection
List Analyses
curl --request GET \
  --url https://api.deepidv.com/v1/deepfake-detection
{
  "analyses": [
    {
      "id": "da_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "completed",
      "file_name": "passport_scan.pdf",
      "file_type": "document",
      "external_id": "doc-review-789",
      "created_at": "2025-01-15T10:30:00.000Z",
      "completed_at": "2025-01-15T10:30:18.000Z",
      "result": {
        "is_ai_generated": true,
        "confidence_score": 87.3,
        "risk_level": "critical"
      }
    },
    {
      "id": "da_b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "completed",
      "file_name": "applicant_headshot.jpg",
      "file_type": "image",
      "created_at": "2025-01-15T09:15:00.000Z",
      "completed_at": "2025-01-15T09:15:08.000Z",
      "result": {
        "is_ai_generated": false,
        "confidence_score": 8.1,
        "risk_level": "low"
      }
    }
  ],
  "next_token": "eyJpZCI6ImRhX2IyYzNkNGU1In0"
}

GET /v1/deepfake-detection
Returns a paginated list of deepfake detection analyses. Use query parameters to filter by status, file type, or date range.

​
Request

​
Headers

HeaderRequiredDescription
x-api-keyYesYour API key

​
Query parameters

ParameterTypeRequiredDefaultDescription
limitnumberNo50Number of results to return (1—500)
next_tokenstringNo—Pagination token from a previous response
statusstringNo—Filter by status: processing, completed, failed
file_typestringNo—Filter by file type: document, image, audio, video
start_datestringNo—Filter analyses created on or after this date (ISO 8601)
end_datestringNo—Filter analyses created on or before this date (ISO 8601)
external_idstringNo—Filter by your external reference ID

​
Example requests

​
List all analyses (default)

curl -X GET "https://api.deepidv.com/v1/deepfake-detection?limit=25&start_date=2025-01-01T00:00:00Z" \
  -H "x-api-key: YOUR_API_KEY"

​
Filter by status

curl -X GET "https://api.deepidv.com/v1/deepfake-detection?status=completed&limit=100" \
  -H "x-api-key: YOUR_API_KEY"

​
Response

​
200 — Success

FieldTypeDescription
analysesarrayArray of analysis summary objects
next_tokenstring | nullPagination token to fetch the next page. null when no more results
List responses include summary fields only. Use Retrieve Analysis for full results including detection_details.

​
Pagination

To fetch the next page of results, pass the next_token from the response as a query parameter: 
curl -X GET "https://api.deepidv.com/v1/deepfake-detection?limit=25&next_token=eyJpZCI6ImRhX2IyYzNkNGU1In0" \
  -H "x-api-key: YOUR_API_KEY"
Continue paginating until next_token is null.

​
Error responses

StatusDescription
400 Bad RequestInvalid query parameters (e.g., limit out of range, invalid date format, invalid next_token)
401 UnauthorizedMissing or invalid API key
429 Too Many RequestsRate limit exceeded
{
  "analyses": [
    {
      "id": "da_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "completed",
      "file_name": "passport_scan.pdf",
      "file_type": "document",
      "external_id": "doc-review-789",
      "created_at": "2025-01-15T10:30:00.000Z",
      "completed_at": "2025-01-15T10:30:18.000Z",
      "result": {
        "is_ai_generated": true,
        "confidence_score": 87.3,
        "risk_level": "critical"
      }
    },
    {
      "id": "da_b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "completed",
      "file_name": "applicant_headshot.jpg",
      "file_type": "image",
      "created_at": "2025-01-15T09:15:00.000Z",
      "completed_at": "2025-01-15T09:15:08.000Z",
      "result": {
        "is_ai_generated": false,
        "confidence_score": 8.1,
        "risk_level": "low"
      }
    }
  ],
  "next_token": "eyJpZCI6ImRhX2IyYzNkNGU1In0"
}