> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/smart-kyc-fraud-api/api-integration/event-detail-api.md).

# 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`

<mark style="color:blue;">`GET`</mark> `/v2/services/fraud/{transactionId}/eventDetail`&#x20;

#### 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

<details>

<summary>Success JSON Response</summary>

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

</details>

### Get Status by `partnerTrxId`

<mark style="color:blue;">`GET`</mark> `/v2/services/fraud/partner/{partnerTrxId}/status`&#x20;

#### 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

<details>

<summary>Response JSON Format</summary>

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

</details>

### Sample Response

#### Full Fraud Assessment

<details>

<summary>Full Fraud JSON Response</summary>

```json
{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "302_1234@yopmail.com",
        "mobile": "+919902555726",
        "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
            }
        ]
    }
}
```

</details>

#### Biometric Fraud Assessment

<details>

<summary>Biometric Fraud JSON Response</summary>

```json
{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "302_1234@yopmail.com",
        "mobile": "+919902555726",
        "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
            }
        ],
    }
}
```

</details>

#### Data Fraud Assessment

<details>

<summary>Data Fraud JSON Response</summary>

```json
{
    "data": {
        "partnerTrxId": "{{as received in request}}",
        "groupId": "{{as received in request}}",
        "fullName": "UserBCDE",
        "emailId": "302_1234@yopmail.com",
        "mobile": "+919902555726",
        "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]"
        }
    }
}
```

</details>

### Status Table

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

<table><thead><tr><th width="157">Status</th><th>Description</th></tr></thead><tbody><tr><td>001</td><td>The fraud assessment is in progress</td></tr><tr><td>002</td><td>The fraud assessment transaction is submitted for manual review</td></tr><tr><td>003</td><td>The fraud assessment result is accepted and the certificate issued after manual review</td></tr><tr><td>004</td><td>The fraud assessment result is rejected and the certificate have been not issued after manual review</td></tr><tr><td>006</td><td>The certificate not issued</td></tr><tr><td>007</td><td>Certificate is issued</td></tr></tbody></table>