Request Example:

curl -X POST "https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/screening/create" \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
-d '{
  "name": "John Doe",
  "referenceId": user123",
  "dob": "1990-05-21",
  "nationality": "USA",
  "countryLocation": "USA",
  "placeOfBirth": "USA",
  "gender": "MALE",
  "enableOgs": true
}'

Request Url

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

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

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

https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/screening/create
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
name	`string` The name of the person or entity to be screened.
referenceId	`string` The unique business identifier for the user.
dob	`string` [Optional] The date of birth. Format: yyyy-MM-dd or yyyy/MM/dd.
nationality	`string` [Optional] The nationality, following ISO-3166-1 alpha-3 country code.(tps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
countryLocation	`string` [Optional] The current country, following ISO-3166-1 alpha-3 country code.(tps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
placeOfBirth	`string` [Optional] The place of birth, following ISO-3166-1 alpha-3 country code.(tps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
gender	`string` [Optional] Gender of the person. Optional values: MALE, FEMALE.
enableOgs	`boolean` Whether to enable OGS (On-going Screening) feature.
entityType	`string` [Optional] It supports searching for individual or company (organization) names or individual names, and the corresponding values need to be set when using it. Optional values: INDIVIDUAL, ORGANISATION.

TypeNote:

Date of birth should be within 150 years ago and today.

Ensure that userId is unique to avoid duplication errors.

If any enum field contains invalid values, the request will fail with PARAMETER_ERROR.

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	User ID can not be empty
	The userId 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
	Duplicate userId in screening record db response error
ERROR	Server error.

Response.data

Field	Description
isMatch	`boolean` Whether the screening found a match.
profileId	`string` The profile ID.
signatureId	`string` signature ID generated during screening.
caseId	`long`The AML case ID.
alertId	`long`The AML alert ID.
enableOgs	`boolean`Whether OGS is enabled.
totalMatches	`integer`The total number of matches found.

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "isMatch": true,
        "profileId": "PF_YgKkmLntAJNrp3WOECbaY",
        "signatureId": "da9ac5c3952c22a4",
        "caseId": 1982643773843513345,
        "alertId": 1982643773927399425,
        "enableOgs": true,
        "totalMatches": 51,
        "screenedReviewRequired": null
    },
    "extra": null,
    "transactionId": "da9ac5c3952c22a4",
    "pricingStrategy": "FREE"
}

PARAMETER_ERROR (Missing userId)

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

PARAMETER_ERROR (Invalid gender)

{
  "code": "PARAMETER_ERROR",
  "message": "Gender is not in enum",
  "data": null,
  "transactionId": "f123c5a6d89a72f1",
  "pricingStrategy":"FREE"
}

PARAMETER_ERROR (Invalid DOB format)

{
  "code": "PARAMETER_ERROR",
  "message": "Dob format is not yyyy-MM-dd or yyyy/MM/dd",
  "data": null,
  "transactionId": "c762ad19fe8d1a77",
  "pricingStrategy":"FREE"
}

ERROR

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

}