1. Base URL https://rest-api.argosidentity.com/v3/faceauth 2. Authentication Include the API key in the x-api-key header:
3. Request Example curl -X GET "https://rest-api.argosidentity.com/v3/faceauth" \ -H "x-api-key: {yourAPIKey}" \ 4. Request Parameters Example with Parameters
curl -X GET "https://rest-api.argosidentity.com/v3/faceauth?auth_id={auth_id}&startDate={startDate}" \ -H "x-api-key: {yourAPIKey}" \ Used for retrieving a specific submission. If authId is provided, only the corresponding submission is returned; otherwise, the full list is retrieved.
Start date of the query (yyyy-mm-dd format). To filter data within a specific period, both startDate and endDate must be provided.
End date of the query (yyyy-mm-dd format).
The authId value from the nextPage_key object in the response of the previous request.
The createTime value from the nextPage_key object in the response of the previous request.
Specifies the number of data entries to retrieve (minimum 1, maximum 2,000). If not provided, the default value is 2,000.
Maximum retrieval limit : A single request can retrieve up to 2,000 entries.Fetching additional data : If more data is available, the response includes the nextPage_key object.
To continue retrieving data, use nextPage_key’s authId as nextKey_id and createTime as nextKey_date in the next request. 5. Response 5-1. Response (delete_check:false) [ { "faceAuth_projectId" : "sampleProjectId1" , "data" : [ { "policy" : { "faceSimilarity_threshold" : 85 , "occluded_threshold" : false , "faceCover_threshold" : 0 , "headCover_threshold" : 0 , "liveness_threshold" : 0 , "activeLiveness_threshold" : 0 }, "auth_id" : "sampleId1" , "auth_status" : "rejected" , "create_time" : "2025-10-02T02:15:17.554Z" , "submit_type" : "form" , "kyc_submission_id" : "sampleKycId1" , "delete_check" : false , "result" : { "active_liveness_score" : 97.78668212890625 , "face_similarity" : 100 , "detectOccluded" : true }, "reject_comment" : [ "face is occluded and the confidence is higher than threshold." ], "fail_code" : [ "Face_Occluded_fail" ] }, { "policy" : { "faceSimilarity_threshold" : 85 , "occluded_threshold" : false , "faceCover_threshold" : 0 , "headCover_threshold" : 0 , "liveness_threshold" : 0 , "activeLiveness_threshold" : 0 }, "auth_id" : "sampleId2" , "auth_status" : "rejected" , "create_time" : "2025-10-02T02:15:17.554Z" , "submit_type" : "form" , "kyc_submission_id" : "sampleKycId1" , "delete_check" : true , "delete_time" : "2025-10-09T03:18:18.046Z" "result" : { "active_liveness_score" : 97.78668212890625 , "face_similarity" : 100 , "detectOccluded" : true }, "reject_comment" : [ "face is occluded and the confidence is higher than threshold." ], "fail_code" : [ "Face_Occluded_fail" ] } ], "nextPage_key" : { "authId" : "sampleId2" , "createTime" : "2025-10-02T02:15:17.554Z" } } ] 5-2. 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" , "result" : { "active_liveness_score" : 97.78668212890625 , "face_similarity" : 100 , "detectOccluded" : true }, } ] 5-2. Response Example Array of retrieved submissions Individual submission object Threshold policy object applied for authentication Face similarity threshold
Face occlusion detection threshold (goggles, masks, protective equipment)
Head protection equipment detection threshold
Whether the face is obscured by hands or other objects
Passive liveness threshold
Active liveness threshold
Unique authentication ID for each submission
Authentication result (e.g., approved, rejected)
Submission date and time (UTC+0)
ID of the KYC submission where FaceAuth was performed
Whether the data has been deleted
Deletion date and time (UTC+0)
Authentication result data object Face similarity result value
Result value indicating whether the face is covered by hands or specific objects
Face occlusion detection result value (goggles, masks, protective equipment)
Head protection equipment detection result value
Passive liveness result value
Active liveness result value
Key object for retrieving the next page create_time of the key for retrieving the next page
authId of the key for retrieving the next page
5-3. Error Codes If an error occurs, a 400 status code is returned along with details in the response body:
{ traceId : ' 0199 cb 93 -bdf 1-77 ef -8 cd 4-3 d 38 dec 61830 ' , errorCode : 'NOT_FOUND' , message : 'faceAuth_project not found' } Error Code Description faceAuth_project not foundThis error occurs when there is no valid project corresponding to the submitted API-Key. Please check if your API-Key is correct.
