ReScreening

Request Example:

curl -X POST "https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/rescreening?profileId=test30" \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \

Request Url

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/rescreening
POST (application/json)

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/rescreening
POST (application/json)

https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/rescreening
POST (application/json)

https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/rescreening
POST (application/json)

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token.

Request Parameters

Parameter)	Description
userId	`string` The unique business identifier for the user.

Note:

The userId must correspond to an existing screening case; otherwise, a Case not found by user id error will be returned.

Response Description

Parameter	Description
code	`enum` Response's Status Code.
transactionId	`string` The request id, the max length is 64.
message	`string` Status Code Explanation.
data	`object` The result of the comparison.
extra	`object` Extra response info (Exception Message).

Response.code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Profile ID can not be empty
	The profileId length cannot exceed 200
	Gender is not in enum
	Nationality is not in enum
	CountryLocation is not in enum
	PlaceOfBirth is not in enum
	Dob is not in range, should be between 150 years ago and today
	Dob format is not yyyy-MM-dd or yyyy/MM/dd
	Case not found by user id
ERROR	Server error.

Response.data

Field	Description
isMatch	`boolean` Whether the screening found a match.
userId	`string` The user ID.
signatureId	`string` signature ID generated during screening.
caseId	`long`The AML case ID.
alertId	`long`The AML alert ID.
reviewRequired	`boolean`Whether a manual review is required.
reviewRequiredCount	`integer`The number of matches that require manual review.
totalMatches	`integer`The total number of matches found.

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "isMatch": true,
        "userId": "test23",
        "signatureId": "d7ec19a7a2ba4771",
        "caseId": 1982643773843513345,
        "alertId": 1982655977850478594,
        "reviewRequired": false,
        "reviewRequiredCount": 0,
        "totalMatches": 173
    },
    "extra": null,
    "transactionId": "d7ec19a7a2ba4771",
    "pricingStrategy": "FREE"
}

PARAMETER_ERROR (Missing userId)

{
  "code": "PARAMETER_ERROR",
  "message": "User ID can not be empty",
  "data": null,
  "transactionId": "b203e5f74d9abf11",
  "pricingStrategy":"FREE"
}

PARAMETER_ERROR (Invalid userId)

{
  "code": "PARAMETER_ERROR",
  "message": "Case not found by user id",
  "data": null,
  "transactionId": "f123c5a6d89a72f1",
  "pricingStrategy":"FREE"
}

ERROR

{
    "code":"ERROR",
    "message":"Server error",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"

}

Updated 1 day ago