Submission
DELETE/Submission
This API allows you to permanently delete all information associated with a single submission. Deleted data cannot be restored, and deleted submissions are still billable.
Notes
- Deleted submissions cannot be restored.
- Deleted submissions are still subject to billing.
- Deleted submissions will appear as “Deleted Submission” in the dashboard and
GET/API
responses. - Use this API with caution to avoid unintentionally deleting critical data.
1. Endpoint
DELETE/Submission
2. Authentication
Include the API key in the x-api-key header:
x-api-key
3. Request Parameter
Unique ID of the submission to be deleted
3-1. Data to be Deleted
- Personal identity information (e.g., name, date of birth, gender, nationality)
- Sensitive ID details (e.g., document number, serial number, barcode)
- Image files (e.g., ID images, selfies)
- AML data (if stored via AML options)
3-2. Data to be Retained
- Basic data that cannot identify individuals, such as Submission ID, submission date, ID type, and ID Check approval status.
4. Request Example
DELETE/Submission
5. Response
5-1. Success Response
result.json
5-2. Error Response
If an error occurs, a 400 status code is returned along with details in the response body:
error.json
5-3. Error Codes
Error Codes | Description |
---|---|
not Exist Submission ID | submission_id is missing |
not Exist Submission Data | No data found for the specified submission_id |
not Exist Project Data | Project information is missing |
delete Process FAIL | Deletion process failed (e.g., Meta Face ID deletion failure) |
adminName and comment is required | Admin name and comment are required when deleting from the dashboard |
Was this page helpful?