authId immediately after creation, with no need to wait for indexing.
1. Base URL
2. Authentication
Include the FaceAuth project API key in thex-api-key header.
x-api-key
3. Request Example
4. Path Parameters
string
required
The key of the FaceAuth submission. Use the
authId from the POST creation response or the list response.5. Response
result.json
5-1. Success
A successful single lookup returns200 OK with a FaceAuthSubmission object. The object sits at the top level as-is.
- An
items[]element from the list lookup and a single lookup response are the same object. Looking up the sameauthIdthrough either path returns the same set of fields. - A deleted submission is returned with a value in
deleteTime.
5-2. Failure
A failed single lookup returns an HTTP status code with an error object.6. 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.
Related documents
FaceAuth Getting Started
FaceAuth further verifies identity by comparing the selfie of a user approved in the ID check process with the selfie captured during FaceAuth. This page covers the two delivery methods (URL / API), the FaceAuth URL query string structure, and the request parameter definitions.
FaceAuth Result
After faceAuth verification is completed, the final result (approved or rejected) is automatically sent to the Webhook URL registered in the existing ID check project, providing real-time notifications.