GET/Face-auth/{authId}/Image

La imagen ya no se devuelve en el cuerpo de la respuesta: el endpoint responde con una redirección 302 Found.El endpoint anterior GET /v3/faceauth/image devolvía el binario JPEG en el cuerpo. El nuevo endpoint devuelve una URL de descarga en el encabezado Location, así que su cliente HTTP debe estar configurado para seguir redirecciones. Para migrar una integración existente, consulte Referencia común de FaceAuth — Migrar desde la API anterior.

Descarga la imagen facial de un envío de FaceAuth.

1. URL base

GET https://rest-api.argosidentity.com/v3/face-auth/{authId}/image

2. Autenticación

Incluya la clave API del proyecto FaceAuth en el encabezado x-api-key.

x-api-key

x-api-key: {yourAPIKey}

3. Ejemplo de solicitud

Con curl, la opción --location es necesaria para seguir la redirección.

curl

curl --location "https://rest-api.argosidentity.com/v3/face-auth/{authId}/image" \
  -H "x-api-key: {yourAPIKey}" \
  --output face-image.jpg

python

import requests

# requests sigue las redirecciones de forma predeterminada.
resp = requests.get(
    "https://rest-api.argosidentity.com/v3/face-auth/{authId}/image",
    headers={"x-api-key": "{yourAPIKey}"},
)
with open("face-image.jpg", "wb") as f:
    f.write(resp.content)

4. Parámetros de ruta

string

requerido

Clave del envío de FaceAuth cuya imagen se va a descargar.

5. Respuesta

5-1. Éxito

Este endpoint responde con una redirección, no con un cuerpo JSON. Si tiene éxito devuelve 302 Found con el encabezado siguiente, y el cuerpo está vacío.

result.http

HTTP/1.1 302 Found
Location: https://{signedDownloadUrl}

string

URL de descarga firmada. Sígala tal cual: no interprete ni modifique el valor.

Al seguir la redirección se obtiene 200 OK con los datos originales de la imagen facial.

No use el Content-Type de la respuesta para determinar el formato de la imagen.Content-Type contiene el valor registrado en el momento del almacenamiento y puede ser un valor no estándar como jpg. Determine el formato a partir del contenido del archivo (magic number) o del formato que ya conocía al almacenarlo.

El cuerpo de la respuesta de éxito está vacío. No procese el 302 como JSON.
La URL de descarga caduca a los 5 minutos. Si ha caducado, invoque de nuevo esta API para obtener una nueva.

5-2. Fallo

Una descarga de imagen fallida devuelve un código de estado HTTP con un objeto de error.

6. Política de acceso y eliminación

Si el proyecto FaceAuth de la clave API es distinto del proyecto del envío, la respuesta es 404, igual que para un authId inexistente.
Los envíos ya eliminados, los envíos con deleteTime y los envíos sin referencia de imagen original devuelven siempre 404.
Una vez completada la eliminación, la imagen ya no puede descargarse con esta API.

7. Respuestas de error

Los errores que devuelve la aplicación de ARGOS usan el formato { code, message }. El 401 y algunos 403 se bloquean en la capa de autenticación y no siguen ese formato: consulte Referencia común de FaceAuth — Respuestas de error.

Estado HTTP	code	Condición
`400`	`REQUEST_INVALID`	El parámetro de ruta `authId` no es válido
`403`	`AUTH_FORBIDDEN`	La clave API es válida pero no está vinculada a un proyecto FaceAuth
`404`	`FACEAUTH_SUBMISSION_NOT_FOUND`	El envío no existe, pertenece a otro proyecto, se eliminó o no conserva imagen
`503`	`UPSTREAM_UNAVAILABLE`	Un servicio interno necesario para la consulta de la imagen no está disponible temporalmente. Reintente la misma solicitud en unos instantes
`500`	`INTERNAL_UNEXPECTED`	Error inesperado del servidor

​1. URL base

​2. Autenticación

​3. Ejemplo de solicitud

​4. Parámetros de ruta

​5. Respuesta

​5-1. Éxito

​5-2. Fallo

​6. Política de acceso y eliminación

​7. Respuestas de error

1. URL base

2. Autenticación

3. Ejemplo de solicitud

4. Parámetros de ruta

5. Respuesta

5-1. Éxito

5-2. Fallo

6. Política de acceso y eliminación

7. Respuestas de error