After the Verification process is done on the user side, you can request the Verification 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)

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 Verification 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 Verification
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 verification transaction.
idvResult	`string`, The result code of this verification transaction.
errorCode	`string`, The fail reason when eckyResult is `fail` or `INCOMPLETE`.
docDatabaseDetail	`object`, The document verification result details. Refer to DocDatabaseDetail
faceDetail	`object`, The face verification result details. Refer to FaceDetail
inputParameters	`object`, The request details from Generate URL API's input. Refer to InputParameters
countryCodeIso3	`string`, the `region` in the Generate URL API 's input.

idvResult

idvResult is the result code of the verification

Value	Description
PASS	the user passed the verification check.
FAIL	the user failed the verification check.
INCOMPLETE	the user gave up in the middle of the verification check, or the user timeouts.

errorCode

Response.data.idvResult	Value	Description
PASS	SUCCESS	The user passed the verification.
FAIL	BVN_NOT_EXIST	the bvn inputed by the user doesn't exists.
	BVN_SUSPEND	The ID has been restricted from use by the official institution. The user should go to the relevant department to handle the recover procedures.
	LIVENESS_ATTACK	The liveness check failed.
	SIMILARITY_FAILED	The liveness face and the face belong to the number are not considered as the same person.
	STRATEGY_HIT	Security policy hit
INCOMPLETE (FAIL when solutionCode in ["05"])	BVN_INVALID_FORMAT	The card type detected from the document image is not supported.
	PARAMETER_ERROR	the data submitted by our frontend is not valid. this may indicates a frontend bug.
	BVN_DATASOURCE_UNSTABLE	bvn datasource is unstable to complete the bvn verification.
	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.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "PASS",
    "errorCode": "SUCCESS",
    "docDatabaseDetail": {
      "bvn": "22********4",
      "firstName": "T****E",
      "middleName": "C****T",
      "lastName": "I***A",
      "gender": "FEMALE",
      "birthday": "1994/07/13",
      "phoneNumber": "081******05",
      "phoneNumber2": ""
    },
    "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
        }
      ]
    },
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "numberType": "BVN",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3":"MYS"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "FAIL",
    "errorCode": "LIVENESS_ATTACK",
    "docDatabaseDetail": {
      "bvn": "22********4",
      "firstName": "T****E",
      "middleName": "C****T",
      "lastName": "I***A",
      "gender": "FEMALE",
      "birthday": "1994/07/13",
      "phoneNumber": "081******05",
      "phoneNumber2": ""
    },
    "faceDetail": {
      "faceResult": "FAIL",
      "faceImageFar": "https://abc.com/faceImageFar.jpg",
      "faceImageNear": "https://abc.com/faceImageNear.jpg",
      "auditImageUrl": "https://abc.com/auditImage.zip",
      "faceLivenessScore": 0,
      "faceSimilarityScore": null,
      "eventDetails": [
        {
          "event": "FE_DOCUMENT_SCAN",
          "result": "PASS",
          "createTimestmap": 1665993522952
        }
      ]
    },
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "numberType": "BVN",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3":"MYS"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "FAIL",
    "errorCode": "BVN_NOT_EXIST",
    "docDatabaseDetail": null,
    "faceDetail": null,
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "numberType": "BVN",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3":"MYS"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "idvResult": "INCOMPLETE",
    "errorCode": "BVN_INVALID_FORMAT",
    "docDatabaseDetail": null,
    "faceDetail": null,
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "numberType": "BVN",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3":"MYS"
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226"
}

SIGNATURE_NOT_EXIST

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

ERROR

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