API Documentation

Face Verification API

Face Verification

POST https://api.iapp.co.th/face_compare

This URL allows you to verify two faces. by submitting the results and scores for the similarity of the two faces.

Headers

NameTypeDescription

apikey*

String

The API Key to call this API

Request Body

NameTypeDescription

file1*

File

The binary data of the image

file2*

File

The binary data of the image

company

String

The company name

min_score

String

The minimum score of face verification for this request

{
    "message": "successfully performed",
    "process_time": 0.3729121685028076,
    "result": "matched",
    "similarity_score": 0.5220710916461694
}

Parameter in Response

NameTypeDescription

message

String

The processing status

process_time

Float

The processing time

result

String

The similarity result of verification

similarity_score

Float

The similarity score of verification

Sample Requests

// Use default score
curl --location -g --request POST 'https://api.iapp.co.th/face_compare' \
--header 'apikey: {Your API Key}' \
--form 'file1=@"{Your Image File Path 1}"' \
--form 'file2=@"{Your Image File Path 2}"'

// Use score of each company
--form 'company="{Your Company Name}"'

// Use min_score
--form 'min_score="{Your Minimun Score}"'

Face Verification Tool

Default Score Configuration

GET https://api.iapp.co.th/face_config_score

This URL be for configure the default score of face verification for each company or check the default score

Query Parameters

NameTypeDescription

detection*

String

The default score of detection

comparison*

String

The default score of verification

company*

String

The name of customer company

password*

String

The password of customer company

Headers

NameTypeDescription

apikey*

String

The API Key to call this API

{
    "company": "iApp",
    "comparison_score": 0.4,
    "detection_score": 0.98,
    "message": "the minimum score of comparison has been successfully configured.",
}

Parameter in Response

NameTypeDescription

company

String

The company name

comparison_score

Float

The default score of comparison

detection_score

Float

The default score of detection

message

String

The Processing status

Sample Requests

// Configure Score
curl --location -g --request GET 'https://api.iapp.co.th/face_config_score?detection={Detection Value}&comparison={Comparison Value}&company={Your Company Name}&password={Your Company Password}' \
--header 'apikey: {Your API Key}'
  
// Show Score
curl --location -g --request GET 'https://api.iapp.co.th/face_config_score?detection&comparison&company={Your Company Name}&password={Your Company Password}' \
--header 'apikey: {Your API Key}'

Last updated