Sign in
latestOpenAPI 3.0.32026-07-2141248520.9 KB

880b27506cbb

Individual Results

Update the status of Duplicate process results

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

  • processResults: Array of UUID strings identifying specific duplicate Process Results to update - manualStatus: The resolution status for the duplicates, which can be one of:
    • FALSE_POSITIVE: When the flagged entities are determined to be different individuals (both records should be kept)
    • TRUE_POSITIVE_ACCEPT: Keep the current entity as primary and mark the result entity as duplicate (use when current record is more complete/accurate)
    • TRUE_POSITIVE_REJECT: Keep the result entity as primary and mark the current entity as duplicate (use when duplicate record is more complete/accurate)
  • comment: Optional documentation for the decision rationale, useful for audit trails and team communication
patch/v2/individuals/{entityId}/results/duplicate

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[]

The process result IDs to update. These are the PROs created when a duplicate has been found.

manualStatus'FALSE_POSITIVE' | 'TRUE_POSITIVE_ACCEPT' | 'TRUE_POSITIVE_REJECT'

Manual review status options for duplicate entity resolution. Used to indicate the outcome of a manual duplicate check between an existing entity (A) and an incoming entity (B):

  • FALSE_POSITIVE: Entities are not duplicates. Both Entity A and Entity B are distinct and should be retained as separate records.
  • TRUE_POSITIVE_ACCEPT: Entities are duplicates. Keep the incoming entity (Entity B) as the primary record and mark the existing entity (Entity A) as the duplicate. Use when the incoming record is more accurate or complete.
  • TRUE_POSITIVE_REJECT: Entities are duplicates. Keep the existing entity (Entity A) as the primary record and mark the incoming entity (Entity B) as the duplicate. Use when the existing record is more trusted or complete.

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