Event Detail API

The Event Detail API provides in-depth information on fraud assessment data and the associated score. This API can be accessed using either the transactionId, giving partners the flexibility to retrieve detailed assessment information through asynchronous API calls.

Get Event Detail by transactionId

GET /v2/services/fraud/{transactionId}/eventDetail

Path Parameters

Name	Type	Description
transactionId	String	Transaction ID that is produced on transaction request.

Headers

Name	Type	Description
Authorization*	String	OAuth access token. Get the token by calling the Get Access Token API
Content-Type	application/json	Format type of request body

Success Response

Success JSON Response

{
  "data": {
    "partnerTrxId": "{{as received in request}}",
    "groupId": "{{as received in request}}",
    "transactionType": "FULL_FRAUD_ASSESSMENT",
    "transactionId": "3282d003-c62c-4b7b-87e4-9d0a1bbf0c18",
    "status": "<code>"
  }
}

Get Status by partnerTrxId

GET /v2/services/fraud/partner/{partnerTrxId}/status

Path Parameters

Name	Type	Description
partnerTrxId	String	Unique identifier provided by the partner for the transaction.

Headers

Name	Type	Description
Authorization*	String	OAuth access token. Get the token by calling the Get Access Token API
Content-Type	application/json	Format type of request body

Response Format

Response JSON Format

{
  "data": {
    "partnerTrxId": "{{as received in request}}",
    "groupId": "{{as received in request}}",
    "transactionType": "FULL_FRAUD_ASSESSMENT",
    "transactionId": "3282d003-c62c-4b7b-87e4-9d0a1bbf0c18",
    "status": "<code>"
  }
}

Sample Response

Full Fraud Assessment

Full Fraud JSON Response

{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "[e-mail]",
        "mobile": "[phone]",
        "govId": "3511000202881234",
        "dob": "1988-02-02",
        "transactionType":"FULL_FRAUD_ASSESSMENT",
        "selfiePhoto": "{{selfie image bas64}}",
        "idCardPhoto": "{{id card image base64}}",
        "fraudAssessment": "COMPLETED",
        "status": {{status}},
        "authenticationLevel": "AAL2",
        "certificate": {
            "level": 2,
            "detail": "Certificate with long term validity is issued and its utilization is for digital signature and digital identity purpose in VIDA system."
        },
        "assessmentResults": [
            {
                "name": "selfie-photo-match",
                "result": 0.9
            },
            {
                "name": "image-liveness",
                "result": 0.1
            },
            {
                "name": "image-manipulation",
                "result": 0.01
            },
            {
                "name": "full-name",
                "result": 1.0
            },
            {
                "name": "mother-maiden-name",
                "result": 1.0
            },
            {
                "name": "dob",
                "result": 1.0
            },
            {
                "name": "pob",
                "result": 1.0
            },
            {
                "name": "address",
                "result": 1.0
            },
            {
                "name": "village",
                "result": 1.0
            },
            {
                "name": "district",
                "result": 1.0
            },
            {
                "name": "province",
                "result": 1.0
            }
        ]
    }
}

Biometric Fraud Assessment

Biometric Fraud JSON Response

{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "[e-mail]",
        "mobile": "[phone]",
        "govId": "3511000202881234",
        "transactionType": "BIOMETRIC_FRAUD_ASSESSMENT",
        "selfiePhoto": "{{selfie image base 64}}",
        "idCardPhoto": "{{id card image base 64}}",
        "fraudAssessment": "COMPLETED",
        "status": {{status}},
        "authenticationLevel": "AAL1",
        "certificate": {
            "level": 2,
            "detail": "Certificate with long term validity is issued and its utilization is bound to the certificate requesting client"
        },
        "assessmentResults": [
            {
                "name": "selfie-photo-match",
                "result": 0.9
            },
            {
                "name": "image-liveness",
                "result": 0.01
            },
            {
                "name": "image-manipulation",
                "result": 0.01
            }
        ],
    }
}

Data Fraud Assessment

Data Fraud JSON Response

{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "[e-mail]",
        "mobile": "[phone]",
        "selfiePhoto": "{{selfie image base64}}",
        "idCardPhoto": "{{id card image base64}}",
        "govId": "3511000202881234",
        "dob": "1988-02-02",
        "transactionType": "DATA_FRAUD_ASSESSMENT",
        "fraudAssessment": "COMPLETED",
        "status": {{status}},
        "authenticationLevel": "AAL1",
        "certificate": {
            "level": 2,
            "detail": "Certificate with long term validity is issued and its utilization is bound to the certificate requesting client"
        },
        "assessmentResults": [
            {
                "name": "full-name",
                "result": 1.0
            },
            {
                "name": "dob",
                "result": 1.0
            },
            {
                "name": "pob",
                "result": 1.0
            }
        ],
        // In case there's failure,
        // the kyc failure details will be available as follows
        "failureDetail": {
            "errorCode": 4008,
            "detail": "Invalid data. Please try again - [selfiePhoto]"
        }
    }
}

Status Table

The status field provides detailed information about the current state of the fraud transaction. It may contain the following values:

Status	Description
001	The fraud assessment is in progress
002	The fraud assessment transaction is submitted for manual review
003	The fraud assessment result is accepted and the certificate issued after manual review
004	The fraud assessment result is rejected and the certificate have been not issued after manual review
006	The certificate not issued
007	Certificate is issued