GET/Face-auth/{authId}/Image

The image is no longer returned in the response body — the endpoint responds with a 302 Found redirect.The previous endpoint GET /v3/faceauth/image returned the JPEG binary in the body. The new endpoint returns a download URL in the Location header, so your HTTP client must be configured to follow redirects. To move an existing integration, see FaceAuth Common Reference — Migrating from the previous API.

Downloads the target face image of a FaceAuth submission.

1. Base URL

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

2. Authentication

Include the FaceAuth project API key in the x-api-key header.

x-api-key

x-api-key: {yourAPIKey}

3. Request Example

With curl, the --location option is required to follow the redirect.

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 follows redirects by default.
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. Path Parameters

string

required

The key of the FaceAuth submission to download.

5. Response

5-1. Success

This endpoint responds with a redirect rather than a JSON body. On success it returns 302 Found with the header below, and the body is empty.

result.http

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

string

A signed download URL. Follow it as-is — do not interpret or modify the value.

Following the redirect returns 200 OK with the original face image data.

Do not use the response Content-Type to determine the image format.Content-Type carries the value recorded at storage time and may be a non-standard value such as jpg. Determine the format from the file contents (magic number) or from the format you already knew at storage time.

The success response body is empty. Do not parse the 302 as JSON.
The download URL expires after 5 minutes. If it has expired, call this API again to get a new one.

5-2. Failure

A failed image download returns an HTTP status code with an error object.

6. Access and Deletion Policy

If the FaceAuth project of the API key differs from the project of the submission, the response is 404, exactly as for a nonexistent authId.
Submissions that have already been deleted, submissions with a deleteTime, and submissions with no original image reference always return 404.
After a DELETE completes, the image can no longer be downloaded through this API.

7. Error Responses

Errors returned by the ARGOS application use the { code, message } format. 401 and some 403 responses are blocked at the authentication layer and do not follow that format — see FaceAuth Common Reference — Authentication layer errors.

HTTP status	code	Condition
`400`	`REQUEST_INVALID`	The `authId` path parameter is invalid
`403`	`AUTH_FORBIDDEN`	The API key is valid but is not linked to a FaceAuth project
`404`	`FACEAUTH_SUBMISSION_NOT_FOUND`	The submission does not exist, belongs to another project, was deleted, or has no image left
`503`	`UPSTREAM_UNAVAILABLE`	An internal service required for the image lookup is temporarily unavailable. Retry the same request shortly
`500`	`INTERNAL_UNEXPECTED`	An unexpected server error

​1. Base URL

​2. Authentication

​3. Request Example

​4. Path Parameters

​5. Response

​5-1. Success

​5-2. Failure

​6. Access and Deletion Policy

​7. Error Responses

1. Base URL

2. Authentication

3. Request Example

4. Path Parameters

5. Response

5-1. Success

5-2. Failure

6. Access and Deletion Policy

7. Error Responses