- Only one submission can be deleted per request.
- Deleted data: the target face image and the sensitive references created during FaceAuth processing are removed. After deletion, image download returns
404 FACEAUTH_SUBMISSION_NOT_FOUND. - Retained data: the submission itself still appears in list lookup and single lookup results, with
deleteTimefilled in. The authentication result (authStatus), decision data (result), applied policy (policy), linked KYC submission ID (kycSubmissionId), submission method (submitType), and creation time (createTime) are all retained.
1. Base URL
DELETE/Face-auth/{authId}
2. Authentication
Include the FaceAuth project API key in thex-api-key header.
x-api-key
3. Request Example
DELETE/Face-auth/{authId}
4. Path Parameters
string
required
The key of the FaceAuth submission to delete.
5. Response
5-1. Success
A successful deletion returns200 OK with the body below.
result.json
string
The key of the deleted FaceAuth submission. It matches the
authId you requested.- The response body has exactly one field:
authId. If you need the deletion time, readdeleteTimefrom a list or single lookup. - Success means that both the target face image deletion and the deletion record completed.
5-2. Retries and idempotency
- Requesting an already-deleted
authIdagain returns the same200 OKresponse. Clients can safely retry the same request when the outcome is unknown, for example after a network error. - If the deletion only partially completed, the response is
503rather than a success. Retrying the same request finishes the remaining work. Retries are safe.
5-3. Failure
A failed deletion 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.
Authentication (
401 / 403) is evaluated first, and parameter validation (400) runs only after it passes. With a missing or invalid API key you therefore get 401 or 403 regardless of the authId you send.