DELETE/Submission

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 https://rest-api.argosidentity.com/v3/submission

DELETE https://kr.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

string

requerido

ID único del envío a eliminar

string

Correo electrónico 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

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}'

bash Request
curl --location --request DELETE 'https://kr.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 Codes	Descripción
`not Exist Submission ID`	Falta el `submission_id`
`not Exist Submission Data`	No se encontraron datos para el `submission_id` especificado
`not Exist Project Data`	Falta la información del proyecto
`delete Process FAIL`	El proceso de eliminación falló (ej., fallo en eliminación de Meta Face ID)

Descripción General

Referencia API

1. Endpoint

2. Autenticación

3. Parámetro de Solicitud

3-1. Datos a Eliminar

3-2. Datos a Retener

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error

​1. Endpoint

​2. Autenticación

​3. Parámetro de Solicitud

​3-1. Datos a Eliminar

​3-2. Datos a Retener

​4. Ejemplo de Solicitud

​5. Respuesta

​5-1. Respuesta Exitosa

​5-2. Respuesta de Error

​5-3. Códigos de Error

1. Endpoint

2. Autenticación

3. Parámetro de Solicitud

3-1. Datos a Eliminar

3-2. Datos a Retener

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error