Documentation

Delete Enroll API

Call this API to delete a userId and the enrolls.

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/face-authentication/delete-enroll \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:`{Your Access Token}`' \
  -d '{
"userId":"8e44f0089b076e18a718eb9ca3d94674"
}'

Request Url

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/face-authentication/delete-enroll 
POST (application/json)
https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/face-authentication/delete-enroll 
POST (application/json)

Request Header Parameters

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

Request Parameters

ParameterDescription
userIdstring The unique userId to identify the user.

Response Description

ParameterDescription
codeH5 Document Verification Status Code
transactionIdThe request id, the max length is 64
pricingStrategyDeprecated, Always return FREE
messageStatus Code Explanation
dataAlways null for this API
extraExtra response info (Exception Message)

Response Code

Status CodeMessage
SUCCESSOK
PARAMETER_ERRORParameter error, please check you input.
UserId is invalid
ERRORServer error

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": null,
    "extra": null,
    "transactionId": "ed8b21c0c87ad617",
    "pricingStrategy": "FREE"
}

PARAMETER_ERROR

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter error,please check you input.",
    "data":null,
    "extra":null,
    "transactionId":"ba134d6112c57a4c",
    "pricingStrategy":"FREE"
}
{
    "code":"PARAMETER_ERROR",
    "message":"UserId is invalid",
    "data":null,
    "extra":null,
    "transactionId":"dfcdc346a81f404f",
    "pricingStrategy":"FREE"
}

ERROR Response

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