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://sg-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://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)

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://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result
POST (application/json)

https://vn-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
returnImageType	`enum` [Optional] default to URL. Refer to ReturnImageType

ReturnImageType

Supported Values	Description
URL	the value of the image fields in the response will be image urls , so the caller can download images.
BASE64	the value of image fields in the response will be base64 encoded string of image bytes.

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.
overallResult	`string`, The result code of this identity verification transaction.
submissionCompleted	`bool`, Indicates whether the frontend data submission is completed.
idvResult	`string`, The result code of this identity verification transaction. (will be deprecated, use `overallResult` instead)
errorCode	`string`, The fail reason when overallResult is `FAIL` or `INCOMPLETE`
faceDetail	`object`, The face verification result details. Refer to FaceDetail
docDetail	`object`, The document verification result details. Refer to DocDetail
feeDetail	`list`, the charging details. Refer to FeeDetail
countryCodeIso3	`string`, the `region` in the Generate URL API 's input.
inputParameters	`object`, The request parameters that from Generate URL API Refer to InputParameters

overallResult

overallResult 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.
null	the result is still in processing. (but partial results like docDetail may be ready).

errorCode

Response.data.overallResult	Value	Node	Description
PASS	SUCCESS		The user passed the identity verification.
FAIL	LIVENESS_ATTACK	face	True if faceDetail.faceLivenessScore < 50.0, else False.
	SIMILARITY_FAILED	face	True if faceDetail.faceSimilarityScore < 70.0, else False.
	ID_FORGERY_DETECTED	document	The document ( only the front part if the document is two-side) is forgery.
	STRATEGY_HIT		Security policy hit. （Deprecated)
	RISK_STRATEGY_HIT	risk	The transaction has triggered risk prevention strategies that are used to reject attacks.
	AGE_VERIFICATION_FAILED	document	The age verification of the user failed. (eg. the user's age is under 18)
	DOC_EXPIRED	document	Doc expired
	OCR_FIELD_INVALID	document	One or more required fields extracted from the document are invalid, incomplete, or do not conform to the expected format/standards
	NATIONALITY_COMPLIANCE_FAILED	document	The nationality shown on the document is not permitted under the merchant's compliance policy. (eg. restricted jurisdictions)
INCOMPLETE	NO_SUPPORTED_CARD	document	The card type detected from the document image is not supported.
	CARD_TYPE_MISMATCH	document	The card type detected from the document image doesn't match with the docType from the Generate URL API, or submitted the wrong side of the card.
	CARD_LOW_QUALITY_IMAGE	document	The document images are too poor to do identity verification.
	CARD_INFO_MISMATCH	document	The front part and the back part of the two-side document do not match with each other.
	INCOMPLETED_CARD	document	The card is not completed in the document images.
	TOO_MANY_CARDS	document	More than one cards were detected.
	CARD_NOT_FOUND	document	Can't detect card from the document image.
	OCR_NO_RESULT	document	Can't extract ocr result from the docImages
	NO_SUPPORTED_CARD_CUSTOMIZED	document	The card type is known but not supported currently. maybe support in the future.
	REGION_TYPE_MISMATCH	document	region type mismatch.
	RETRY_COUNT_REACH_MAX	face	The user's retry count reach max.
	FACE_QUALITY_TOO_POOR	face	Face quality too poor for face comparison or liveness.
	NO_FACE_DETECTED	face	No face detected on the front image of the document.
	LIVENESS_ATTACK	face	True if faceDetail.faceLivenessScore < 50.0, else False.
	SIMILARITY_FAILED	face	True if faceDetail.faceSimilarityScore < 70.0, else False.
	RISK_STRATEGY_HIT	risk	The transaction has triggered risk prevention strategies that are used to reject attacks.
	USER_TIMEOUT		User did not complete the operation within the specified time（1 hour）
	PARAMETER_ERROR		the data submitted by our frontend is not valid. this may indicates a frontend bug.
	ERROR		Error during processing in our backend. this may indicates a backend bug.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "PASS",
    "submissionCompleted": true,
    "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": {
          "idNumber": "871125523500",
          "documentNumber": null,
          "fullName": "LEE SHI YIN",
          "fullNameLocal": null,
          "lastName": null,
          "lastNameLocal": null,
          "firstName": null,
          "firstNameLocal": null,
          "middleName": null,
          "middleNameLocal": null,
          "birthday": "1987/11/25",
          "dobDay": null,
          "dobMonth": null,
          "dobYear": null,
          "expiryDate": null,
          "expiryDay": null,
          "expiryMonth": null,
          "expiryYear": null,
          "daysToExpiry": null,
          "issueDate": null,
          "issueDay": null,
          "issueMonth": null,
          "issueYear": null,
          "daysFromIssue": null,
          "state": null,
          "city": null,
          "district": null,
          "subdistrict": null,
          "fullAddress": "NO 26 JALAN DUTA 3/5 TAMAN",
          "postcode": null,
          "placeOfBirth": null,
          "issuerAuthority": null,
          "issuerPlace": null,
          "gender": "FEMALE",
          "height": null,
          "weight": null,
          "eyeColor": null,
          "bloodType": null,
          "religion": "",
          "nationality": null,
          "issuerCountry": null,
          "countryCode": null,
          "passportType": null,
          "vehicleClass": null,
          "restrictions": null,
          "endorsement": null,
          "others": {},
          "side": "front",
          "genderLocal": "PEREMPUAN",
          "nationalityLocal": null
        },
        "back": {
          "idNumber": null,
          "documentNumber": "8711567840000301",
          "fullName": null,
          "fullNameLocal": null,
          "lastName": null,
          "lastNameLocal": null,
          "firstName": null,
          "firstNameLocal": null,
          "middleName": null,
          "middleNameLocal": null,
          "birthday": null,
          "dobDay": null,
          "dobMonth": null,
          "dobYear": null,
          "expiryDate": null,
          "expiryDay": null,
          "expiryMonth": null,
          "expiryYear": null,
          "daysToExpiry": null,
          "issueDate": null,
          "issueDay": null,
          "issueMonth": null,
          "issueYear": null,
          "daysFromIssue": null,
          "state": null,
          "city": null,
          "district": null,
          "subdistrict": null,
          "fullAddress": null,
          "postcode": null,
          "placeOfBirth": null,
          "issuerAuthority": null,
          "issuerPlace": null,
          "gender": null,
          "height": null,
          "weight": null,
          "eyeColor": null,
          "bloodType": null,
          "religion": null,
          "nationality": null,
          "issuerCountry": null,
          "countryCode": null,
          "passportType": null,
          "vehicleClass": null,
          "restrictions": null,
          "endorsement": null,
          "side": "back",
          "others": {},
          "genderLocal": "PEREMPUAN",
          "nationalityLocal": null
        }
      },
      "qualityLabels": {
        "front": {
          "isBlur": false,
          "isDim": false,
          "isExposure": true
        },
        "back": null
      },
      "forgeryLabels": [
        "photocopy"
      ],
      "eventDetails": [
        {
          "event": "FE_DOCUMENT_SCAN",
          "result": "PASS",
          "createTimestmap": 1665993522952
        }
      ]
    },
    "feeDetail": [
      {
        "name": "SOLUTION",
        "type": "SOLUTION"
      }
    ],
    "countryCodeIso3": "PHL",
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard",
      "docType": null,
      "productLevel": "STANDARD"
    }
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "FAIL",
    "submissionCompleted": true,
    "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": {
          "idNumber": "871125523500",
          "documentNumber": null,
          "fullName": "LEE SHI YIN",
          "fullNameLocal": null,
          "lastName": null,
          "lastNameLocal": null,
          "firstName": null,
          "firstNameLocal": null,
          "middleName": null,
          "middleNameLocal": null,
          "birthday": "1987/11/25",
          "dobDay": null,
          "dobMonth": null,
          "dobYear": null,
          "expiryDate": null,
          "expiryDay": null,
          "expiryMonth": null,
          "expiryYear": null,
          "daysToExpiry": null,
          "issueDate": null,
          "issueDay": null,
          "issueMonth": null,
          "issueYear": null,
          "daysFromIssue": null,
          "state": null,
          "city": null,
          "district": null,
          "subdistrict": null,
          "fullAddress": "NO 26 JALAN DUTA 3/5 TAMAN",
          "postcode": null,
          "placeOfBirth": null,
          "issuerAuthority": null,
          "issuerPlace": null,
          "gender": "FEMALE",
          "height": null,
          "weight": null,
          "eyeColor": null,
          "bloodType": null,
          "religion": "",
          "nationality": null,
          "issuerCountry": null,
          "countryCode": null,
          "passportType": null,
          "vehicleClass": null,
          "restrictions": null,
          "endorsement": null,
          "others": {},
          "side": "front",
          "genderLocal": "PEREMPUAN",
          "nationalityLocal": null
        },
        "back": {
          "idNumber": null,
          "documentNumber": "8711567840000301",
          "fullName": null,
          "fullNameLocal": null,
          "lastName": null,
          "lastNameLocal": null,
          "firstName": null,
          "firstNameLocal": null,
          "middleName": null,
          "middleNameLocal": null,
          "birthday": null,
          "dobDay": null,
          "dobMonth": null,
          "dobYear": null,
          "expiryDate": null,
          "expiryDay": null,
          "expiryMonth": null,
          "expiryYear": null,
          "daysToExpiry": null,
          "issueDate": null,
          "issueDay": null,
          "issueMonth": null,
          "issueYear": null,
          "daysFromIssue": null,
          "state": null,
          "city": null,
          "district": null,
          "subdistrict": null,
          "fullAddress": null,
          "postcode": null,
          "placeOfBirth": null,
          "issuerAuthority": null,
          "issuerPlace": null,
          "gender": null,
          "height": null,
          "weight": null,
          "eyeColor": null,
          "bloodType": null,
          "religion": null,
          "nationality": null,
          "issuerCountry": null,
          "countryCode": null,
          "passportType": null,
          "vehicleClass": null,
          "restrictions": null,
          "endorsement": null,
          "side": "back",
          "others": {},
          "genderLocal": "PEREMPUAN",
          "nationalityLocal": null
        }
      },
      "qualityLabels": {
        "front": null,
        "back": null
      },
      "forgeryLabels": []
    },
    "feeDetail": [
      {
        "name": "SOLUTION",
        "type": "SOLUTION"
      }
    ],
    "countryCodeIso3": "PHL",
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard",
      "docType": null,
      "productLevel": "STANDARD"
    }
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overResult": "fail",
    "idvResult": "fail",
    "errorCode": "NOT_SUPPORTED_CARD",
    "faceDetail": {
      "faceResult": null,
      "faceImageFar": null,
      "faceImageNear": null,
      "auditImageUrl": null,
      "faceLivenessScore": null,
      "faceSimilarityScore": null
    },
    "docDetail": {
      "ocrResult": null,
      "docFrontImage": null,
      "docBackImage": null,
      "ocrInfo": null,
      "qualityLabels": null,
      "forgeryLabels": null
    },
    "feeDetail": [],
    "countryCodeIso3": "PHL",
      "inputParameters": {
        "returnUrl": "https://www.example.com",
        "failReturnUrl": "https://www.example.com/fail",
        "callbackUrl": "https://www.example.com/callback",
        "bizId": "7ac66c0f148de9519b8bd264312c4d64",
        "userId": "8e44f0089b076e18a718eb9ca3d94674",
        "region": "NGA",
        "language": "en-US",
        "prefersColorScheme": "light",
        "ignoreFailWhenJump": false,
        "bizCode": "WhiteCard",
        "docType": null,
        "productLevel": "STANDARD"
      }
    }
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "overallResult": null, // still in processing
    "submissionCompleted": false,
    "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": null,
        "back": null
      },
      "forgeryLabels": null, // in processing
      "eventDetails": [
        {
          "event": "FE_DOCUMENT_SCAN",
          "result": "PASS",
          "createTimestmap": 1665993522952
        }
      ]
    },
    "feeDetail": [
      {
        "name": "SOLUTION",
        "type": "SOLUTION"
      }
    ],
    "countryCodeIso3": "PHL",
    "inputParameters": {
      "returnUrl": "https://www.example.com",
      "failReturnUrl": "https://www.example.com/fail",
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "NGA",
      "language": "en-US",
      "prefersColorScheme": "light",
      "ignoreFailWhenJump": false,
      "bizCode": "WhiteCard",
      "docType": null,
      "productLevel": "STANDARD"
    }
  },
  "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"
}