Toggle monitoring on or off for for a given entity e.g. AML monitoring. Use this endpoint to either:
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:
Unique FrankieOne identifier for an entity
Your Customer ID provided by FrankieOne
Your Customer Child ID provided by FrankieOne
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.
Enable or disable monitoring for the given entity. Set to true to turn monitoring on or set to false to turn monitoring off.
The type of ongoing monitoring to be enabled/disable for the given entity. Exclude this parameter to set the monitoring status for all types.
OK
The unique request ID for the API call made.