Saltar al contenido principal
Notas
  • Los envíos eliminados no pueden ser restaurados.
  • Los envíos eliminados siguen sujetos a facturación.
  • Los envíos eliminados aparecerán como “Deleted Submission” en el dashboard y en las respuestas de GET/API.
  • Use esta API con precaución para evitar eliminar datos críticos de forma no intencional.

​
1. Endpoint

DELETE/Submission
DELETE https://rest-api.argosidentity.com/v3/submission

​
2. Autenticación

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

​
3. Parámetro de Solicitud

​
submissionId
string
requerido
ID único del envío a eliminar
​
admin_name
string
Nombre del administrador que realiza la eliminación
El admin_name es opcional; sin embargo, es necesario que el administrador especifique el parámetro admin_name para recibir un webhook después de que se elimine un envío.

​
3-1. Datos a Eliminar

  • Información de identidad personal (ej., nombre, fecha de nacimiento, género, nacionalidad)
  • Detalles sensibles de ID (ej., número de documento, número de serie, código de barras)
  • Archivos de imágenes (ej., imágenes de ID, selfies)
  • Datos AML (si se almacenaron mediante opciones AML)

​
3-2. Datos a Retener

  • Datos básicos que no pueden identificar individuos, como ID de Submission, fecha de envío, tipo de ID y estado de aprobación de ID Check.

​
4. Ejemplo de Solicitud

DELETE/Submission
bash Request
curl --location --request DELETE 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}&admin_name={admin_name}' \
--header 'x-api-key: {yourAPIKey}'

​
5. Respuesta

​
5-1. Respuesta Exitosa

result.json
{
    "message": "success",
    "content": "Submission {submissionID} deleted successfully.",
    "statusCode": 200
}

​
5-2. Respuesta de Error

Si ocurre un error, se devuelve un código de estado 400 junto con detalles en el cuerpo de la respuesta:
error.json
{
    "message": "not Exist Submission ID",
    "statusCode": 400
}

​
5-3. Códigos de Error

Error CodesDescripción
not Exist Submission IDFalta el submission_id
not Exist Submission DataNo se encontraron datos para el submission_id especificado
not Exist Project DataFalta la información del proyecto
delete Process FAILEl proceso de eliminación falló (ej., fallo en eliminación de Meta Face ID)