---
title: "Turn on/off monitoring for a given entity"
method: PATCH
path: "/v2/individuals/{entityId}/monitor"
tags: ["Monitoring"]
---

# Turn on/off monitoring for a given entity

`PATCH /v2/individuals/{entityId}/monitor`

Toggle monitoring on or off for for a given entity e.g. AML monitoring. Use this endpoint to either:
- Enable monitoring - System will start monitoring the entity for potential changes.
- Disable monitoring - System will no longer monitor the entity for new potential matches and will no longer send alerts.

The endpoint will effectively manage the monitoring status of the entity.
Having monitoring status of a type enabled means that the entity is being monitored for that type.
If the entity has several services under the entity, the endpoint will manage the subscription status of the entity for each service for the types requested.
Request:
The request object contains the `entityId` and list of `monitoring` that are about to toggle.
Also, the request body contains comment to be added to audit logs
Response:
The response object contains the `requestId` and the `subscriptions` that associated with the entity.
The subscriptions object contains the type of monitoring and the details of the subscriptions.
The details of the subscriptions includes:
  - service name
  - service profile ID
  - status of the subscription
  - the workflows that will be executed by the type for the service profile.

## Query parameters

- `enabled` boolean, required
- `monitoringTypes` MonitoringType[]

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string

## Request body

- object
  - `comment` Comment
    - `commentId` string — Unique identifier for the comment.
    - `text` string — The text content of the comment.

## Response `200`

OK

- EntityPatchMonitoringResponse
  - `requestId` string — The unique request identifier for the API call made.
  - `monitoring` EntityPatchMonitoringSubscriptionsResponse
    - `AML` EntityPatchMonitoringSubscriptionsAmlResponse — The subscription details for AML monitoring
      - `subscriptions` EntityPatchMonitoringSubscriptionsDetailsResponse[] — The list of AML monitoring subscriptions
        - `serviceName` string — The name of service associated the service profile
        - `serviceProfileId` string — The ID of the service profile
        - `status` 'ENABLED' | 'DISABLED' — Indicates the current status of the subscription. - `ENABLED`: The subscription is active and operational. - `DISABLED`: The subscription is inactive and not operational.
        - `enabledAt` string, date-time — The date and time when the subscription was last enabled
        - `enabledRequestId` string — The request id when the subscription was last enabled
        - `enabledBy` string — The username of last user who enabled the subscription
        - `disabledAt` string, date-time — The date and time when the subscription was last disabled
        - `disabledRequestId` string — The request id when the subscription was last disabled
        - `disabledBy` string — The username of last user who disabled the subscription
        - `workflows` object[] — The workflows that will be executed by the type for the service profile
          - `workflowName` string — Name of the workflow.
          - `workflowId` string — Unique ID of the workflow.
          - `lifecyclePhase` 'ONBOARDING' | 'MONITORING' | 'OTHER' — Specifies the lifecycle phase of the customer in which this workflow is executed: - ONBOARDING: Workflow is in the onboarding stage. - MONITORING: Workflow is in the monitoring stage. - OTHER: Workflow is in another stage.
      - `providers` string[] — The providers that will be affected by the subscription
      - `status` 'ENABLED' | 'DISABLED' — Indicates the current status of the subscription. - `ENABLED`: The subscription is active and operational. - `DISABLED`: The subscription is inactive and not operational.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)