Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

Antes de empezar — FaceAuth tiene dos métodos de entrega.Este API es el método de cámara implementada por el cliente: su aplicación captura el selfie y envía el archivo de imagen. Este método no admite Active Liveness, por lo que no puede bloquear intentos de suplantación como replays de pantalla o fotos impresas. Si necesita verificación de presencia física (liveness), utilice el método Face Auth URL.→ Comparación de métodos y configuración de URL: Primeros pasos de Add-on · Guía de FACE AUTH
Notas
  • El resultado de la autenticación se determina según la configuración de opciones y los valores de umbral, devolviendo approved o rejected.
  • Especificaciones recomendadas de faceImage: 960 x 720
  • Cómo verificar submissionId: Inicie sesión en el dashboard, vaya a Settings > Liveform URL y complete el proceso de ID Check. Una vez que el ID Check sea aprobado, puede encontrar los datos de submissionId en el menú User Management > Submission List del dashboard.
    • El estado final del ID Check debe ser approved.
  • Información de clave API: Se requiere una clave API separada de la clave API existente del liveform. Puede verificar su clave API de Add-on en Primeros pasos.

​
1. URL base

POST/faceauth
https://rest-api.argosidentity.com/v3/faceauth

​
2. Autenticación

Incluya la clave API en el encabezado x-api-key:
x-api-key
x-api-key: {yourAPIKey}

​
3. Ejemplo de solicitud

POST/faceauth
curl --location --request POST 'https://rest-api.argosidentity.com/v3/faceauth' \
--header 'x-api-key: {yourAPIKey}' \
--form 'faceImage=@"/C:/Users/face.jpg"' \
--form 'submissionId= "{submissionId}"' \

​
4. Cuerpo de la solicitud

El cuerpo de la solicitud debe estar en formato JSON. A continuación se describen los campos:
​
submissionId
string
requerido
Identificador único para cada solicitud KYC.
FaceAuth solo puede proceder si la solicitud correspondiente (submissionId) tiene estado approved.
​
faceImage
file
requerido
Cargue la imagen selfie del usuario como archivo. Si las opciones de PPE (equipo de protección para cabeza/cara) están habilitadas, asegúrese de que todo el equipo de seguridad sea claramente visible en la imagen para un reconocimiento preciso.
​
userId
string
Un identificador único para el solicitante KYC definido por el cliente.
​
cf1
string
Valor del campo personalizado 1.
​
cf2
string
Valor del campo personalizado 2.
​
cf3
string
Valor del campo personalizado 3.

​
5. Respuesta

​
5-1. Respuesta exitosa

result.json
{
    "authentication_id": "{authentication_id}",
    "auth_status": "approved",
    "create_time": "2023-08-08T07:04:48.633Z",
    "score": {
        "face_similarity_score": 99.5,
        "occluded_score": 99.9
    }
}

​
5-2. Respuesta de rechazo

result.json
{
    "authentication_id": "{authentication_id}",
    "auth_status": "rejected",
    "create_time": "2023-08-08T07:04:48.633Z",
    "score": {
        "face_similarity_score": 83.6,
        "occluded_score": 40,
        "face_cover_score": 93.3,
        "head_cover_score": 87
    },
    "fail_code": [
        "Face_Occluded_fail"
    ],
    "rejected_comment": [
        "Face is occluded and the confidence is higher than the threshold."
    ]
}

​
5-3. Datos de respuesta

Field NameData TypeDescription
authentication_idStringID único para el envío de faceAuth.
auth_statusStringEl resultado final de faceAuth, devolviendo approved (éxito) o rejected (fallo).
scoreObjectPuntuaciones de reconocimiento basadas en las opciones seleccionadas. Las propiedades pueden incluir face_similarity_score, occluded_score, face_cover_score y head_cover_score.
create_timeStringLa fecha y hora en que se envió faceAuth (UTC+0).
fail_codeArraySi el estado es rejected, se devuelve un código de fallo.
rejected_commentArraySi el estado es rejected, se devuelve una razón detallada del fallo.

​
6. Códigos de error

​
6-1. Códigos de fallo

Failure CodeRejection CommentDescription
face_compare_underscoreFace compare similarity score is lower than the thresholdLa puntuación de similitud facial está por debajo del umbral.
Face_Occluded_failFace is occludedLa cara está obstruida.
Face_cover_failProtection equipment is not found on FaceFalta el equipo de protección facial.
Head_cover_failProtection equipment is not found on HeadFalta el equipo de protección para la cabeza.

​
6-2. Códigos de error

Error CodeMessageDescription
invalid_data_formatData parsing error. Please check input data.El formato de datos proporcionado es incorrecto. Verifique el formato de datos.
required_field_missingRequired field is missingFalta un campo obligatorio. Asegúrese de que submissionId, faceImage y la clave API estén incluidos.
Invalid_submissionIdFail to find the submission dataLa solicitud KYC no existe.
Invalid_projectIdFail to find the project dataEl proyecto FaceAuth no existe.
invalid_submission_statusThe submission must be approved to process face authenticationEl estado de la solicitud KYC no es approved.
image_converting_errorImage converting errorEl formato de imagen no es válido. Envíe la imagen como form-data (el formato base64 no es compatible).
image_processing_errorImage processing errorSe produjo un error al procesar los datos de la imagen.
detection_server_errorCannot finish process of detecting faceSe produjo un error en el módulo de verificación de comparación facial.
no_faceFace is not detectedNo se detectó ninguna cara en la faceImage enviada.
data_processing_errorData processing errorSe produjo un error al obtener o almacenar datos.