Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt

Use this file to discover all available pages before exploring further.

The subscribe/unsubscribe API endpoint allows an entity to be added/removed from a watchlist. Once an entity is added to the watchlist any changes to the entity will result in a notification either by an email or webhook as configured.
Configuring webhookPlease see Notifications - Webhooks for more information.
These notifications can be received via webhook
Call Outs
  • The entities can only be unsubscribed from the watchlist via APIs
  • When the entity is archived or deleted, it will be automatically unsubscribed

​
New endpoint

/business/{entityId}/subscription

​
Request

cURL

curl --request POST \
     --url 'https://api.demo.frankiefinancial.io/compliance/v1.2/business/{{entityID}}/subscription?set=true' \
     --header 'Accept: application/json' \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'

​
Response

json

{
  "currentlySubscribed": true,
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}

​
Subscribing Existing entities

This will need to be a manual process that one of our friendly Techops or Customer success representatives can assist you with.
Auto Subscribe Entities on Creation
Entities can be auto subscribed to monitoring on creation if we have the correct configuration set up against the Customer ID.If this configuration is enabled, entities created will automatically be added to the watchlist once the entity has either passed the required checks or has been manually approved through the portal.You can further manage these entities using this endpoint if the need to change the watchlist status arises.