Documentation

PII Data Retention API

After the Verification result is , you can request the result by calling the API

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data?signatureId=681760d460df34eb \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)
https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)
https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)
https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)
https://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)
https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/clear-data
POST (application/json)

Request Header Parameters

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

Request Parameters

ParameterDescription
signatureIdstring SignatureId which can use it to get the Identity Verification result

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_ERRORSignatureId is empty
SignatureId is not exist
Transaction is not finished
REQUEST_IN_PROCESSINGYour request is currently being processed. Please do not submit it repeatedly
ERRORServer error.

Response Examples

SUCCESS

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

PARAMETER_ERROR

{
    "code":"PARAMETER_ERROR",
    "message":"SignatureId is  empty",
    "data":null,
    "extra":null,
    "transactionId":"b6d722f7e9f553ae",
    "pricingStrategy":"FREE"
}

ERROR

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