Face-Search Enroll Face API

Call this API to add a face of a FAIL transaction to the relative face set.

Request Example:

curl -X POST \
 https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/face-search-enroll\ 
 -H 'Content-Type: application/json' \
 -H 'X-ACCESS-TOKEN:{Your Access Token}' \
 -d '{"signatureId": "730baa5ab2e34e53"}'

Request Url

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

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

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

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

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

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

Notes:

If your test/official environment is in China, please request the service via VPN to avoid packet loss, service timeout and other problems

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token

Request Parameters

Parameter	Description
signatureId	`string` which can use it to get the H5 IDV result

Response Description

Parameter	Description
code	Status Code
transactionId	The request id, the max length is 64
pricingStrategy	`Deprecated`, Always return `FREE`
message	Status Code Explanation
data	`signatureId` signatureId from request parameters.
extra	Extra response info (Exception Message)

Response Code

Status Code	Message
SUCCESS	`free` OK
PARAMETER_ERROR	`free` Parameter error,please check you input.
	`free`Parameter should not be empty.
	`free` Transaction is not pass.
	`free`Transaction is not be enrolled.
SIGNATURE_NOT_EXIST	`free`This signatureId is not exist.
SIGNATURE_ALREADY_ENROLLED	`free`The signatureId has already been enrolled.
ERROR	`free` Server error

Response Examples

SUCCESS Response

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

PARAMETER_ERROR Response

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

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter should not be empty.",
    "data":null,
    "extra":null,
    "transactionId":"dfcdc346a81f404f",
    "pricingStrategy":"FREE"
}

{
 "code": "PARAMETER_ERROR",
 "message": "Transaction is not pass.",
 "data": null,
 "extra": null,
 "transactionId": "b4982f94824df196",
 "pricingStrategy": "FREE"
}

{
 "code": "PARAMETER_ERROR",
 "message": "Transaction is not be enrolled.",
 "data": null,
 "extra": null,
 "transactionId": "b4982f94824df196",
 "pricingStrategy": "FREE"
}

SIGNATURE_NOT_EXIST Response

{
    "code":"SIGNATURE_NOT_EXIST",
    "message":"This signatureId is not exist.",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"
}

SIGNATURE_ALREADY_ENROLLED Response

{
    "code":"SIGNATURE_NOT_EXIST",
    "message":"The signatureId has already been enrolled.",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"
}

ERROR Response

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