Sign in
latestOpenAPI 3.0.32026-07-2141248520.9 KB

880b27506cbb

Individual Results

Update the status of AML process results

Update the status of a set of AML process results.

patch/v2/individuals/{entityId}/results/aml

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Request body

processResultsstring[]
manualStatus'TRUE_POSITIVE' | 'FALSE_POSITIVE' | 'TRUE_POSITIVE_ACCEPT' | 'TRUE_POSITIVE_REJECT' | 'UNKNOWN' | 'UNKNOWN_ACCEPT' | 'UNKNOWN_REJECT'

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.
  • FALSE_POSITIVE_ACCEPT: The result is determined to be a false 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.

Example request

{
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

requestIdstring

The unique request identifier for the API call made.

processResultsProcessResultObject[] — unresolved $ref