Update Status API

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/update-profile-status \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d '
 {
    "externalUserId": "old123",
    "status": "INACTIVE"
}
'

Request Url

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/update-profile-status
POST (application/json)

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/update-profile-status
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
externalUserId	`string` the userId from Generate URL API's request
status	`string` `INACTIVE` ( `ACTIVE` is currently not supported)

Response Description

Parameter	Description
code	Response's Status Code
transactionId	The request id, the max length is 64
pricingStrategy	`Deprecated`, Always return `FREE`
message	Status Code Explanation
data	`object` ,Always return `null` for this API
extra	Extra response info (Exception Message)

Response.code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Invalid externalUserId, please check it
ERROR	Server error.

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "transactionId": "8bb2fdc4142bdcf3",
    "data": null
}

PARAMETER_ERROR

{
    "code": "PARAMETER_ERROR",
    "message": "Invalid externalUserId, please check it",
    "data": null,
    "extra": null,
    "transactionId": "8bb2fdc4142bdcf3",
    "pricingStrategy": "FREE"
}

ERROR

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

Updated 10 days ago