Skip to main content
PATCH
/
v2
/
individuals
/
{entityId}
/
serviceprofiles
/
{serviceName}
/
workflows
/
{workflowName}
/
executions
/
{workflowExecutionId}
Override the status of a specific workflow execution.
curl --request PATCH \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId} \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "status": "UNCHECKED",
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "workflowResult": {
    "schemaVersion": 123,
    "workflowName": "<string>",
    "workflowExecutionId": "<string>",
    "workflowExecutionState": "COMPLETED",
    "startedAt": "2023-11-07T05:31:56Z",
    "workflowId": "<string>",
    "requestId": "<string>",
    "entityId": "<string>",
    "entityType": "INDIVIDUAL",
    "serviceProfileId": "<string>",
    "result": "UNCHECKED",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "UNCHECKED",
    "statusOverrideAt": "2023-11-07T05:31:56Z",
    "statusOverrideRequestId": "<string>",
    "statusOverrideBy": "<string>",
    "riskAssessment": {
      "serviceProfileId": "<string>",
      "workflowId": "<string>",
      "workflowExecutionId": "<string>",
      "entityId": "<string>",
      "riskAssessmentId": "<string>",
      "schemaVersion": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "updatedRequestId": "<string>",
      "workflowRiskScore": 123,
      "workflowRiskLevel": "UNKNOWN",
      "riskScore": 123,
      "riskLevel": "UNKNOWN",
      "isOutdated": false,
      "riskFactors": [
        {
          "riskFactorId": "<string>",
          "factor": "<string>",
          "value": "<string>",
          "score": 123,
          "description": "<string>",
          "workflowExecutionId": "<string>",
          "stepResultId": "<string>",
          "manualOverrideScore": 123,
          "status": "VALID",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedBy": "<string>",
          "updatedRequestId": "<string>",
          "createdServiceProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdWorkflowExecutionId": "<string>",
          "createdStepResultId": "<string>"
        }
      ]
    },
    "isManual": true,
    "steps": {
      "order": [
        "<string>"
      ],
      "passed": [
        "<string>"
      ],
      "failed": [
        "<string>"
      ],
      "incomplete": [
        "<string>"
      ],
      "notApplicable": [
        "<string>"
      ]
    },
    "endedAt": "2023-11-07T05:31:56Z",
    "issues": [
      {
        "category": "AML",
        "issue": "AML_ISSUE",
        "severity": "INFO",
        "issueId": "<string>",
        "workflowExecutionId": "<string>",
        "stepResultId": "<string>",
        "isCleared": true,
        "createdBy": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>",
        "updatedRequestId": "<string>"
      }
    ],
    "lifecyclePhase": "OTHER",
    "monitoringTypes": [
      "AML"
    ],
    "endWorkflowId": "<string>",
    "endWorkflowName": "<string>",
    "workflowStepResults": [
      {
        "stepResultId": "<string>",
        "workflowExecutionId": "<string>",
        "stepName": "<string>",
        "requestId": "<string>",
        "objectType": "NAME",
        "objectId": "<string>",
        "schemaVersion": 123,
        "startedAt": "2023-11-07T05:31:56Z",
        "endedAt": "2023-11-07T05:31:56Z",
        "serviceProviders": [
          {
            "provider": "<string>",
            "result": "<string>",
            "order": 123,
            "startedAt": "2023-11-07T05:31:56Z",
            "endedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "result": "UNCHECKED",
        "errors": [
          {
            "code": "<string>",
            "description": "<string>",
            "location": "<string>"
          }
        ],
        "summary": {
          "stepName": "<string>",
          "matchedRules": [
            {
              "ruleName": "default",
              "ruleOrder": 1,
              "ruleMatches": [
                {
                  "matchTypes": {},
                  "matchCount": 2,
                  "matchCountRequired": 1,
                  "hasAllRequiredSourcesMatched": true,
                  "requiredSourcesMatched": [
                    "<string>"
                  ],
                  "requiredSourcesNotMatched": [
                    "<string>"
                  ],
                  "isVerified": false,
                  "matchDetails": [
                    {
                      "provider": "<string>",
                      "source": "<string>",
                      "attributesMatched": [
                        "<string>"
                      ]
                    }
                  ],
                  "nonMatchDetails": [
                    {
                      "provider": "<string>",
                      "source": "<string>",
                      "attributesMatched": [
                        "<string>"
                      ]
                    }
                  ]
                }
              ]
            }
          ],
          "unmatchedRules": [
            {
              "ruleName": "default",
              "ruleOrder": 1,
              "ruleMatches": [
                {
                  "matchTypes": {},
                  "matchCount": 2,
                  "matchCountRequired": 1,
                  "hasAllRequiredSourcesMatched": true,
                  "requiredSourcesMatched": [
                    "<string>"
                  ],
                  "requiredSourcesNotMatched": [
                    "<string>"
                  ],
                  "isVerified": false,
                  "matchDetails": [
                    {
                      "provider": "<string>",
                      "source": "<string>",
                      "attributesMatched": [
                        "<string>"
                      ]
                    }
                  ],
                  "nonMatchDetails": [
                    {
                      "provider": "<string>",
                      "source": "<string>",
                      "attributesMatched": [
                        "<string>"
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        },
        "risk": {
          "level": "<string>",
          "contributedScore": 123,
          "overallScore": 123,
          "factors": [
            {
              "factor": "<string>",
              "score": 123,
              "value": "<string>",
              "aggregationMethod": "<string>",
              "matchedRule": "<string>",
              "source": "<string>",
              "inputsConsidered": [
                {
                  "value": "<string>",
                  "score": 123
                }
              ]
            }
          ]
        },
        "notes": {},
        "processResults": [
          {
            "processResultId": "<string>",
            "schemaVersion": 123,
            "entityId": "<string>",
            "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
            "stepName": "<string>",
            "stepType": "<string>",
            "objectType": "<string>",
            "objectId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "groupId": "<string>",
            "providerResult": {
              "name": "<string>",
              "source": "<string>",
              "sourceNormalized": "<string>",
              "reference": "<string>",
              "fuzziness": {
                "normalized": 50,
                "actual": "<string>"
              },
              "confidence": {
                "normalized": 50,
                "actual": "<string>"
              },
              "riskScore": 123,
              "errorCode": "<string>",
              "errorMessage": "<string>"
            },
            "result": "MATCH",
            "class": "KYC",
            "supplementaryData": {
              "type": "AML",
              "serviceProvider": "<string>",
              "searchId": "<string>",
              "caseId": "<string>",
              "referenceId": "<string>",
              "originalStepSearchLevel": "<string>",
              "groupingId": "<string>",
              "reportUrl": "<string>",
              "fuzziness": {
                "normalized": 50,
                "actual": "<string>"
              },
              "matchData": {
                "spReferenceId": "<string>",
                "name": "<string>",
                "strength": 123,
                "givenName": "<string>",
                "otherName": "<string>",
                "familyName": "<string>",
                "date": "<string>",
                "address": "<string>",
                "countries": [
                  {
                    "code": "<string>",
                    "matchType": "<string>"
                  }
                ],
                "nationalId": {
                  "idNumber": "<string>",
                  "idType": "<string>",
                  "idExpiry": "<string>",
                  "issuingCountryCode": "<string>",
                  "documentId": "<string>"
                },
                "imageUrl": "<string>",
                "isDeceased": true,
                "isAlias": true,
                "isRelated": true,
                "gender": "MALE"
              },
              "aliases": [
                "<string>"
              ],
              "relatedParties": [
                {
                  "name": "<string>",
                  "relationship": "<string>"
                }
              ],
              "referenceDocs": [
                {
                  "url": "<string>",
                  "description": "<string>"
                }
              ],
              "notes": {},
              "pepData": [
                {
                  "countryCode": "<string>",
                  "countryName": "<string>",
                  "sourceName": "<string>",
                  "level": "<string>",
                  "sourceUrl": "<string>",
                  "sourcePosition": "<string>",
                  "position": "<string>",
                  "positionDescription": "<string>",
                  "status": "<string>",
                  "listingStart": "<string>",
                  "listingEnd": "<string>",
                  "imageUrl": "<string>",
                  "referenceDocs": [
                    {
                      "url": "<string>",
                      "description": "<string>"
                    }
                  ],
                  "additionalData": [
                    {
                      "key": "<string>",
                      "value": "<string>"
                    }
                  ]
                }
              ],
              "sanctionData": [
                {
                  "countryCode": "<string>",
                  "countryName": "<string>",
                  "sourceName": "<string>",
                  "sourceUrl": "<string>",
                  "sourceReason": "<string>",
                  "listingStart": "<string>",
                  "listingEnd": "<string>",
                  "imageUrl": "<string>",
                  "referenceDocs": [
                    {
                      "url": "<string>",
                      "description": "<string>"
                    }
                  ],
                  "additionalData": [
                    {
                      "key": "<string>",
                      "value": "<string>"
                    }
                  ]
                }
              ],
              "watchlistData": [
                {
                  "countryCode": "<string>",
                  "countryName": "<string>",
                  "sourceName": "<string>",
                  "sourceUrl": "<string>",
                  "sourceReason": "<string>",
                  "listingStart": "<string>",
                  "listingEnd": "<string>",
                  "imageUrl": "<string>",
                  "referenceDocs": [
                    {
                      "url": "<string>",
                      "description": "<string>"
                    }
                  ],
                  "additionalData": [
                    {
                      "key": "<string>",
                      "value": "<string>"
                    }
                  ]
                }
              ],
              "mediaData": [
                {
                  "title": "<string>",
                  "source": "<string>",
                  "snippet": "<string>",
                  "sourceDate": "<string>",
                  "sourceCountry": "<string>",
                  "url": "<string>",
                  "isCurrent": true
                }
              ]
            },
            "errors": [
              {
                "code": "<string>",
                "description": "<string>",
                "location": "<string>"
              }
            ],
            "notes": {},
            "systemStatus": "VALID",
            "state": "IN_PROGRESS",
            "riskFactors": [
              {
                "factor": "<string>",
                "value": "<string>"
              }
            ],
            "updatedBy": "<string>"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>"
      }
    ],
    "errors": [
      {
        "code": "<string>",
        "description": "<string>",
        "location": "<string>"
      }
    ],
    "notes": {},
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>"
  }
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"[email protected]"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

​
serviceName
string
required

The unique name of the service profile

​
workflowName
string
required

The unique name of the workflow

​
workflowExecutionId
string
required

Unique workflow execution identifier

Query Parameters

​
level
enum<string>
default:meta

Determines what level of detail to return in the response

  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and images as base64
Available options:
meta,
base64

Body

application/json
​
status
enum<string>
default:UNCHECKED

Outcome of this workflow execution. Possible results:

  • UNCHECKED: The workflow has not yet been run and has no result.
  • IN_PROGRESS: The workflow is currently running and awaiting completion.
  • REVIEW: The workflow produced results that require review. Check the risks and step results for more details.
  • PASS: The workflow successfully completed with a PASS recommendation.
  • FAIL: The workflow finished with a FAIL recommendation.
  • COMPLETE: The workflow has finished and the results are considered complete. PASS/FAIL is not required.
  • INCOMPLETE: The workflow has finished and the results are considered incomplete. PASS/FAIL is not required.
  • NEEDS_APPROVAL: The workflow requires an approval process. Once approved, re-run the workflow.
  • APPROVED: The workflow was approved, typically by an external source such as a human.
  • REJECTED: The workflow was rejected, typically by an external source such as a human.
  • BLOCKED: The workflow was blocked from completing. Manual review is required.
  • CLEAR: The workflow completed with no issues raised. Often used for ongoing monitoring workflows.
  • URGENT: The workflow completed with matters requiring urgent review. Often used for ongoing monitoring workflows that return sanctions or similarly critical items.
  • MONITOR: The workflow completed and further monitoring is required. Should be manually reviewed.
Available options:
UNCHECKED,
IN_PROGRESS,
REVIEW,
PASS,
FAIL,
COMPLETE,
INCOMPLETE,
NEEDS_APPROVAL,
APPROVED,
REJECTED,
BLOCKED,
CLEAR,
URGENT,
MONITOR
​
comment
object

Response

Status has been updated

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
workflowResult
object

Summary of the workflow execution.

Using and interpreting the status field

The result of the workflow is represented in the status field. Users can manually override this status with a different value to change the outcome of the workflow. When the status field is overridden, the statusOverrideRequestId field is populated with the request ID of the override request. If the statusOverrideRequestId field is present and non-empty, it indicates that the status has been manually changed.

  1. Initial State:
    • When a workflow completes, its result is set in the status field.
  2. Status Override:
    • Users may override the status field with a different value (e.g., change FAIL to PASS).
  3. Identifying Overrides:
    • To determine if a status has been overridden, check for the presence of the statusOverrideRequestId field.
    • If present, it indicates that the status has been manually changed.
  4. Additional Override Information:
    • statusOverrideBy: Identifies the user who performed the override (may not always be present).
    • statusOverrideAt: Timestamp of when the override occurred.
  5. Interpretation:
    • If statusOverrideRequestId is empty or absent, no override has occurred.
    • If statusOverrideRequestId is present, then a manual override has occurred.