Get Result API

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)

Request Header Parameters

ParameterDescription
X-ACCESS-TOKENstring Please use Token Authentication API to get your access token

Request Parameters

ParameterDescription
signatureIdstring SignatureId which can use it to get the Identity Verification result

Response Description

ParameterDescription
codeResponse's Status Code
transactionIdThe request id, the max length is 64
pricingStrategyDeprecated, Always return FREE
messageStatus Code Explanation
dataobject : the business result of Identity Verification
extraExtra response info (Exception Message)

Response.code

Status CodeMessage
SUCCESSOK
SIGNATURE_NOT_EXISTThis signatureId is not exist.
ERRORServer error.

Response.data

The table below describes the POA result fields. code: SUCCESS means the API request succeeded; it does not mean the verification passed. Use data.overallResult to determine the verification outcome. Clients should tolerate additional response fields.

FieldDescription
signatureIdstring. The verification identifier. Included in pending and completed responses.
overallResultstring or null. The overall verification outcome; see overallResult.
idvResultstring or null. Also returned with the same value as overallResult for POA. Use overallResult for outcome handling.
submissionCompletedboolean. A frontend submission indicator, not a POA completion indicator. It may remain false when overallResult is PASS or FAIL. Use overallResult to determine the business outcome.
errorCodestring or null. A single result code. SUCCESS for passed cases and null while pending. Use errorCodes for the list of verification errors.
errorCodesarray of strings. Verification error codes. Returns [] while pending and for passed POA cases, including error-code pass-through cases. Allowed-through errors are reported separately in addressDetail.passThroughErrorCodes. See errorCode for error descriptions.
addressDetailobject or null. Address verification details, when available. May be populated in passed, failed, or pending responses. Individual properties may be null. See addressDetail.
countryCodeIso3string. The region supplied to Start Verification API.
inputParametersobject. Parameters from Start Verification API.
productLevelstring or null. The product level associated with the verification, for example PRO.
faceDetailobject or null. Face verification details; null in the standalone POA examples below.
docDetailobject or null. Identity-document verification details; null in the standalone POA examples below.
docDatabaseDetailobject or null. Document database verification details; null in the standalone POA examples below.
riskLabelsRisk labels, when available; null in the standalone POA examples below.

overallResult

ValueDescription
PASSThe proof file passed verification, including cases allowed through by configuration.
FAILThe proof file failed verification.
INCOMPLETEVerification could not produce a valid result.
nullThe verification result is still pending.

addressDetail

Address details may be available before a final result, and a failed result may still include recognized address information. A null property means that value is unavailable; it must not be interpreted as a successful check.

FieldDescription
countryCodestring or null. ISO 3166-1 alpha-3 country code.
citystring or null. The city of the address.
addressstring or null. The full address.
statestring or null. The state or administrative area.
postalCodestring or null. The postal code.
address1string or null. The first part of the address.
address2string or null. The second part of the address.
address3string or null. The third part of the address.
validAddressboolean or null. Whether the address has been validated, when known. May be null, including in a passed case allowed through by configuration.
docTypestring or null. The document type identified by OCR. Known values include passport, id_card, and driving_license (lowercase). Values are not an exhaustive enum; unknown or historical values may be preserved. null when unavailable.
issueDaystring or null. The document issue date from OCR, in its original format, for example 2026-07-31 or 22/02/2021. null when unavailable.
passThroughReasonstring or null. PASS_THROUGH_ON_ERRORCODE when detected errors were allowed by the customer's configuration and the verification passed; otherwise null.
passThroughErrorCodesarray of strings or null. Detected errors allowed through by configuration, for example ["DOCUMENT_EXPIRED"]. Populated for error-code pass-through; otherwise null. The top-level data.errorCodes is [] in these passed cases.
messagestring or null. A human-readable verification message, when available. May be OK for a passed case or describe an error for a failed case; it is not restricted to failed results. It is a single description and need not describe every entry in errorCodes. Use overallResult and errorCodes for programmatic decisions.

errorCode

ValueDescription
INPUT_PARAMETERS_DO_NOT_MATCHThe 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_FAILEDThe 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_FAILEDUnable 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_EXPIREDThe submitted address document or other documents have expired and do not meet the verification requirements.
DOCUMENT_UNSUPPORTED_OR_INVALIDThe 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_FAILEDThe submission operation failed due to unavailable camera, user refusal to share permissions, or incomplete verification data/proof submitted by the user.
PROCESS_INCOMPLETEThe verification process was not completed because the user took the initiative to cancel the operation, and the overall verification cannot be finished.
ADDRESS_NOT_FOUNDAddress not found.
OTHERSOthers.

Document completeness and format

ValueDescription
SCREENSHOT_SUBMITTEDScreenshot submitted, Screenshot detected. Please upload a clear photo or original file.
PAPER_BASED_LAMINATED_DOCUMENTPaper-based/Laminated document not accepted, Paper/laminated documents not accepted. Please provide an original, unlaminated document.
DAMAGED_ALTERED_DOCUMENTDamaged/altered physical document, Document is damaged/altered. Please upload a clear, undamaged copy.
BLACK_AND_WHITE_IMAGEBlack & white image, Black-and-white image detected. Please upload a full-color image.
COPY_SCAN_SUBMITTEDCopy/scan submitted (not original), Scanned copy detected. Please upload an original document photo or file.
CROPPED_IMAGECropped image, Image is cropped. Please upload the full document with all corners visible.
HANDWRITTEN_DOCUMENTHandwritten document, Handwritten documents not accepted. Please provide an official printed document.
ADDRESS_NOT_VERIFIABLEAddress not verifiable, Address cannot be verified. Please upload a document with your full, matching address.

Document authenticity

ValueDescription
IMAGE_TAMPERING_FORGERYImage Tampering/Forgery, The uploaded image contains signs of alteration, editing, or forgery. Please upload a clear, unedited, original photograph.
NON_ORIGINAL_WEB_DERIVED_IMAGENon-Original/Web-Derived Image, The uploaded image is a copy found online or not captured in real time. Please upload a newly taken, original photo.
ALTERED_EDITED_DOCUMENT_CONTENTAltered/Edited Document Content, The document's details or information appears to be edited. Please upload an unaltered, original document.
INDIRECT_CAPTURE_SCREEN_CAPTUREIndirect Capture/Screen Capture, The document was captured via screenshot, screen recording, or another device. Please upload a direct photo of the original document.
UNVERIFIABLE_DOCUMENT_ORIGINUnverifiable Document Origin, The document's originality cannot be verified. Please provide a clear, original document in acceptable format.
NON_REAL_TIME_UPLOADNon-Real-Time Upload, The proof was uploaded retrospectively, not captured in real time. Please complete a live, real-time capture of the document.

Image quality

ValueDescription
BLURRY_UNREADABLE_IMAGEBlurry/Unreadable Image, The uploaded document image is blurry and unreadable. Please upload a clear, high-resolution photo of the full document.
INCOMPLETE_CROPPED_DOCUMENTIncomplete/Cropped Document, The document is not fully displayed or visible. Please upload the entire document with all corners and details in frame.
KEY_INFORMATION_UNREADABLEKey Information Unreadable, Critical information on the document is not clearly visible or readable. Please upload a clear photo showing all required details.
INCORRECT_ORIENTATIONIncorrect Orientation, The uploaded document is inverted or in mirror view. Please upload the document in the correct, readable orientation.

Response Examples

SUCCESS

The examples below illustrate ordinary pass, error-code pass-through, failure, and a pending result. Identifiers and personal data are illustrative. A completed POA result can still have submissionCompleted: false.

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "PASS",
    "idvResult": "PASS",
    "errorCode": "SUCCESS",
    "errorCodes": [],
    "faceDetail": null,
    "docDetail": null,
    "docDatabaseDetail": null,
    "addressDetail": {
      "countryCode": "USA",
      "city": "Example city",
      "address": "Example address",
      "state": "Example state",
      "postalCode": "Example postalCode",
      "address1": "Example address1",
      "address2": "Example address2",
      "address3": null,
      "validAddress": true,
      "docType": null,
      "issueDay": "2026-07-31",
      "passThroughReason": null,
      "passThroughErrorCodes": null,
      "message": "OK"
    },
    "inputParameters": {
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "USA",
      "firstName": "Thomas",
      "middleName": "Alva",
      "lastName": "Edison",
      "fullName": "Thomas Alva Edison",
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3": "USA",
    "productLevel": "PRO",
    "submissionCompleted": false,
    "riskLabels": null
  },
  "extra": null,
  "pricingStrategy": "FREE",
  "transactionId": "d3fde1547eeaf226"
}
{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "PASS",
    "idvResult": "PASS",
    "errorCode": "SUCCESS",
    "errorCodes": [],
    "faceDetail": null,
    "docDetail": null,
    "docDatabaseDetail": null,
    "addressDetail": {
      "countryCode": "PHL",
      "city": "Example city",
      "address": "Example address",
      "state": null,
      "postalCode": null,
      "address1": "Example address1",
      "address2": "Example address2",
      "address3": "Example address3",
      "validAddress": true,
      "docType": null,
      "issueDay": "2026-03-07",
      "passThroughReason": "PASS_THROUGH_ON_ERRORCODE",
      "passThroughErrorCodes": [
        "DOCUMENT_EXPIRED"
      ],
      "message": "OK"
    },
    "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"
    },
    "countryCodeIso3": "PHL",
    "productLevel": "PRO",
    "submissionCompleted": false,
    "riskLabels": null
  },
  "extra": null,
  "pricingStrategy": "FREE",
  "transactionId": "d3fde1547eeaf226"
}
{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": "FAIL",
    "idvResult": "FAIL",
    "errorCode": "ALTERED_EDITED_DOCUMENT_CONTENT",
    "errorCodes": [
      "ALTERED_EDITED_DOCUMENT_CONTENT"
    ],
    "faceDetail": null,
    "docDetail": null,
    "docDatabaseDetail": null,
    "addressDetail": {
      "countryCode": null,
      "city": null,
      "address": "Example address",
      "state": null,
      "postalCode": null,
      "address1": null,
      "address2": null,
      "address3": null,
      "validAddress": null,
      "docType": null,
      "issueDay": "2025-12-31",
      "passThroughReason": null,
      "passThroughErrorCodes": null,
      "message": "Altered/Edited Document Content, The document's details or information appears to be edited. Please upload an unaltered, original document."
    },
    "inputParameters": {
      "callbackUrl": "https://www.example.com/callback",
      "bizId": "7ac66c0f148de9519b8bd264312c4d64",
      "userId": "8e44f0089b076e18a718eb9ca3d94674",
      "region": "USA",
      "firstName": "Thomas",
      "middleName": "Alva",
      "lastName": "Edison",
      "fullName": "Thomas Alva Edison",
      "bizCode": "WhiteCard"
    },
    "countryCodeIso3": "USA",
    "productLevel": "PRO",
    "submissionCompleted": false,
    "riskLabels": null
  },
  "extra": null,
  "pricingStrategy": "FREE",
  "transactionId": "d3fde1547eeaf226"
}
{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId": "f302f5d2454a85c2",
    "overallResult": null,
    "idvResult": null,
    "errorCode": null,
    "errorCodes": [],
    "faceDetail": null,
    "docDetail": null,
    "docDatabaseDetail": null,
    "addressDetail": {
      "countryCode": null,
      "city": null,
      "address": "Example address",
      "state": null,
      "postalCode": null,
      "address1": null,
      "address2": null,
      "address3": null,
      "validAddress": null,
      "docType": null,
      "issueDay": "2026-09-08",
      "passThroughReason": null,
      "passThroughErrorCodes": null,
      "message": null
    },
    "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"
    },
    "countryCodeIso3": "PHL",
    "productLevel": "PRO",
    "submissionCompleted": false,
    "riskLabels": null
  },
  "extra": null,
  "pricingStrategy": "FREE",
  "transactionId": "d3fde1547eeaf226"
}

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"
}

Did this page help you?