ZOLOZZOLOZDOCS

checkresult

Overview

API Name: AML CaseResult Search API

API URL: ​/api/v1/aml/checkCaseResult​

API Description: Provides query case results.

Structure

Request Parameters

Parameter

Data Type

Max Length

Description

Example

requestID

String

32B

Required. Unique business ID for tracing purposes.

"6728d09e2113b33b6cc7e47a361c3a5a"

tenantID

String

32B

Required. Customer's unique ID.

"GLOBAL"

type

String

64B

Required. Case type. The following values are supported: 

  • PEP: Politically Exposed Person
  • SANCTION: sanctioned individuals and entities
  • NEGATIVE_NEWS: individuals and entities associated with bad press 
  • INTERNAL_LIST: custom list 
  • EDD: Enhanced Due Diligence
  • ALL: contains all of the above case types 

"SANCTION"

Response Parameters

Parameter

Data Type

Max Length

Description

Example

result

Result

-

The API request result, which contains information about the result of the API request, such as status and error codes. 

{

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

caseDetails

List<ZolozAlertTaskBO>

1024KB

For more details on case results, see ZolozAlertTaskBO. 

[ { "requestID":"6728d09e2113b33b6cc7e47a361c3a5a", "decision":"REJECT", "status":"CLOSED", "taskId":"A2022112130307183A", "type":"SANCTION", "userId":"20880000001",  "crrRiskLevel":"", "createTime":"1693221462732", "updateTime":"1693221462732", "modifier":"12345678@163.com" } ]

ZolozAlertTaskBO

Parameter

Data Type 

Max Length

Description

Example

requestID

String

32B

Unique business ID for tracing purposes.

"6728d09e2113b33b6cc7e47a361c3a5a"

taskId

String

32B

Unique case Id for a case.

"A2022112130307183A"

userId

64B

User ID.

21880000001

type

String

64B

Case types. Possible values are as below:

  • PEP: Politically Exposed Person
  • SANCTION: sanctioned individuals and entities 
  • NEGATIVE_NEWS: individuals and entities associated with bad press 
  • INTERNAL_LIST: custom list 
  • EDD: Enhanced Due Diligence

"SANCTION"

status

String

32B

Case status. The following values are supported:

  • NEW: newly created alert case, not reviewed yet.
  • REVIEW: alert case is currently being reviewed.
  • CLOSED: alert case review has finished.

"CLOSED"

createTime

Timestamp

-

Case creation time in Unix timestamp format (milliseconds)

1693221462732

updateTime

Timestamp

-

Case update time in Unix timestamp format (milliseconds)

1693221462732

modifier

String

200

Case modifier.

"12345678@163.com"

decision

String

32B

Case review results.

  • When the case type is  PEP/SANCTION/NEGATIVE_NEWS/INTERNAL_LIST, the following case review results are returned:
    • ACCEPT: Non-hit
    • REJECT: Hit
  • When the case type is EDD, the following case review results are returned:
    • Maintain: Maintains the existing risk rating without manual adjustment.
    • Adjust: Manually adjust the risk rating. 
    • Terminate: Terminate relationship with the customer. 

"ACCEPT"

crrRiskLevel

String

32B

Customer risk rating, this field is returned for EDD case types. 

  • HIGH: high risk 
  • MEDIUM: medium risk
  • LOW: low risk 

"HIGH"

Samples

Request Sample

The following sample shows what a request sent from the merchant server looks like.

copy
{
  "requestID": "6728d09e2113b33b6cc7e47a361c3a5a",
  "type":"SANCTION",
  "tenantID":"GLOBAL"
}

Response Sample

The following sample shows what a response returned from the ZOLOZ server looks like.

copy
{
    "caseDetails":[
        {
            "requestID":"6728d09e2113b33b6cc7e47a361c3a5a",
            "decision":"REJECT",
            "status":"CLOSED",
            "taskId":"A2022112130307183A",
            "type":"SANCTION",
            "userId":"20880000001",
            "crrRiskLevel":"",
            "createTime":"1693221462732",
            "updateTime":"1693221462732",
            "modifier":"12345678@163.com"
        }
    ],
    "result":{
        "resultCode":"SUCCESS",
        "resultMessage":"success",
        "resultStatus":"S"
    }
}