Skip to content

Deepfake Check (Status)

Retrieve the current status and results of a previously submitted deepfake check. Poll this endpoint until status is completed or failed.

Endpoint

GET /api-gateway/v2/deepfake/checks/:request_id

Authentication

Requires a valid API token in the Authorization header.

Authorization: Bearer <your-api-key>

Path Parameters

ParameterTypeDescription
request_idstringThe check id returned from the Deepfake Check (Submit) endpoint

Example Request

Terminal window
curl 'https://api.biometrysolutions.com/api-gateway/v2/deepfake/checks/246fcaf1-0c88-4b21-a96c-05cabefcef55' \
-H 'Authorization: Bearer <your-api-key>'

Response (Completed)

Status: 200 OK

{
"data": {
"id": "246fcaf1-0c88-4b21-a96c-05cabefcef55",
"status": "completed",
"score": 0.98,
"prediction": "fake",
"message": "Inference completed successfully",
"created_at": 1763007610,
"completed_at": 1763008367
},
"meta": { "request_id": "fc5605c5-...", "message": "deepfake check state" }
}

Response Fields (data)

FieldTypeDescription
idstringUnique identifier for the check.
statusstringCurrent status: pending, processing, completed, or failed.
scorenumber | nullDeepfake probability (0.0–1.0). null until completed.
predictionstring | nullClassification, e.g. real or fake. null until completed.
messagestring | nullHuman-readable status/result message.
created_atnumberUnix timestamp (seconds) when the check was created.
completed_atnumberUnix timestamp (seconds) when processing completed (present when completed).

Status Values

StatusDescription
pendingCheck received, queued for processing
processingVideo is currently being analysed
completedAnalysis finished successfully
failedAnalysis failed (check message)

Error Responses

StatusDescription
401 UnauthorizedMissing or invalid API token
404 Not FoundCheck id not found
500 Internal Server ErrorServer error

Client Implementation Tips

Poll every 2–5 seconds until status is completed or failed. Processing typically completes within 1–2 minutes.

async function pollDeepfakeCheck(id, token) {
while (true) {
const res = await fetch(
`https://api.biometrysolutions.com/api-gateway/v2/deepfake/checks/${id}`,
{ headers: { Authorization: `Bearer ${token}` } },
);
const { data } = await res.json();
if (data.status === 'completed' || data.status === 'failed') return data;
await new Promise((r) => setTimeout(r, 3000));
}
}