ID Fraud Shield Enabled

This is the Liveness Transaction Details API when ID Fraud Shield is enabled. In this configuration, the API returns both the VIDA Liveness detection result and the ID Fraud Shield analysis result.

The ID Fraud Shield analysis provides an additional fraud risk assessment based on the captured identity verification data. Depending on the configured risk threshold, the ID Fraud Shield result may influence the final liveness transaction outcome.

To retrieve the transaction details, partners must provide the transaction ID obtained from the Liveness API response or the SDK liveness output.

Liveness API

GET https://{vida.host}/biometrics/v3/services/face/liveliness?transactionId={UUID}

Headers

Name	Type	Description
Authorization*		OAuth access token. Get the token by calling the Authentication API

API Response

Liveness Passed + ID Fraud Shield Passed

Liveness transaction completed successfully with scores below threshold.

ID Fraud Shield transaction completed successfully with scores below threshold.

HTTP Status: 200

Passive Liveness, Active Liveness - JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "Unique transaction id generated to identify this transaction",
            "transactionCode": 1043
        },
        "scores": [
            {
                "scoreName": "IMAGE_MANIPULATION",
                "scoreValue": 0.137531
            },
            {
                "scoreName": "LIVENESS",
                "scoreValue": 0.138303
            }
        ],
        "image": "Base64 Image…",    
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }

Color Flash - JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "Unique transaction id generated to identify this transaction",
            "transactionCode": 1043
        },
        "scores": [
            {
                "scoreName": "COLOR_CAPTCHA",
                "scoreValue": 0.3425
            },
            {
                "scoreName": "IMAGE_MANIPULATION",
                "scoreValue": 0.1009
            },
            {
                "scoreName": "LIVENESS",
                "scoreValue": 0.132
            }
        ],
        "image": "Base64 Image…",    
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }

Liveness Passed + ID Fraud Shield Threshold Exceeded

Liveness transaction completed successfully with scores below threshold.

ID Fraud Shield transaction completed successfully with scores exceeded threshold.

HTTP Status: 200

JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "unique transaction id generated to identify this transaction",
            "transactionCode": 10001
        },
        "errors": [
            {
                "code": 1705,
                "title": "Fraud shield risk level exceeded error threshold",
                "detail": "Fraud shield risk level exceeded error threshold"
            }
        ],
        "image": "Base64 image",
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }

Liveness Threshold Exceeded + ID Fraud Shield Passed

Liveness transaction completed successfully with scores above threshold.

ID Fraud Shield transaction completed successfully with scores below threshold.

HTTP Status: 200

JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "Transaction ID from User",
            "transactionCode": 1043
        },
        "scores": [
            {
                "scoreName": "IMAGE_MANIPULATION",
                "scoreValue": 0.137531
            },
            {
                "scoreName": "LIVENESS",
                "scoreValue": 0.138303
            }
        ],
        "image": "Base64 Image…",    
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }

Liveness Threshold Exceeded + ID Fraud Shield Threshold Exceeded

Liveness transaction completed successfully with scores above threshold.

ID Fraud Shield transaction completed successfully with scores exceeded threshold.

HTTP Status: 200

JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "unique transaction id generated to identify this transaction",
            "transactionCode": 10001
        },
        "errors": [
            {
                "code": 1705,
                "title": "Fraud shield risk level exceeded error threshold",
                "detail": "Fraud shield risk level exceeded error threshold"
            }
        ],
        "image": "Base64 image",
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }
        

Liveness Failed + ID Fraud Shield Passed

Liveness transaction failed due to particular reason.

ID Fraud Shield transaction completed successfully with scores below threshold.

HTTP Status: 200

JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "unique transaction id generated to identify this transaction",
            "transactionCode": 10001
        },
        "errors": [
            {
                "code": 1063,
                "title": "Image Quality Is Below Threshold",
                "detail": "Unnatural colour"
            },
            {
                "code": 1075,
                "title": "Image Quality Is Below Threshold",
                "detail": "Over Exposure"
            },
            {
                "code": 1076,
                "title": "Image Quality Is Below Threshold",
                "detail": "Image Is Blur"
            },
	     {
                "code": 1705,
                "title": "Fraud shield risk level exceeded error threshold",
                "detail": "Fraud shield risk level exceeded error threshold"
            }
        ],
        "image": "Base64 image",
        "fraudResult": {
        ...
        // Detail information will be shared by VIDA team
        }

Liveness Failed + ID Fraud Shield Threshold Exceeded

Liveness transaction failed due to particular reason.

ID Fraud Shield transaction completed successfully with scores exceeded threshold.

HTTP Status: 200

JSON Response

{
    "data": {
        "transaction": {
            "transactionId": "unique transaction id generated to identify this transaction",
            "transactionCode": 10001
        },
        "errors": [
            {
                "code": 1063,
                "title": "Image Quality Is Below Threshold",
                "detail": "Unnatural colour"
            },
            {
                "code": 1075,
                "title": "Image Quality Is Below Threshold",
                "detail": "Over Exposure"
            },
            {
                "code": 1076,
                "title": "Image Quality Is Below Threshold",
                "detail": "Image Is Blur"
            },
	         {
                "code": 1706,
                "title": "Fraud shield risk transaction detail not found",
                "detail": "Fraud shield risk level transaction detail not found"
            }	
        ],
        "image": "Base64 image",
        "fraudAnalysis": {
        ...
        // Detail information will be shared by VIDA team
        }