• Only one submission can be deleted per request.
  • Deleted data: The submitted facial image and personal information are permanently removed.
  • Retained data:
    • Unique submission ID (auth_id)
    • Authentication result (auth_status)
    • Submission date and time (createTime)

1. Base URL

DELETE/FaceAuth
https://rest-api.argosidentity.com/v3/faceauth

2. Authentication

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

x-api-key
x-api-key: {yourAPIKey}

3. Request Example

DELETE/FaceAuth
curl -X DELETE "https://rest-api.argosidentity.com/v3/faceauth" \
-H "x-api-key: {yourAPIKey}" \

4. Request Parameters

authId
string

Used to specify the unique submission to be deleted.

  • Maximum retrieval limit: A single request can delete only one submission.
  • Fetching additional data: If more data exists, the response will include the nextPage_key object. To continue retrieving data, use nextPage_key’s authId as nextKey_id and createTime as nextKey_date in the next request.

5. Response

5-1. Response (delete_check: false)

result.json
{
    "message": "success"
}

5-2. Response Data

faceAuth_projectId
string

FaceAuth project ID

6. Error Codes

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

error.json
{
    "errorCode": "required key is missing"
}
Error CodesDescription
required key is missingEnsure that the submitted API-Key is correct.
error in processing dataAn error occurred while retrieving the submission data.
Cannot find submission. Please check input data.The specified submission does not exist.
error in delete submissionAn error occurred while attempting to delete the submission.