Skip to main content
El endpoint se ha trasladado a /v3/face-auth/{authId}.authId pasa a ser un parámetro de ruta en lugar de un parámetro de consulta, y la respuesta de éxito ha cambiado de { "result": "success", "statusCode": 200 } a { "authId": "..." }. Para migrar una integración existente, consulte Referencia común de FaceAuth — Migrar desde la API anterior.
Elimina la imagen facial y las referencias sensibles de procesamiento de un envío de FaceAuth. No elimina el envío KYC original ni la imagen de referencia de KYC.
  • Solo se puede eliminar un envío por solicitud.
  • Datos eliminados: se eliminan la imagen facial y las referencias sensibles creadas durante el procesamiento de FaceAuth. Tras la eliminación, la descarga de imagen devuelve 404 FACEAUTH_SUBMISSION_NOT_FOUND.
  • Datos conservados: el envío sigue apareciendo en los resultados de la consulta de lista y de la consulta individual, con deleteTime relleno. Se conservan el resultado de autenticación (authStatus), los datos de decisión (result), la política aplicada (policy), el ID del envío KYC vinculado (kycSubmissionId), el modo de envío (submitType) y la hora de creación (createTime).

1. URL base

DELETE/Face-auth/{authId}

2. Autenticación

Incluya la clave API del proyecto FaceAuth en el encabezado x-api-key.
x-api-key

3. Ejemplo de solicitud

DELETE/Face-auth/{authId}

4. Parámetros de ruta

string
requerido
Clave del envío de FaceAuth que se va a eliminar.

5. Respuesta

5-1. Éxito

Una eliminación correcta devuelve 200 OK con el cuerpo siguiente.
result.json
string
Clave del envío de FaceAuth eliminado. Coincide con el authId solicitado.
  • El cuerpo de la respuesta tiene exactamente un campo: authId. Si necesita la hora de eliminación, léala en deleteTime mediante una consulta de lista o individual.
  • El éxito significa que se completaron tanto la eliminación de la imagen facial como el registro de la eliminación.

5-2. Reintentos e idempotencia

  • Solicitar de nuevo un authId ya eliminado devuelve la misma respuesta 200 OK. Los clientes pueden reintentar la misma solicitud con seguridad cuando desconocen el resultado, por ejemplo tras un error de red.
  • Si la eliminación solo se completó parcialmente, la respuesta es 503 en lugar de un éxito. Al reintentar la misma solicitud se completa el trabajo restante. Los reintentos son seguros.

5-3. Fallo

Una eliminación fallida devuelve un código de estado HTTP con un objeto de error.

6. Respuestas de error

Los errores que devuelve la aplicación de ARGOS usan el formato { code, message }. El 401 y algunos 403 se bloquean en la capa de autenticación y no siguen ese formato: consulte Referencia común de FaceAuth — Respuestas de error.
La autenticación (401 / 403) se evalúa primero, y la validación de parámetros (400) solo se ejecuta después de superarla. Por tanto, con una clave API ausente o no válida se obtiene 401 o 403 sea cual sea el authId enviado.