Get the latest IDV session result for a given userId. This API returns the result of the most recent session (including sessions that are still in progress), along with the current profile status.

Request Example:

curl -X GET \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101 \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

https://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-latest-session-result?userId=xxx&solutionCode=101
GET

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token

Request Parameters

Parameter	Description
userId	`string` the `userId` from Generate URL API's request
solutionCode	`string`, `optional`. When provided, only the latest session with the specified solutionCode will be returned. Pass the code value (e.g. 101). Refer to Solution Codes for all valid values. If not provided, the latest session across all solution codes will be returned.
submissionCompleted	`bool`,`optional`. Indicates whether the frontend data submission is completed.

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
PARAMETER_ERROR	Invalid ID number, please check it
ERROR	Server error.

Response.data

Field	Description
profileStatus	`string`, The current profile lifecycle status. Possible values: `INIT` - session created but profile not yet established (first IDV in progress); `ACTIVE` - profile exists and is active; `INACTIVE` - profile exists but has been deactivated.
result	`object`. The IDV result of the latest session, same structure as Get Result API response data. If the session is still in progress, idvResult will be null. Refer to Get Result API

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "transactionId": "9cc3gef5253ceg4",
    "data": {
        "profileStatus": "INIT",
        "result": {
            "signatureId": "f6e5d4c3b2a1",
            "overallResult": null,
            "idvResult": null,
            "errorCode": null,
            "errorCodes": [],
            "faceDetail": {
                "faceResult": null
            },
            "docDetail": null,
            "inputParameters": {
                "bizId": "biz456",
                "userId": "user_002",
                "region": "SGP"
            },
            "countryCodeIso3": "SGP"
        }
    }
}

{
    "code": "SUCCESS",
    "message": "OK",
    "transactionId": "9cc3gef5253ceg4",
    "data": {
        "profileStatus": "INIT",
        "result": {
            "signatureId": "f6e5d4c3b2a1",
            "overallResult": null,
            "idvResult": null,
            "errorCode": null,
            "errorCodes": [],
            "faceDetail": {
                "faceResult": null
            },
            "docDetail": null,
            "inputParameters": {
                "bizId": "biz456",
                "userId": "user_002",
                "region": "SGP"
            },
            "countryCodeIso3": "SGP"
        }
    }
}

PARAMETER_ERROR

{
 "code": "PARAMETER_ERROR",
 "message": "externalUserId does not exist.",
 "data": null,
 "extra": null,
 "transactionId": "8bb2fdc4142bdcf3",
 "pricingStrategy": "FREE"
}

{
    "code": "PARAMETER_ERROR",
    "message": "solutionCode is wrong.",
    "data": null,
    "extra": null,
    "transactionId": "8bb2fdc4142bdcf3",
    "pricingStrategy": "FREE"
}

{
    "code": "PARAMETER_ERROR",
    "message": "submissionCompleted must be a boolean (true or false).",
    "data": null,
    "extra": null,
    "transactionId": "c3d4e5f607182930",
    "pricingStrategy": "FREE"
}

ERROR

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