Documentation

Renew Setting

Request Example:

curl -X POST "https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/renew/update-status" \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
-d '{
  "name": "John Doe",
  "userId": "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/renew/update-status
POST (application/json)
https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/renew/update-status
POST (application/json)
https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/renew/update-status
POST (application/json)
https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/aml/renew/update-status
POST (application/json)

Request Header Parameters

ParameterDescription
X-ACCESS-TOKENstring Please use Token Authentication API to get your access token.

Request Parameters

Parameter)Description
userIdstring The unique business identifier for the user.
autoRenewboolean Whether to enable or disable automatic renew. true means enable, false means disable

Response Description

ParameterDescription
codeenum Response's Status Code.
transactionIdstring The request id, the max length is 64.
messagestring Status Code Explanation.
dataobject The result of the comparison.
extraobject Extra response info (Exception Message).

Response.code

Status CodeMessage
SUCCESSOK
PARAMETER_ERRORUser ID can not be empty
AML_CASE_NOT_FOUND_FOR_USERCase not found for userId
AML_CASE_AUTO_RENEW_ENABLEDCase already has auto-renew enabled
AML_CASE_AUTO_RENEW_NOT_ENABLEDCase does not have auto-renew enabled, cannot close renew
ERRORServer error.

Response.data

FieldDescription
userIdstring The user ID.
autoRenewboolean Whether auto-renew is enabled
monitoringEndDatelongThe monitoring end date
currentCycleStartTimelongStart date of the current monitoring cycle
renewCloseTimelongThe time when auto-renew was closed, can be null
ogsTaskDaysCountdownintegerThe last OGS 365-day monitoring start date (does not refresh upon toggling OGS)

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "userId": "test23",
        "autoRenew": false,
        "monitoringEndDate": 1793070086000,
        "currentCycleStartTime": 1761534086000,
        "renewCloseTime": 1761547311991,
        "ogsTaskDaysCountdown": 364
    },
    "extra": null,
    "transactionId": "c33131d74353564c",
    "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,
    "extra": null,
    "transactionId": "5928a3252e043745",
    "pricingStrategy": "FREE"
}

AML_CASE_AUTO_RENEW_ENABLED

{
    "code": "AML_CASE_AUTO_RENEW_ENABLED",
    "message": "Case already has auto-renew enabled",
    "data": null,
    "extra": null,
    "transactionId": "1382632cbd20bc2f",
    "pricingStrategy": "FREE"
}

AML_CASE_AUTO_RENEW_NOT_ENABLED

{
    "code": "AML_CASE_AUTO_RENEW_NOT_ENABLED",
    "message": "Case does not have auto-renew enabled, cannot close renew",
    "data": null,
    "extra": null,
    "transactionId": "cbd825758e4b2070",
    "pricingStrategy": "FREE"
}

ERROR

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

}