📨 [POST] Search Face

Retrieve the same Face as the submitted image.

Type : POST

Endpoint: https://face.argosidentity.com/search

Input Data (Body):

Key	Format	Required	Description
collectionId	string	O	The unique ID of the collection whose Face you want to look up.
requestName	string	O	The name that matches the Face image.
faceImage	string (Base 64)	O	The base64 string of the Face image.

Output Data:

Key	Format	Description
message	string	The success or error message.
searchId	string	The unique ID of the search request.
requestName	string	The name submitted in the search request.
faceIdList	Array	An array of unique IDs of the faces that matched the submitted image.
faceIdList[i]	string	The unique ID of each face.
option	object	The options object applied to the search request.
option.option_liveness	boolean	Whether the liveness option is applied.
option.liveNess_threshold	number	Liveness option threshold.
option.liveNessScore	number	Liveness result score.
option.policy_similarity	number	Similarity option threshold.

Error (403)

Error code	Error message	Description
6039	API Key is required.	Missing API Key: x-api-key is missing in header
6040	Access Denied: API Key is unavailable.	Unregistered API Key: Access restriction

Error (400)

Error code	Error message	Description
6030	CollectionId is required.	CollectionId is missing
6031	RequestName is required.	requestName is missing
6032	Invalid face image.	faceImage is missing
6033	Cannot find collection info.	If the collection information doesn't exist
6034	This collection is unavailable.	The collection has already been deleted
6035	Failed to validate liveness of face	When a liveness error occurs
6036	Image size is too large.	Image is too large
6037	Not supported image format.	Image is not formatted correctly
6038	Fail to search face	Unspecified errors

Request Headers

x-api-key : "string"

Request Data

{
    "collectionId" : "string",
    "faceImage" : "string",
		"userName" : "string"
}

Response

{
    "message": "success",
    "searchId": "string",
    "userName": "string",
    "option": {
        "option_liveness": Boolean,
        "liveNess_threshold": number,
        "liveNessScore": number,
        "policy_similarity": number
    },
    "faceIdList": [
        "string"
    ]
}

Error Response

{
   errorCode: number,
   message: "string"
}