API Endpoints
DELETE/Faceauth
An API to securely delete the facial image and personal data of a specific submission while retaining key metadata such as auth_status and create_time.
- 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
)
- Unique submission ID (
1. Base URL
DELETE/FaceAuth
2. Authentication
Include the API key in the x-api-key header:
x-api-key
3. Request Example
DELETE/FaceAuth
4. Request Parameters
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, usenextPage_key
’sauthId
asnextKey_id
andcreateTime
asnextKey_date
in the next request.
5. Response
5-1. Response (delete_check: false)
result.json
5-2. Response Data
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
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. |
Was this page helpful?