After the Verification process is done, 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://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

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.
errorCodes	`array`, The array of the `errorCode`.
addressDetail	`object`,The address detail. Refer to `addressDetail`.
countryCodeIso3	`string`, the `region` in the Start Verification API's input.
inputParameters	`object`, The request parameters that from Start Verification API

overallResult

overallResult is the result code of the identity verification

Value	Description
PASS	the proof file passed the verification.
FAIL	the proof file failed the verification.
INCOMPLETE	the verification is unable to get a valid result.
null	the verification is still in processing.

addressDetail

Field	Description
countryCode	`string`, the countryCode is ISO 3.
city	`string`, The city of the address.
address	`array`, The full address.
state	`object`,The state of the address.
postalCode	`string`, the postal code of the address.
address1	`string`, the first part of address.
address2	`string`, the second part of address.
address3	`string`, the third part of address.
validAddress	`bool`, `true` means the address is been validated.
docType	`string`, the document type identified by OCR, e.g. `PASSPORT, ID_CARD, DRIVING_LICENSE, OTHER.` null if not recognized.
issueDay	`string`, the issue date of the document from OCR, in original format e.g. `22/02/2021`. null if not recognized.
passThroughReason	`string`, when certain predefined error codes (e.g. document expired, poor image quality) are configured as acceptable for a customer, the system will still mark the transaction result as PASS instead of FAIL. In this case, passThroughReason is set to `PASS_THROUGH_ON_ERRORCODE` to indicate that the PASS result was granted through the error-code whitelist mechanism rather than a clean verification. When the transaction is verified normally without any whitelisted errors being triggered, this field is null.
passThroughErrorCodes	`array`, the specific error codes that were detected during verification but allowed to pass through due to the customer's whitelist configuration. For example, `["DOCUMENT_EXPIRED", "FRAUD_RISK"]` means the document was expired and flagged as fraud risk, but both error codes were in the customer's allowed list, so the transaction was still approved. This field is only present when passThroughReason is `PASS_THROUGH_ON_ERRORCODE`; otherwise it is null
message	`string`, a human-readable description of the error reason. e.g. `"Screenshot submitted, Screenshot detected. Please upload a clear photo or original file."` Only present when idvResult is fail or incomplete; `null` when idvResult is pass.

errorCode

Value	Description
FRAUD_RISK	Fraud-related risks such as modified, non-original, or non-real-time captured document images are detected, and the originality of the document cannot be verified.
INPUT_PARAMETERS_DO_NOT_MATCH	The name, address, issuance date and other information of the uploaded document are inconsistent with the provided/recorded parameters, or the document does not match the selected option.
PROOF_DOCUMENT_MATCHING_FAILED	The main proof and supplementary proof, address proof and identity document, front and back of the certificate and other document information belong to different people or the content does not match.
DATA_VERIFICATION_FAILED	Unable to verify information such as age, address, bank transfer number, tax identification number, or the address is invalid, or the document issuing country is not supported.
DOCUMENT_INCOMPLETE	The uploaded file is in non-compliant forms such as screenshots, copies, paper/laminated/damaged/handwritten, or lacks address information, or data is affected due to damage.
POOR_IMAGE_QUALITY	The uploaded document image is blurred, not fully displayed, key information is unreadable, or the document is inverted/mirrored resulting in unrecognizable content.
DOCUMENT_EXPIRED	The submitted address document or other documents have expired and do not meet the verification requirements.
DOCUMENT_UNSUPPORTED_OR_INVALID	The document type is inconsistent, non-compliant documents are used as address proof, the document source is non-compliant, test cards/damaged images are uploaded, or no valid document is identified.
USER_SUBMISSION_FAILED	The submission operation failed due to unavailable camera, user refusal to share permissions, or incomplete verification data/proof submitted by the user.
PROCESS_INCOMPLETE	The verification process was not completed because the user took the initiative to cancel the operation, and the overall verification cannot be finished.
ADDRESS_NOT_FOUND	Address not found.
OTHERS	Others.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "PASS",
    "errorCodes": [],
    "addressDetail": {
      "countryCode":"PHL",
      "city": "xxx",
      "address": "xx",
      "state": "xx",
      "postalCode": "xx",
      "address1": "xx",
      "address2": "",
      "address3":"",
      "validAddress": true,
			"docType": "DRIVING_LICENSE",
      "issueDay": "22/02/2021",
      "passThroughReason": "PASS_THROUGH_ON_ERRORCODE",
      "passThroughErrorCodes": ["FRAUD_RISK", "DOCUMENT_EXPIRED"]
    },
    "countryCodeIso3": "PHL",
    "inputParameters": {
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "PHL",
      "firstName": "Thomas",
      "middleName": "Alva",
      "lastName": "Edison",
      "fullName": "Thomas Alva Edison",
      "bizCode": "WhiteCard"
    }
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "FAIL",
    "errorCodes": ["FRAUD_RISK"],
    "countryCodeIso3": "PHL",
    "inputParameters": {
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "PHL",
      "firstName": "Thomas",
      "middleName": "Alva",
      "lastName": "Edison",
      "fullName": "Thomas Alva Edison",
      "bizCode": "WhiteCard"
    }
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "idvResult": null, // still in processing
    "errorCodes": null,
    "countryCodeIso3": "PHL",
    "inputParameters": {
    "callbackUrl": "https://www.example.com/callback",
    "bizId": "7ac66c0f148de9519b8bd264312c4d64", 
    "userId":"8e44f0089b076e18a718eb9ca3d94674",
    "region":"PHL",
 		"firstName": "Thomas",
    "middleName": "Alva",
    "lastName": "Edison",
    "fullName": "Thomas Alva Edison",
    "bizCode":"WhiteCard"
    }
  },
  "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"
}