# Retrieve an Evaluation

<mark style="color:orange;">`GET`</mark> `{{baseurl}}/v1/api/evaluations`

This endpoint begins the evaluation process on a single transaction.

## Header

| Name                                    | Type   | Description |
| --------------------------------------- | ------ | ----------- |
| token<mark style="color:red;">\*</mark> | String | API token   |

## Body

<table><thead><tr><th width="226">Name</th><th width="175">Type</th><th>Description</th></tr></thead><tbody><tr><td>actorId</td><td>String</td><td>The Id of the evaluation record in the database</td></tr><tr><td>startDate</td><td>String</td><td>The start date of the evaluation record in the database</td></tr><tr><td>endDate</td><td>String</td><td>The end date of the evaluation record in the database</td></tr><tr><td>transactionId</td><td>String</td><td>The ID of the transaction record in the database</td></tr><tr><td>workflowId</td><td>String</td><td>The ID of the workflow record  in the database</td></tr><tr><td>workflowVersion</td><td>String</td><td>The version of the workflow record in the database</td></tr><tr><td>ruleAction</td><td>String</td><td>The rule action that triggered an evaluation record in the database</td></tr><tr><td>valueAtRisk</td><td>String</td><td>The value at risk of the evaluation record in the data base</td></tr></tbody></table>

{% tabs %}
{% tab title="Sample Response" %}

```json
{
    "success": true,
    "statusCode": 200,
    "message": "Evaluations successfully reviewed!",
    "data": {
        "docs": [
            {
              "transactionIds": [
                "65eca6640efd95250def2b00"
              ],
              "businessId": "61d88931e8e15aaf24558f1a",
              "sourceId": "653bbf50990bc8280c533de6",
              "beneficiaryId": "",
              "thirdPartyAcctNumber": "",
              "triggeredTags": [
                {
                  "_id": "65eca665de09dfc4fc8aaf22",
                  "tag": "Transaction Status",
                  "ruleScore": 50,
                  "ruleId": "65ca95ca1109ae26f1275a71",
                  "ruleAction": "Warning"
                }
              ],
              "valueAtRisk": 593000,
              "currency": "USD",
              "detectionDate": "2024-03-09T18:11:49.350539438Z",
              "createdAt": "2024-03-09T18:11:49.611Z",
              "lastModifiedAt": "2024-03-09T18:11:49.611Z",
              "_createdAt": "2024-03-09T19:11:4949+01:00",
              "_lastModifiedAt": "2024-03-09T19:11:4949+01:00",
              "id": "65eca665de19df408d8aaf21"
            },
        ],
        "pagination": {
            "totalDocs": 2,
            "perPage": 20,
            "totalPages": 1,
            "currentPage": 1,
            "serialNo": 1,
            "hasPrevPage": false,
            "hasNextPage": false,
            "prevPage": null,
            "nextPage": null
        }
    },
    "links": []
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Responses" %}

```json
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/know-your-transaction-service-kyt/transaction-management/retrieve-an-evaluation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
