Request Example:

curl -X POST "https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/ogs/setting" \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
-d '{

    "userId": "user723229497519527000",
    "enableOgs": "true"
}'

Request Url

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

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

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

https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/ogs/setting
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.
enableOgs	`boolean` Whether to enable OGS (On-going Screening) feature.

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
	OgsSetting can not be empty
AML_CASE_NOT_FOUND_FOR_USER	Case not found for userId
AML_SAME_STATE_CANNOT_REPEAT	The same state cannot be changed repeatedly
ERROR	Server error.

Response.data

Field	Description
profileMonitoringRecordDate	`long` The time when OGS was first enabled (if OGS was interrupted and re-enabled after 365 days, this time will be refreshed)
lastOgsTaskDate	`long` The start time of the ongoing 365-day OGS task (this date will not refresh upon toggling OGS on/off repeatedly)
ogsTaskDaysCountdown	`integer` The remaining number of days in the 365-day countdown
autoRenewTask	`boolean`Whether the OGS task will automatically renew after countdown completion

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "profileMonitoringRecordDate": 1761534086081,
        "lastOgsTaskDate": 1761534086000,
        "ogsTaskDaysCountdown": 364,
        "autoRenewTask": true
    },
    "extra": null,
    "transactionId": "70e9d6211473af0f",
    "pricingStrategy": "FREE"
}

PARAMETER_ERROR (Missing userId)

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

AML_CASE_NOT_FOUND_FOR_USER

{
  "code": "AML_CASE_NOT_FOUND_FOR_USER",
  "message": "Case not found for userId",
  "data": null,
  "transactionId": "f123c5a6d89a72f1",
  "pricingStrategy":"FREE"
}

AML_SAME_STATE_CANNOT_REPEAT

{
  "code": "PARAMETER_ERROR",
  "message": "The same state cannot be changed repeatedly",
  "data": null,
  "transactionId": "c762ad19fe8d1a77",
  "pricingStrategy":"FREE"
}

ERROR

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

}