Access Documentation
Anti-Forgery Detection
Starscope
Starscope
# StarScope Anti-Forgery
# Changelog
| Version | Completion date | Change description |
|---|---|---|
| 1.0.0 | 2026/05/26 | StarScope API officially released and launched overseas. |
# Description
This API is used for deepfake detection, identifying whether the uploaded image/video is AI-generated. Based on large-model algorithms, it effectively defends against face synthesis risks.
# Request URL
Singapore: https://api-sgp.yljz.com/finauth/v5/anti_deepfake
Indonesia: https://api-idn.yljz.com/finauth/v5/anti_deepfake
# Request Method
POST — Note: Use form-data format for the request.
# Authorization
The FinAuth Web APIs can be called only after the user has integrated the FinAuth product. Please consult FinAuth business personnel for the integration process.
# Parameters
| Required/Optional | Parameter | Type | Description |
|---|---|---|---|
| Required | sign | String | For the specific method of generating the signature, refer to the Authentication Guide. |
| Required | sign_version | String | Signature algorithm version. Currently only "hmac_sha1" is supported. |
| Required | data_type | int | Data type.0: image1: video |
| Required | image | File | The image to be detected, passed in when data_type=0. Recommendations for the uploaded image:• Image size no more than 10 MB; only JPG and PNG formats are supported.• Recommended image resolution is 480P (720P maximum supported).• Recommended face size no smaller than 100×100. |
| Required | video | File | The video to be detected, passed in when data_type=1. Recommendations for the uploaded video:• The video must be in a format supported by FFmpeg; the size after Base64 encoding must not exceed 10 MB. The recommended duration is 2 to 5 seconds and must not exceed 20 seconds.• Recommended video resolution is 480P (720P maximum supported), with a frame rate between 25 fps and 30 fps.• Recommended face size no smaller than 100×100.• The video supports upright detection and is automatically rotated to the correct orientation. |
# Response Description
| Parameter | Type | Description |
|---|---|---|
| request_id | String | Request ID, a unique string used to distinguish each request. This field is always returned except when error 404 (API_NOT_FOUND) occurs. |
| time_used | Int | Request time consumption; the total time spent on the request, in milliseconds. |
| result | Bool | The result of the deepfake detection. Values are True or False. False indicates it is not a deepfake; True indicates it is a deepfake. |
| score | Float | The score of the deepfake detection. Value range is [0,1]. A higher score indicates a greater possibility of an attack. |
| threshold | Float | The threshold for deepfake detection. Value range is [0,1]. The default value is 0.5. |
| error | String | Error message. This string is returned only when the request fails; see the error information section below for details. Otherwise this field does not exist. |
# Error Codes
| HTTP status code | Error message | Description |
|---|---|---|
| 400 | MISSING_ARGUMENTS: |
A required parameter is missing. |
| 400 | BAD_ARGUMENTS | A parameter failed to parse (for example, a numeric value is required but a non-numeric string was input, or the length is too long), or the input image/video format is invalid and parsing failed. |
| 400 | NO_FACE_FOUND | No face was detected in the input image or video. |
| 400 | INVALID_IMAGE_SIZE: | Image size exceeds the limit. In some cases the key indicating the oversized field is attached. |
| 400 | INTERNAL_TIMEOUT | Request timeout. |
| 403 | AUTHENTICATION_ERROR | Invalid signature. |
| 403 | AUTHENTICATION_ERROR: |
The api_key is disabled, the call limit is exceeded, there is no permission to call this API, or no permission to call this API in the current manner. Valid |
| 403 | CONCURRENCY_LIMIT_EXCEEDED | The concurrency limit is exceeded. |
| 404 | API_NOT_FOUND | The API does not exist. |
| 413 | Request Entity Too Large | The request size sent by the client exceeds the limit. This error is returned in plain text format, not JSON. |
| 500 | INTERNAL_ERROR | Internal server error. If this error persists, contact Yuanli customer service or business personnel promptly. |
| 504 | 504 Gateway Timeout | Request timeout. |
