Turn on/off monitoring for a given entity

PATCH

Toggle monitoring on or off for for a given entity e.g. AML monitoring. Use this endpoint to either: - Enable monitoring - FrankieOne will start monitoring the entity for potential changes, generally sending alerts within 24 hours of an update. - Disable monitoring - FrankieOne will no longer monitor the entity for new potential matches and will no longer send alerts.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

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.

Query parameters

enabledbooleanRequired

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

monitoringTypesstringOptional

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

Request

This endpoint expects an object.
commentobjectOptional

Response

OK

requestIdstringOptional

The unique request ID for the API call made.

monitoringlist of objectsOptional
subscriptionslist of objectsOptional
Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process.
Built with