Saltar al contenido principal
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.
HeaderValueRequired
x-api-keySu clave APIRequired
Content-Typemultipart/form-dataRequired
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.
​
submissionId
string
requerido
ID único del envío
​
admin
string
requerido
Cuenta del administrador del proyecto (debe estar registrada en el dashboard)
​
idType
string
Tipo de documento de identidad. Requerido al enviar idImage o idBackImage.
​
idImage
string
Lado frontal del documento de identidad, codificado en Base64
​
idBackImage
string
Lado posterior del documento de identidad, codificado en Base64
​
selfieImage
string
Imagen selfie, codificada en Base64
​
addressImage
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}'
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

CampoDescripciónTipo
messageMensaje de éxitoString

​
5-3. Respuesta de error

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

​
5-4. Códigos de error

Error CodeMessageDescripción
invalid_payloadFail to parse the input data.El formato de los datos de entrada es inválido.
missing_dataRequired input data is missing.Faltan algunos campos requeridos.
invalid_projectCannot find project info.El ID del proyecto no existe.
invalid_projectInvalid project.El estado del proyecto es inválido.
invalid_adminInvalid admin.El administrador es inválido.
invalid_submissionInvalid submission.El ID del envío es inválido.
invalid_dataAt least one image parameter is required.No se envió ninguna imagen.
missing_dataThe idType is required when submit idImage or idBackImage.Falta el idType al enviar una imagen de ID.
invalid_idTypeInvalid IdType.El idType proporcionado es inválido.
processing_errorFailed to put image.Ocurrió un error desconocido durante el procesamiento.