Documentation

Update UserId API

Request Example:

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

Request Url

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

Request Header Parameters

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

Request Parameters

ParameterDescription
oldExternalUserIdstring the userId from Generate URL API's request
newExternalUserIdstring the newExternalUserId.

Response Description

ParameterDescription
codeResponse's Status Code
transactionIdThe request id, the max length is 64
pricingStrategyDeprecated, Always return FREE
messageStatus Code Explanation
dataobject ,Always return null for this API
extraExtra response info (Exception Message)

Response.code

Status CodeMessage
SUCCESSOK
PARAMETER_ERRORInvalid ID number, please check it
ERRORServer error.

Response Examples

SUCCESS

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

PARAMETER_ERROR

{
    "code": "PARAMETER_ERROR",
    "message": "The oldExternalUserId does not exists",
    "data": null,
    "extra": null,
    "transactionId": "8bb2fdc4142bdcf3",
    "pricingStrategy": "FREE"
}
{
    "code": "PARAMETER_ERROR",
    "message": "The newExternalUserId already exists",
    "data": null,
    "extra": null,
    "transactionId": "8bb2fdc4142bdcf3",
    "pricingStrategy": "FREE"
}

ERROR

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