GET/FaceAuth

Input Data

• It's imperative to include the Add On-specific API-Key in the Header when sending a request. (Mandatory)

• When querying a specific submission record (single entry), you must provide the corresponding Authentication ID. If the Authentication ID is not submitted, a query will return the complete list.

• When querying a list of submissions within a specific date range, both startDate and endDate must be submitted. The date format should be yyyy-mm-dd.

• You can specify the number of submission records to query in a single request using the count parameter. This can be any value between 1 and 2,000. If not specified, the default value of 2,000 will be used.

• The maximum number of records you can query in a single request is limited to 2,000. If there are more records to be retrieved, a nextPage_key object will be returned in the response. To continue querying, send the authId within nextPage_key as nextKey_id and createTime as nextKey_date in the request parameters.

Parameter	Format	requirement	Description
authId	string	optional	-'authId' provided: Queries a specific submission record (single entry). -'authId' not provided: Queries the complete list of submission records within the corresponding faceAuth_project.
startDate	string	optional	Start date for query (yyyy-mm-dd)
endDate	string	optional	End date for query (yyyy-mm-dd)
nextKey_id	string	optional	The 'authId' from the nextPage_key object in response of the previous request
nextKey_date	string	optional	The 'createTime' from the nextPage_key object in the response of the previous request
count	number	optional	Number of records to query (minimum 1 ~ maximum 2,000). If not specified, the default is 2,000 records.

Output Data

Properties	Format	description
faceAuth_projectId	string	faceAuth project ID
data	array	Array containing the queried submission records.
data[i]	object	Individual submission record objects
data[i].auth_id	string	Unique ID of each submission record (Authentication ID)
data[i].auth_status	string	Authentication result
data[i].create_time	string	Start time of the submission
data[i].submit_type	string	Submission method
data[i].kyc_submission_id	string	KYC Submission ID
data[i].policy	object	Threshold policy object applied in authentication
data[i].policy.faceSimilarity_threshold	number	Facial similarity threshold
data[i].policy.faceCover_threshold	number	Face covering threshold
data[i].policy.headCover_threshold	number	Helmet Wearing Threshold
data[i].policy.occluded_threshold	boolean	Face occlusion status
data[i].delete_check	boolean	Data deletion result
data[i].delete_time	string	Deleted time

Request URL

curl -X GET "https://rest-api.argoskyc.com/v3/faceauth" \
-H "x-api-key: {yourAPIKey}" \

Sample Response - delete_check: false

[
        {
            auth_id : "sampleId1", 
			aurh_status : "approved",
			create_time : "2023-08-18T15:00:00.000Z",
			submit_type : "sampleType",
			kyc_submission_id : "sampleKycId1",
			policy : {
				faceSimilarity_threshold : 70,
				occluded_threshold : false, 
				faceCover_threshold : 0,
				headCover_threshold : 50
			},
            "delete_check": false
        },
]

Sample Response - delete_check: true

[     
       { 
            auth_id : "sampleId1", 
			aurh_status : "approved",
			create_time : "2023-08-18T15:00:00.000Z",
			submit_type : "sampleType",
			kyc_submission_id : "sampleKycId1",
			policy : {
				faceSimilarity_threshold : 70,
				occluded_threshold : false, 
				faceCover_threshold : 0,
				headCover_threshold : 50
			},
            "delete_check": true,
            "delete_time": "2023-09-04T02:19:01.399Z"
        },
]

Error Code

400 Error

• In case of a submission failure in Face Auth, an error code along with a message explaining the reason for the failure will be provided.

Message	description
faceAuth_project not found	If there is no valid project associated with the submitted API-Key, an error will occur. Please verify your API-Key.