After the Identity Verification process is done on the user side, you can request the IDV 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://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result
POST (application/json)

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

https://th-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)

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 Identity 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 Identity 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 identity verification transaction.
idvResult	`string`, The result code of this identity verification transaction.
errorCode	`string`, The fail reason when eckyResult is `fail`
faceDetail	`object`, The face verification result details. Always be null when solutionCode in ["02","03","05"] Refer to FaceDetail
docDetail	`object`, The document verification result details. Always be null when solutionCode in ["04"] Refer to DocDetail
feeDetail	`list`, the charging details. Refer to FeeDetail

idvResult

idvResult is the result code of the identity verification

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

errorCode

Response.data.idvResult	Value	Description	01	02	03	04	05	06
PASS	SUCCESS	The user passed the identity verification.	✅	✅	✅	✅	✅	✅
FAIL	LIVENESS_ATTACK	True if faceDetail.faceLivenessScore < 50.0, else False.	✅			✅		✅
	SIMILARITY_FAIL	True if faceDetail.faceSimilarityScore < 70.0, else False.	✅			✅		✅
	NO_FACE_DETECTED	No face detected on the front image of the document.	✅	✅	✅	✅	✅	✅
	CARD_INFO_MISMATCH	The front part and the back part of the two-side document do not match with each other.	✅	✅	✅		✅	✅
	ID_FORGERY_DETECTED	The document ( only the front part if the document is two-side) is forgery.	✅	✅			✅	✅
	STRATEGY_HIT	Security policy hit
INCOMPLETE (FAIL when solutionCode in ["05"])	NO_SUPPORTED_CARD	The card type detected from the document image is not supported.	✅	✅	✅		✅	✅
	CARD_TYPE_MISMATCH	The card type detected from the document image doesn't match with the docType from the Generate URL API	✅	✅	✅		✅	✅
	CARD_LOW_QUALITY_IMAGE	The document images are too poor to do identity verification.	✅	✅	✅		✅	✅
	INCOMPLETED_CARD	The card is not completed in the document images.	✅	✅	✅		✅	✅
	TOO_MANY_CARDS	More than one cards were detected.	✅	✅	✅		✅	✅
	CARD_NOT_FOUND	Can't detect card from the document image.	✅	✅	✅		✅	✅
	OCR_NO_RESULT	Can't extract ocr result from the docImages	✅	✅	✅		✅	✅
	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.	✅	✅	✅	✅	✅	✅
	NO_SUPPORTED_CARD_CUSTOMIZED	The card type is known but not supported currently. maybe support in the future.						✅

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
                }
            ]
        },
        "docDetail": {
            "ocrResult": "PASS",
            "docFrontImage": "https://abc.com/idFrontImage.jpg",
            "docBackImage": "https://abc.com/idBackImage.jpg",
            "docType": {
                "front": "MY-ID-MYKAD",
                "back": "MY-ID-MYKAD"
            },
            "subDocType": {
                "front": "MY-ID-MYKAD",
                "back": "MY-ID-MYKAD"
            },
            "ocrInfo": {
                "front": {
                    "gender": "PEREMPUAN",
                    "name": "****** ******",
                    "address": "****** ****** ****** ******",
                    "idNumber": "************",
                    "religion": "",
                    "birthday": "1977/10/28",
                    "citizen": "MYS"
                },
                "back": {
                    "idNumber": "************"
                }
            },
            "qualityLabels": {
                "front": [

                ],
                "back": [

                ]
            },
            "forgeryLabels": [
                "photocopy"
            ],
            "eventDetails": [
                {
                    "event": "FE_DOCUMENT_SCAN",
                    "result": "PASS",
                    "createTimestmap": 1665993522952
                }
            ]
        },
       feeDetail: [
  				{
    				"name": "SOLUTION",
    				"type": "SOLUTION"
						}
					]

    },
    "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
      },
      "docDetail":  {
        "docResult": "PASS",
        "idFrontImage": "https://abc.com/idFrontImage.jpg",
        "idBackImage": "https://abc.com/idBackImage.jpg",
				"ocrInfo": {
        "front": {
          "gender": "PEREMPUAN",
          "name": "****** ******",
          "address": "****** ****** ****** ******",
          "idNumber": "************",
          "religion": "",
          "birthday": "1977/10/28",
          "citizen": "MYS"
        },
        "back": {
          "secondaryIdNumber": "************"
        }
      },
        "qualityLabels": {
          "front": [],
          "back": []
				},
        "forgeryLabels": [] 
      },
     feeDetail: [
  				{
    				"name": "SOLUTION",
    				"type": "SOLUTION"
						}
		 ]
    },
    "extra": null,
    "transactionId": "d3fde1547eeaf226",
    "pricingStrategy": "FREE"
}

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
      "signatureId":"f302f5d2454a85c2",
      "idvResult":"fail",
      "errorCode":"NOT_SUPPORTED_CARD",
      "faceDetail": {
         "faceResult": null,
        "faceImageFar": null,
        "faceImageNear": null,
				"auditImageUrl": null,
				"faceLivenessScore": null,
        "faceSimilarityScore": null
       
      },
      "docDetail":  {
        "docResult": null,
        "docFrontImage": null,
        "docBackImage": null,
				"ocrInfo": null,
        "qualityLabels": null,
        "forgeryLabels": null
      },
      "feeDetail":[]
    },
    "extra": null,
    "transactionId": "d3fde1547eeaf226",
    "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "idvResult": null, // still in processing
    "errorCode": null,
    "faceDetail": {
      "faceResult": "pass",
      "faceImageFar": "https://abc.com/faceImageFar.jpg",
      "faceImageNear": "https://abc.com/faceImageNear.jpg",
      "auditImageUrl": "https://abc.com/auditImage.zip",
      "faceLivenessScore": 99,
      "faceSimilarityScore": null, // in processing
      "eventDetails": [
          {
              "event": "FE_DOCUMENT_SCAN",
              "result": "PASS",
              "createTimestmap": 1665993522952
          }
      ]
    },
    "docDetail": {
      "ocrResult": PASS,
      "docFrontImage": "https://abc.com/idFrontImage.jpg",
      "docBackImage": "https://abc.com/idBackImage.jpg",
      "ocrInfo": {
        "front": {
          "birthday": "OCTOBER 28,1977",
          "name": "**************",
          "birthdayParsed": "1977/10/28",
          "idNumber": "09-*******-*"
        },
        "back": null
      },
      "qualityLabels": {
        "front": [],
        "back": []
      },
      "forgeryLabels": null, // in processing
      "eventDetails": [
          {
              "event": "FE_DOCUMENT_SCAN",
              "result": "PASS",
              "createTimestmap": 1665993522952
          }
      ]
    },
    "feeDetail": [
  	   {
    			"name": "SOLUTION",
    			"type": "SOLUTION"
			 }
		]
  },
  "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"
}