ZOLOZZOLOZDOCS

Privacy Info - Delete API

Important Notice:

  • All request and response parameters are strictly subject to the official API documentation.
  • The API response may contain fields not defined in the documentation. These fields are for internal debugging purposes only and are not guaranteed to be stable or compatible. Do not rely on these fields in production environments. ZOLOZ reserves the right to modify or remove these fields at any time without prior notice.

Overview

API Name: ZOLOZ SaaS Privacy Information Delete API

API URL: /api/v1/zoloz/privacyinfo/delete

API Description: Delete privacy Information, e.g. doc or face images, OCR or input

information.

Note: The interface supports repeated calls.

Version

Date

Version

Release Notes

8 January, 2020

1.0.0

The first published version.

Request

Fields Specification

Name

Type

Max Length

Mandatory

Default Value

Value Range

Description

Sample Value

transactionId

string

64

true

not null and not empty string

business unique ID for tracing purpose

G006600001FFS20190914000000000000010021

Request Sample

copy
POST https://ip:port/api/v1/zoloz/privacyinfo/delete HTTP/1.1

Content-Type: application/json; charset=UTF-8
Client-Id: 5X67656YXXXXXX
Request-Time: 2019-04-04T12:08:56+05:30
Signature: algorithm=RSA256, signature=xxxxxxxxxxxx

{
  "transactionId": "G006600001FFS20190914000000000000010021"
}

Response

Fields Specification

Name

Type

Mandatory

Value Range

Description

Sample Value

result.resultCode

string

true

result code

"SUCCESS"

result.resultStatus

string

true

result status

"S"

result.resultMessage

string

true

result message

"success"

The value range of "resultCode" at business level:

resultCode

Description

PARAM_ILLEGAL

TransactionId is null or empty string

SUCCESS

Delete successfully.

SYSTEM_ERROR

Other internal errors;

TRANSACTION_RECORD_AUTHORITY_ERROR

Transaction record authority error

Response Sample

copy
HTTP/1.1 200 OK

Content-Type: application/json; charset=UTF-8
Response-Time: 2019-11-19T21:56:15-0800
Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx

{
  "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"success"
  }
}