Submit async deepfake check

POST

/v2/deepfake/checks

Submit a video for anti-video forgery / deepfake analysis. Returns immediate 201 response with check status.

Authorizations

• ApiKeyAuth

Request Body ^required

object

request

required

object

user_id

required

string

>= 1 characters <= 128 characters /^[A-Za-z0-9._:@-]+$/

display_name

Optional human-readable label for the user (e.g. an email), recorded on the transaction for display. Never used as an identity; user_id remains the biometric key.

string

<= 256 characters

session_id

string format: uuid

nullable

video

required

Video file to check.

string format: binary

Responses

201

Deepfake check accepted for processing.

object

data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object

status

Decision status from the scoring engine (e.g. pass, fail, refer).

string

score

number

reasons

Array<string>

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

data

Acknowledgement returned when a check is submitted. Poll with metadata.request_id — not with the envelope’s meta.request_id, which identifies the HTTP call.

object

success

boolean

message

string

prediction

string

nullable

confidence

number

nullable

score

number

nullable

metadata

object

request_id

The check identifier to poll with.

string format: uuid

source_filename

string

received_at

Unix timestamp (seconds).

integer format: int64

key

additional properties

any

key

additional properties

any

400

Bad Request / Parameter Validation Failed.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

422

Unprocessable Entity / Face not detected, audio unreadable, or file payload syntax error.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>