Remove Item

2023-12-01 09:16

POST /api/v1/zoloz/blacklist/removeitem

This API is used to delete an item from a target list. This API is idempotent.

Structure

Field name	Data type	Max length	Description
bizId	String	32	Mandatory. A unique ID maintained by client for tracing purpose. Note: ZOLOZ server does not perform uniqueness check on this field. For better tracking, it is strongly recommended client guarantee the uniqueness of this ID.
itemType	String	8	Required. Specify the type of the item to be removed. Valid values include: `FACE` : Face blacklist `DEVICE` : Device blacklist `CERT` : Certificate number blacklist
itemId	String	64	Mandatory. The ID of the item to be removed.

Field name	Data type	Description
result	Result	Contains the result code, result status, and a result message.
removedItemId	String	Available if the item is removed successfully.

For the full list of common result codes, see the Common error codes section in the Error handling topic.

The following table shows the possible result codes that are specific for this API.

resultCode	resultStatus	Description
SUCCESS	S	The API call is successful.
INVALID_ARGUMENT	F	Input parameters are invalid. For more information about which parameter is invalid, check the result message or the related log.
BLACKLIST_ITEM_NOT_FOUND	F	The requested item does not exist.
SYSTEM_ERROR	F	Other internal errors. For more information about the error details, check the result message that is returned and the related log.

Here is an example request to remove a FACE item.

copy
{
  "bizId": "some-random-biz-id",
  "itemId": "86451b883c80372",
  "itemType": "FACE" 
}

Here is an example when item is removed successfully.

copy
{
  "removedItemId":"86451b883c80372",
  "result":{
    "resultCode":"SUCCESS",
    "resultMessage":"Success",
    "resultStatus":"S"
  }
}