Vedio Verification API Mode

4 min

Introduction

This curl command is an example of how to make a request to the Signzy API v2 for video forensics. The API provides various video analysis services, including identifying matching images within a video. The command specifies the request method as POST and includes the URL for the video forensics endpoint with the patron ID. The headers contain the necessary authorization and content-type information, and the data payload includes the task type and essential parameters required for the video analysis. This API is useful for applications that require video analysis services, such as surveillance systems or media content platforms.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../videoforensics \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"videoApiMode","essentials":{"toMatchImage":"...matchImage url..","videoUrl":"...video url..."}}'

Parameter	Description
request	The HTTP request method, which is POST in this case.
url	The URL of the Signzy API v2 endpoint for video forensics, with the patron ID.
Accept	The media type(s) that are acceptable for the response.
Accept-Language	The preferred natural language(s) for the response.
Authorization	The access token used to authorize the API request.
content-type	The media type of the request body, which is application/json.
task	The type of video analysis task to perform.
essentials	A JSON object containing essential parameters for the video analysis task.
toMatchImage	The URL of the image to match within the video.
videoUrl	The URL of the video to analyze.

Sample Response

{
        "essentials": {
            "toMatchImage": "...image url...",
            "videoUrl": "...video url..."
        },
        "id": "...xxxx...",
        "patronId": "...xxxx....",
        "task": "videoApiMode",
        "result": {
            "faceMatch": {
                "matchScore": "...some float value...",
                "isMatch": "no/yes"
            },
            "extractedFacesFromVideos": [
                "...extracted faces image url from video...."                
            ],
            "videoQuality": {
                "VideoQualityScore": "...score between 0-100...",
                "isValid": "yes/no"
            }
        }
      }

Key

essentials

object

An object containing essential information for the task

essentials.toMatchImage

string (url)

The image URL to match with the extracted faces from the video

essentials.videoUrl

string (url)

The video URL from which faces will be extracted and matched with the image

string

Unique ID for the task

patronId

string

Unique ID for the patron requesting the task

task

string

The task to be performed, in this case 'videoApiMode'

result

object

An object containing the result of the task

result.faceMatch

object

An object containing the result of face matching

result.faceMatch.matchScore

float

A score indicating the level of similarity between the faces in the video and the given image

result.faceMatch.isMatch

string ('yes' or 'no')

Indicates whether the faces in the video match the given image ('yes') or not ('no')

result.extractedFacesFromVideos

array of strings (urls)

URLs of the extracted faces from the video