Delete/FaceAuth

  • The personal data, including images from the submission record, will be deleted.

  • However, the unique ID of the submission (Authentication ID), the result (auth_status), and the submission timestamp (createTime) will be retained.

Input Data

  • It's imperative to include the faceAuth_project-specific API-Key in the Header when sending a request. (Mandatory)

  • You must provide the Authentication ID of the submission record you wish to delete.

  • Only one submission record can be deleted per request.

  • Once a submission record is deleted, detailed viewing on the dashboard will be disabled for that record.

ParameterFormatrequirementDescription

authId

string

required

Only a single record can be deleted at a time.

Output Data

PropertiesFormatdescription

result

string

A 'success' message will be returned upon successful deletion.

Request URL

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

Sample Response

{
	message : "success"
}

Error Code

400 Error

Messagedescription

required key is missing

When mandatory parameters are missing: Both API-Key and authId are required.

error in processing data

In case of an error while querying submission data

Cannot find submission. Please check input data.

In case no matching submission record exists

error in delete submission

In case of an error while deleting data

Last updated