KYC V2 APIIndividual Results

Update the status of Fraud process results

Update the status of a set of Fraud process results. The request body supports batch processing of fraud results with the following components:

  • processResults: Array of UUID strings identifying specific fraud Process Results to update - manualStatus: The resolution status for the fraud, which can be one of:
    • FALSE_POSITIVE: When the result is determined to be false positive.
    • TRUE_POSITIVE: When the result is determined to be true positive.
    • UNKNOWN: When the result is still being evaluated and you do not yet want to resolve it.
  • comment: Optional documentation for the decision rationale, useful for audit trails and team communication

Path parameters

entityIdstringRequired

Headers

api_keystringRequired
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 PROs created when a fraud has been found.
manualStatusenumRequired

The status that the fraud process result should be set to after the results have been reviewed.

  • FALSE_POSITIVE: When the result is determined to be false positive and it is an acceptable risk.
  • TRUE_POSITIVE_ACCEPT: When the result is determined to be true positive and it is an acceptable risk.
  • TRUE_POSITIVE_REJECT: When the result is determined to be true positive and it is an unacceptable risk.
Allowed values:
commentobjectOptional

Response

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

Errors