PARTIAL-DELETE/Submission

Notas Importantes

Los campos específicos eliminados no pueden ser restaurados.
Use esta API con precaución. Tenga cuidado de no eliminar accidentalmente datos importantes.
Cuando se aplica la Eliminación Parcial a un componente que es objetivo de verificación de duplicados, las verificaciones de duplicados no se aplicarán a ese envío.
- Incluso si llegan datos idénticos al estado anterior a la aplicación de la Eliminación Parcial, las verificaciones de duplicados no se aplicarán.

1. Endpoint

DELETE https://rest-api.argosidentity.com/v3/submission/partial?submission_id={submission_id}

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

requerido

Use el parámetro fields para eliminar selectivamente tipos específicos de datos. Puede ingresar una de las siguientes opciones:

id_image
selfie_image
data: Conjunto de datos final confirmado como resultado del proceso
OCR_raw(*sensible a mayúsculas): Conjunto de datos RAW extraído por OCR
ocr: Conjunto de datos convertido del OCR extraído a formato estandarizado
review: Conjunto de datos de resultado revisado por el usuario usando resultados OCR (procesado automáticamente con el mismo valor cuando la puntuación de reconocimiento OCR es alta)
applicant_id
email
userid
additional_list
duplicated_information
custom_duplicated_information
injection_action

string

Use el parámetro data_fields para eliminar selectivamente tipos específicos de información personal dentro del campo data. data_fields solo funciona cuando el campo data está declarado en el parámetro fields, y en este caso, si no se proporciona ningún valor en el parámetro data_fields, todos los sub-datos bajo data serán eliminados. Data se refiere al conjunto de datos final confirmado como resultado del proceso. Puede ingresar una de las siguientes opciones:

age_group
first_name
last_name
full_name — se refiere al mismo campo que name
full_name_en
name — se refiere al mismo campo que full_name
gender
nationality
date_of_birth
address_city
address_country
address_state
address_street
address_street2
address_zipcode
address_globalCode
address_compoundCode
address_formatted
address_input
address_detail
ip_address
idcard_issuingCountry
idcard_issueDate
idcard_expireDate
idType
documentNumber
identityNumber
ssnNumber
phoneNumber
cf1
cf2
cf3

name y full_name se refieren al mismo campo. Cualquiera de las dos claves se aplica a los mismos datos.

string

Correo electrónico del administrador que realizó la eliminación

3-1. Datos a Eliminar

Parámetros declarados en fields y data_fields

3-2. Datos a Retener

En los casos enviados, los parámetros no declarados en fields, y cuando se especifican parámetros específicos en data_fields, los parámetros no especificados no serán eliminados y serán retenidos.

4. Ejemplo de Solicitud

Usando solo fields

PARTIAL-DELETE/Submission

curl --location --request DELETE 'https://rest-api.argosidentity.com/v3/submission/partial?submission_id={submission_id}&fields=id_image' \ --header 'x-api-key: {yourAPIKey}'

Usando fields y data_fields

PARTIAL-DELETE/Submission

curl --location --request DELETE 'https://rest-api.argosidentity.com/v3/submission/partial?submission_id={submission_id}&fields=data&data_fields=gender,ip_address' \ --header 'x-api-key: {yourAPIKey}'

Usando múltiples fields y data_fields

PARTIAL-DELETE/Submission

curl --location --request DELETE 'https://rest-api.argosidentity.com/v3/submission/partial?submission_id={submission_id}&fields=id_image,data,selfie_image&data_fields=gender,ip_address' \ --header 'x-api-key: {yourAPIKey}'

5. Respuesta

5-1. Respuesta Exitosa

{
    "message": "success",
    "content": "Submission {submission_id} partially 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": "submission_id is required",
    "statusCode": 400
}

5-3. Códigos de Error

Error Code	Descripción
`submission_id is required`	Falta el parámetro requerido `submission_id` en la solicitud
`fields parameter is required and cannot be empty`	Falta el parámetro requerido `fields` o está vacío en la solicitud
`fields must be a string` `data_fields must be a string`	El parámetro `fields` no está en formato string El parámetro `data_fields` no está en formato string
`fields cannot be empty`	El parámetro `fields` está vacío
`invalid fields found in fields: field1, field2` `invalid fields found in data_fields: field1, field2`	Se incluyen campos inválidos en `fields` Se incluyen campos inválidos en `data_fields`
`data_fields parameter is not allowed when fields does not include data`	Se proporcionó el parámetro `data_fields` cuando `data` no está incluido en el parámetro `fields`
`invalid format for fields: error message`	El formato del parámetro `fields` es inválido
`invalid format for data_fields: error message`	El formato del parámetro `data_fields` es inválido
`invalid API key for this project`	La clave API proporcionada no es válida para este proyecto
`not Exist Submission Data`	No existen datos para el `submission_id` solicitado
`not Exist Project Data`	No existen datos del proyecto
`Internal server error`	Ocurrió un error interno del servidor

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

Usando solo fields

Usando fields y data_fields

Usando múltiples fields y data_fields

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

​Usando solo fields

​Usando fields y data_fields

​Usando múltiples fields y data_fields

​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

Usando solo fields

Usando fields y data_fields

Usando múltiples fields y data_fields

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error