After the Verification process is done on the user side, you can request the result by calling the Get Result API.

Request Example:

curl -X POST \
  https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d '{"signatureId": "f302f5d2454a85c2"}'

Request Url

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

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result
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
signatureId	`string` SignatureId which can use it to get the Face Authentication result

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` : the business result of Face Authentication
extra	Extra response info (Exception Message)

Response.code

Status Code	Message
SUCCESS	OK
SIGNATURE_NOT_EXIST	This signatureId is not exist.
ERROR	Server error.

Response.data

Field	Description
signatureId	`string`, the signatureId of this Face Authentication transaction.
idvResult	`string`, The result code of this Face Authentication transaction.
errorCode	`string`, The fail reason when idvResult is `fail`
faceDetail	`object`, The face verification result details. Refer to FaceDetail
feeDetail	`list`, the charging details. Refer to FeeDetail
countryCodeIso3	`string`, the `region` in the Generate URL API 's input.

idvResult

idvResult is the result code of the Face Authentication

Value	Description
PASS	the user passed the Face Authentication check.
FAIL	the user failed the Face Authentication check.
INCOMPLETE	the user gave up in the middle of the Face Authenticationcheck, or the user timeouts. Won't return this when the solutionCode in ["05"]

errorCode

Response.data.idvResult	Value	Description
PASS	SUCCESS	The user passed the Face Authentication.
FAIL	LIVENESS_ATTACK	True if faceDetail.faceLivenessScore < 50.0, else False.
	SIMILARITY_FAILED	True if faceDetail.faceSimilarityScore < 70.0, else False.
INCOMPLETE	PARAMETER_ERROR	the data submitted by our frontend is not valid. this may indicates a frontend bug.
	USER_TIMEOUT	User did not complete the operation within the specified time（1 hour）
	ERROR	Error during processing in our backend. this may indicates a backend bug.
	UNABLE_GET_IMAGE	User needs to enroll first.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "PASS",
    "errorCode": "SUCCESS",
    "faceDetail": {
      "faceResult": "PASS",
      "faceImageFar": "https://abc.com/faceImageFar.jpg",
      "faceImageNear": "https://abc.com/faceImageNear.jpg",
      "auditImageUrl": "https://abc.com/auditImage.zip",
      "faceLivenessScore": 99,
      "faceSimilarityScore": 82,
      "eventDetails": [
        {
          "event": "FE_DOCUMENT_SCAN",
          "result": "PASS",
          "createTimestmap": 1665993522952
        }
      ]
    },
    "feeDetail": [
      {
        "name": "SOLUTION",
        "type": "SOLUTION"
      }
    ],
    "countryCodeIso3": "PHL"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "FAIL",
    "errorCode": "LIVENESS_ATTACK",
    "faceDetail": {
      "faceResult": "FAIL",
      "faceImageFar": "https://abc.com/faceImageFar.jpg",
      "faceImageNear": "https://abc.com/faceImageNear.jpg",
      "auditImageUrl": "https://abc.com/auditImage.zip",
      "faceLivenessScore": 0.0,
      "faceSimilarityScore": 82.0
    },
    "countryCodeIso3": "PHL"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

SIGNATURE_NOT_EXIST

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

ERROR

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

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

ERROR

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