1. URL base https://rest-api.argosidentity.com/v3/faceauth
2. Autenticación Incluya la clave API en el encabezado x-api-key:
3. Ejemplo de solicitud curl -X GET "https://rest-api.argosidentity.com/v3/faceauth" \ -H "x-api-key: {yourAPIKey}" \
4. Parámetros de solicitud Ejemplo con parámetros
curl -X GET "https://rest-api.argosidentity.com/v3/faceauth?auth_id={auth_id}&startDate={startDate}" \ -H "x-api-key: {yourAPIKey}" \
Se utiliza para consultar un envío específico. Si se proporciona authId, solo se devuelve el envío correspondiente; de lo contrario, se obtiene la lista completa.
Fecha de inicio de la consulta (formato yyyy-mm-dd). Para filtrar datos dentro de un período específico, deben proporcionarse tanto startDate como endDate.
Fecha de fin de la consulta (formato yyyy-mm-dd).
El valor authId del objeto nextPage_key en la respuesta de la solicitud anterior.
El valor createTime del objeto nextPage_key en la respuesta de la solicitud anterior.
Especifica el número de entradas de datos a obtener (mínimo 1, máximo 2.000). Si no se proporciona, el valor predeterminado es 2.000.
Límite máximo de consulta : Una única solicitud puede obtener hasta 2.000 entradas.Obtención de datos adicionales : Si hay más datos disponibles, la respuesta incluye el objeto nextPage_key.
Para continuar obteniendo datos, use el authId de nextPage_key como nextKey_id y createTime como nextKey_date en la siguiente solicitud. 5. Respuesta 5-1. Respuesta (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" ], "signals" : { "cameraProcessInfo" : [ { "processStartTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" , "processEndTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" , "type" : "faceAuth-active" , "error" : null } ], "startButtonClickTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" } }, { "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" ], "signals" : { "cameraProcessInfo" : [ { "processStartTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" , "processEndTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" , "type" : "faceAuth-active" , "error" : null } ], "startButtonClickTime" : "YYYY-MM-DD-HH-MM-SS-ZZZ" } } ], "nextPage_key" : { "authId" : "sampleId2" , "createTime" : "2025-10-02T02:15:17.554Z" } } ]
5-2. Respuesta (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. Ejemplo de respuesta Array de envíos obtenidos Objeto de envío individual Objeto de política de umbrales aplicado para la autenticación Umbral de similitud facial
Umbral de detección de oclusión facial (gafas, mascarillas, equipo de protección)
Umbral de detección de equipo de protección para la cabeza
Si el rostro está oculto por manos u otros objetos
Umbral de liveness pasivo
Umbral de liveness activo
ID de autenticación único para cada envío
Resultado de autenticación (por ejemplo, approved, rejected)
Fecha y hora del envío (UTC+0)
ID del envío KYC donde se realizó FaceAuth
Si los datos han sido eliminados
Fecha y hora de eliminación (UTC+0)
Objeto de datos del resultado de autenticación Valor del resultado de similitud facial
Valor del resultado que indica si el rostro está cubierto por manos u objetos específicos
Valor del resultado de detección de oclusión facial (gafas, mascarillas, equipo de protección)
Valor del resultado de detección de equipo de protección para la cabeza
Valor del resultado de liveness pasivo
Valor del resultado de liveness activo
Objeto de datos adicionales generado durante el proceso Marca de tiempo cuando el usuario hizo clic en el botón de inicio (formato ISO 8601)
Array de datos de operación de la cámara Tipo de proceso (por ejemplo, faceAuth-passive o faceAuth-active.)
Marca de tiempo cuando el proceso comenzó (formato ISO 8601)
Marca de tiempo cuando el proceso terminó (formato ISO 8601)
Error que ocurrió durante el proceso (null si no hay error)
Objeto clave para obtener la siguiente página create_time de la clave para obtener la siguiente página
authId de la clave para obtener la siguiente página
5-3. Códigos de error Si ocurre un error, se devuelve un código de estado 400 junto con detalles en el cuerpo de la respuesta:
{ traceId : ' 0199 cb 93 -bdf 1-77 ef -8 cd 4-3 d 38 dec 61830 ' , errorCode : 'NOT_FOUND' , message : 'faceAuth_project not found' }
Código de error Descripción faceAuth_project not foundEste error ocurre cuando no existe un proyecto válido correspondiente a la API-Key enviada. Verifique si su API-Key es correcta.
