PUT/Image

Notas

Formatos de imagen permitidos: jpg, jpeg, png.
Todas las imágenes deben enviarse como cadenas codificadas en Base64.
El parámetro idType es requerido al enviar idImage o idBackImage.
Se debe enviar al menos una imagen.

1. Endpoint

PUT/Image

PUT https://rest-api.argosidentity.com/v3/submission/image

2. Autenticación y encabezados

Esta API requiere que el cuerpo de la solicitud se envíe como multipart/form-data.

Header	Value	Required
`x-api-key`	Su clave API	Required
`Content-Type`	`multipart/form-data`	Required

Al usar la opción --form de curl o el parámetro files de la biblioteca requests de Python, el encabezado Content-Type: multipart/form-data y el valor boundary se establecen automáticamente. Establecer el encabezado manualmente puede omitir el valor boundary y causar que la solicitud falle.

3. Parámetros de solicitud

Todos los parámetros se envían como campos multipart/form-data.

string

requerido

ID único del envío

string

requerido

Cuenta del administrador del proyecto (debe estar registrada en el dashboard)

string

Tipo de documento de identidad. Requerido al enviar idImage o idBackImage.

string

Lado frontal del documento de identidad, codificado en Base64

string

Lado posterior del documento de identidad, codificado en Base64

string

Imagen selfie, codificada en Base64

string

Imagen del documento de dirección, codificada en Base64

4. Ejemplo de solicitud

curl --location --request PUT 'https://rest-api.argosidentity.com/v3/submission/image' \
--header 'x-api-key: {yourAPIKey}' \
--form 'submissionId="sampleSubmissionId11"' \
--form 'admin="sample@argosidentity.com"' \
--form 'idType="drivers_license"' \
--form 'idImage={base64String}' \
--form 'idBackImage={base64String}' \
--form 'selfieImage={base64String}' \
--form 'addressImage={base64String}'

import base64
import requests
from pathlib import Path

API_URL = "https://rest-api.argosidentity.com/v3/submission/image"
API_KEY = "your-api-key"

image_path = Path("drvlic.jpeg")
id_image_b64 = base64.b64encode(image_path.read_bytes()).decode()

resp = requests.put(
    API_URL,
    headers={"x-api-key": API_KEY},
    files={
        "submissionId": (None, "sampleSubmissionId11"),
        "admin": (None, "sample@argosidentity.com"),
        "idType": (None, "drivers_license"),
        "idImage": (None, id_image_b64),
    },
)

print(resp.status_code, resp.json())

Al usar el parámetro files de la biblioteca requests de Python, pase los campos de texto como tuplas (None, "value"). El primer elemento None indica que no hay nombre de archivo, lo que envía correctamente los datos de texto como campos multipart/form-data.

5. Respuesta

5-1. Respuesta exitosa

result.json

{
   "message": "complete to update image."
}

5-2. Datos de respuesta

Campo	Descripción	Tipo
`message`	Mensaje de éxito	String

5-3. Respuesta de error

result.json

{
    "errorCode": "invalid_payload",
    "message": "Fail to parse the input data."
}

5-4. Códigos de error

Error Code	Message	Descripción
`invalid_payload`	Fail to parse the input data.	El formato de los datos de entrada es inválido.
`missing_data`	Required input data is missing.	Faltan algunos campos requeridos.
`invalid_project`	Cannot find project info.	El ID del proyecto no existe.
`invalid_project`	Invalid project.	El estado del proyecto es inválido.
`invalid_admin`	Invalid admin.	El administrador es inválido.
`invalid_submission`	Invalid submission.	El ID del envío es inválido.
`invalid_data`	At least one image parameter is required.	No se envió ninguna imagen.
`missing_data`	The idType is required when submit idImage or idBackImage.	Falta el `idType` al enviar una imagen de ID.
`invalid_idType`	Invalid IdType.	El `idType` proporcionado es inválido.
`processing_error`	Failed to put image.	Ocurrió un error desconocido durante el procesamiento.

Descripción General

Referencia API

1. Endpoint

2. Autenticación y encabezados

3. Parámetros de solicitud

4. Ejemplo de solicitud

5. Respuesta

5-1. Respuesta exitosa

5-2. Datos de respuesta

5-3. Respuesta de error

5-4. Códigos de error

​1. Endpoint

​2. Autenticación y encabezados

​3. Parámetros de solicitud

​4. Ejemplo de solicitud

​5. Respuesta

​5-1. Respuesta exitosa

​5-2. Datos de respuesta

​5-3. Respuesta de error

​5-4. Códigos de error

1. Endpoint

2. Autenticación y encabezados

3. Parámetros de solicitud

4. Ejemplo de solicitud

5. Respuesta

5-1. Respuesta exitosa

5-2. Datos de respuesta

5-3. Respuesta de error

5-4. Códigos de error