DELETE/Faceauth

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?authId={yourAuthId}" \
-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 Codes	Description
`required key is missing`	Ensure that the submitted API-Key is correct.
`error in processing data`	An error occurred while retrieving the submission data.
`Cannot find submission. Please check input data.`	The specified submission does not exist.
`error in delete submission`	An error occurred while attempting to delete the submission.

Faceauth ResultAfter 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.

⌘I

Add-on

API Endpoints

Webhook

1. Base URL

2. Authentication

3. Request Example

4. Request Parameters

5. Response

5-1. Response (delete_check: false)

5-2. Response Data

6. Error Codes

​1. Base URL

​2. Authentication

​3. Request Example

​4. Request Parameters

​5. Response

​5-1. Response (delete_check: false)

​5-2. Response Data

​6. Error Codes

1. Base URL

2. Authentication

3. Request Example

4. Request Parameters

5. Response

5-1. Response (delete_check: false)

5-2. Response Data

6. Error Codes