Skip to main content
PATCH
/
v2
/
individuals
/
{entityId}
/
monitor
Turn on/off monitoring for a given entity
curl --request PATCH \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/monitor \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "monitoring": {
    "AML": {
      "subscriptions": [
        {
          "serviceName": "<string>",
          "serviceProfileId": "<string>",
          "status": "ENABLED",
          "enabledAt": "2023-11-07T05:31:56Z",
          "enabledRequestId": "<string>",
          "enabledBy": "<string>",
          "disabledAt": "2023-11-07T05:31:56Z",
          "disabledRequestId": "<string>",
          "disabledBy": "<string>",
          "workflows": [
            {
              "workflowName": "<string>",
              "workflowId": "<string>",
              "lifecyclePhase": "OTHER"
            }
          ]
        }
      ],
      "providers": [
        "<string>"
      ],
      "status": "ENABLED"
    }
  }
}

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.

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Query Parameters

​
enabled
boolean
required

Enable or disable monitoring for the given entity. Set to true to turn monitoring on or set to false to turn monitoring off.

​
monitoringTypes
enum<string>[]

The type of ongoing monitoring to be enabled/disable for the given entity. Exclude this parameter to set the monitoring status for all types.

The type of workflow subscription. This determines which types are subscribing to a workflow.

Available options:
AML,
ACTIVITY

Body

application/json
​
comment
object

Response

OK

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
monitoring
object