GET/Faceauth/Image

1. Base URL

GET/FaceAuth/Image

  https://rest-api.argosidentity.com/v3/faceauth/image

Include the API key in the x-api-key header:

x-api-key

  x-api-key: {yourAPIKey}

GET/FaceAuth

  curl --location "https://rest-api.argosidentity.com/v3/faceauth/image?authId={yourAuthId}" \
  --header 'x-api-key: {yourAPIKey}'

authId

string

required

The authId to download the image

Returns a base64 encoded image.

example.png

  /9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZ...

If an error occurs, a 400 status code is returned along with details in the response body:

error.json

{
  traceId: '0199cb93-bdf1-77ef-8cd4-3d38dec61830',
  errorCode: 'NOT_FOUND',
  message: 'faceAuth_project not found'
}

Error Code	Description
`faceAuth_project not found`	This error occurs when there is no valid project corresponding to the submitted API-Key. Please check if your API-Key is correct.
`authId is required`	The authId parameter is missing from the request parameters.