KYC V2 APIIndividual Results

Update the status of AML process results

Update the status of a set of AML process results.

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 stringsOptional
manualStatusenumOptional

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

  • FALSE_POSITIVE: The result is determined to be a false positive, but you do not necessarily want to resolve it.
  • TRUE_POSITIVE_ACCEPT: The result is determined to be a true positive and you want to resolve it. “Accept” infers you want to accept the activity.
  • TRUE_POSITIVE: The result is determined to be a true positive, but you do not necessarily want to resolve it.
  • TRUE_POSITIVE_REJECT: The result is determined to be a true positive and you want to resolve it. “Reject” infers you want to reject the activity.
  • UNKNOWN: The result is determined to be unknown, but you do not necessarily want to resolve it.
  • UNKNOWN_ACCEPT: The result is determined to be unknown and you want to resolve it. “Accept” infers you want to accept the activity.
  • UNKNOWN_REJECT: The result is determined to be unknown and you want to resolve it. “Reject” infers you want to reject the activity.
commentobjectOptional

Response

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

Errors