Retrieve an Evaluation

GET {{baseurl}}/v2/api/evaluations

This endpoint begins the evaluation process on a single transaction.

Header

Name	Type	Description
token*	String	API token

Body

Name	Type	Description
actorId	String	The Id of the evaluation record in the database
startDate	String	The start date of the evaluation record in the database
endDate	String	The end date of the evaluation record in the database
transactionId	String	The ID of the transaction record in the database
workflowId	String	The ID of the workflow record in the database
workflowVersion	String	The version of the workflow record in the database
ruleAction	String	The rule action that triggered an evaluation record in the database
valueAtRisk	String	The value at risk of the evaluation record in the data base

Sample Request

{
    "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": []
}

Success Response

{
       "success": true,
       "statusCode": 201,
       "message": "Transaction successfully created and sent for evaluation!",
       "data": {},
       "links": []
     }

Error Responses

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