Update Results

Update the status of activity process results.

Authentication

api_keystring
API Key authentication via header

Path Parameters

entityIdstringRequired
Unique identifier for an entity

Headers

api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional
Username provided by API caller

Request

This endpoint expects an object.
processResultslist of stringsRequired
The process result IDs to update. These are the results created when activities have been flagged for review.
manualStatusenumRequired
The status of the result. - FALSE_POSITIVE: When the result is determined to be false positive and the activity is within the risk profile to continue. - TRUE_POSITIVE_ACCEPT: When the result is determined to be true positive and the activity is within the risk profile to continue. - TRUE_POSITIVE_REJECT: When the result is determined to be true positive and the activity is NOT within the risk profile to continue. - IN_REVIEW: When the activity has been picked up for review.
Allowed values:
commentobjectOptional

Response

OK
requestIdstring
The unique request identifier for the API call made.
processResultslist of objects or null

Errors