Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either:
Enable monitoring - System will start monitoring the organization for potential changes.
Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts.
The endpoint will effectively manage the monitoring status of the organization.
Having monitoring status of a type enabled means that the organization is being monitored for that type.
If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization.
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.
Continuous KYB AU:
CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes.
It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403.
The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.
PATCH
/
v2
/
organizations
/
{entityId}
/
monitor
Turn on/off monitoring for a given organization
curl --request PATCH \ --url https://api.uat.frankie.one/v2/organizations/{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" }}'
import requests
url = "https://api.uat.frankie.one/v2/organizations/{entityId}/monitor"
payload = { "comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
} }
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)
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.
The type of ongoing monitoring to be enabled/disabled for the given organization. Exclude this parameter to set the monitoring status for all types.
Specifies the type of service profile subscription for an organisation. Contains every Subscription-Type value plus the subscription types that apply to organisations only.
AML: Anti-money laundering monitoring.
ACTIVITY: Activity monitoring.
CONTINUOUS_KYB_AU: Continuous KYB for Australian organisations (CreditorWatch notifications, including credit score changes). Requires the customer to have Continuous KYB enabled.
{"docsConfig":{"theme":"mint","$schema":"https://www.mintlify.com/docs.json","name":"frankieone","colors":{"primary":"#1A6CFF","light":"#1A6CFF","dark":"#1A6CFF"},"logo":{"light":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33","dark":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/dark.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=196c598869b49c924efc8e44399fda09","href":"https://docs.frankieone.com"},"favicon":"https://mintcdn.com/frankieone-f5583b1b/cNmgsKD2V0ccWp6T/favicon.png?fit=max\u0026auto=format\u0026n=cNmgsKD2V0ccWp6T\u0026q=85\u0026s=82de5d057bc772d870f18df413b453f9","appearance":{"default":"system","strict":true},"background":{"color":{"light":"#f4f5fc","dark":"#10152e"}},"navbar":{"links":[{"href":"https://status.frankieone.com/","label":"Support"}],"primary":{"type":"button","label":"Book a Demo","href":"https://frankieone.com/book-a-demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/frankieone"}},"seo":{"metatags":{"canonical":"https://docs.frankieone.com","og:url":"https://docs.frankieone.com"}},"fonts":{"heading":{"family":"DM Sans","weight":800,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"},"body":{"family":"DM Sans","source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-TQB66YCL53"}},"errors":{"404":{"redirect":true,"title":"Sorry, we couldn't find the page you're looking for.","description":"Please try searching for a different term, use the navigation bar, or return to the homepage."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"frankieone-f5583b1b","hasAudioNarration":false,"actualSubdomain":"frankieone-f5583b1b","customDomains":["docs.frankieone.com"],"gitSource":{"type":"github","owner":"frankieone","repo":"config-api-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae14a8e30e15bc50808db7b","collectionId":"0897024a-8f9e-44d9-9ec4-b6531319ac14","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae14a8e30e15bc50808db7b"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae14a8e30e15bc50808db7b","clientVersion":"0.0.4005","searchFilterCounts":[{"language":"default","tag":"API","count":236},{"language":"default","tag":"Portal","count":188},{"language":"default","tag":"OneSDK","count":137},{"language":"default","tag":"KYC","count":131},{"language":"default","tag":"KYB","count":68},{"language":"default","tag":"KYC API Endpoints","count":50},{"language":"default","tag":"KYC V2 API","count":45},{"language":"default","tag":"About OneSDK","count":40},{"language":"default","tag":"Guide to the API","count":38},{"language":"default","tag":"Introduction","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@frankieone.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":":root{color-scheme:light dark}[data-theme=dark]{color-scheme:dark}[data-theme=light]{color-scheme:light}span[data-as=p]:not(:where([data-page=\"/\"])){color:light-dark(#000,#fff)!important}p,tr,ul{color:light-dark(#000,#fff)!important}code{color:#1a6cff!important}"}],"page":{"pagePath":"api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization","slug":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization","pageMetadata":{"title":"Turn on/off monitoring for a given organization","description":"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either:\n- Enable monitoring - System will start monitoring the organization for potential changes.\n- Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts.\n\nThe endpoint will effectively manage the monitoring status of the organization.\nHaving monitoring status of a type enabled means that the organization is being monitored for that type.\nIf the organization has several services under the entity, the endpoint will manage the subscription status of the organization for each service for the types requested.\nRequest:\nThe request object contains the `entityId` and list of `monitoring` that are about to toggle.\nAlso, the request body contains comment to be added to audit logs\nResponse:\nThe response object contains the `requestId` and the `subscriptions` that associated with the organization.\nThe subscriptions object contains the type of monitoring and the details of the subscriptions.\nThe details of the subscriptions includes:\n - service name\n - service profile ID\n - status of the subscription\n - the workflows that will be executed by the type for the service profile.\n\nContinuous KYB AU:\n`CONTINUOUS_KYB_AU` monitors Australian organisations through CreditorWatch notifications, including credit score changes.\nIt requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes `CONTINUOUS_KYB_AU` returns 403 with error code `VAL-403`.\nThe `CONTINUOUS_KYB_AU` block in the response is only present when the customer has Continuous KYB enabled and the request included `CONTINUOUS_KYB_AU`.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/monitor","href":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Enable monitoring - System will start monitoring the organization for potential changes.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The endpoint will effectively manage the monitoring status of the organization.\\nHaving monitoring status of a type enabled means that the organization is being monitored for that type.\\nIf the organization has several services under the entity, the endpoint will manage the subscription status of the organization for each service for the types requested.\\nRequest:\\nThe request object contains the \", _jsx(_components.code, {\n children: \"entityId\"\n }), \" and list of \", _jsx(_components.code, {\n children: \"monitoring\"\n }), \" that are about to toggle.\\nAlso, the request body contains comment to be added to audit logs\\nResponse:\\nThe response object contains the \", _jsx(_components.code, {\n children: \"requestId\"\n }), \" and the \", _jsx(_components.code, {\n children: \"subscriptions\"\n }), \" that associated with the organization.\\nThe subscriptions object contains the type of monitoring and the details of the subscriptions.\\nThe details of the subscriptions includes:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"service name\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"service profile ID\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"status of the subscription\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"the workflows that will be executed by the type for the service profile.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Continuous KYB AU:\\n\", _jsx(_components.code, {\n children: \"CONTINUOUS_KYB_AU\"\n }), \" monitors Australian organisations through CreditorWatch notifications, including credit score changes.\\nIt requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes \", _jsx(_components.code, {\n children: \"CONTINUOUS_KYB_AU\"\n }), \" returns 403 with error code \", _jsx(_components.code, {\n children: \"VAL-403\"\n }), \".\\nThe \", _jsx(_components.code, {\n children: \"CONTINUOUS_KYB_AU\"\n }), \" block in the response is only present when the customer has Continuous KYB enabled and the request included \", _jsx(_components.code, {\n children: \"CONTINUOUS_KYB_AU\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Turn on/off monitoring for a given organization","description":"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either:\n- Enable monitoring - System will start monitoring the organization for potential changes.\n- Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts.\n\nThe endpoint will effectively manage the monitoring status of the organization.\nHaving monitoring status of a type enabled means that the organization is being monitored for that type.\nIf the organization has several services under the entity, the endpoint will manage the subscription status of the organization for each service for the types requested.\nRequest:\nThe request object contains the `entityId` and list of `monitoring` that are about to toggle.\nAlso, the request body contains comment to be added to audit logs\nResponse:\nThe response object contains the `requestId` and the `subscriptions` that associated with the organization.\nThe subscriptions object contains the type of monitoring and the details of the subscriptions.\nThe details of the subscriptions includes:\n - service name\n - service profile ID\n - status of the subscription\n - the workflows that will be executed by the type for the service profile.\n\nContinuous KYB AU:\n`CONTINUOUS_KYB_AU` monitors Australian organisations through CreditorWatch notifications, including credit score changes.\nIt requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes `CONTINUOUS_KYB_AU` returns 403 with error code `VAL-403`.\nThe `CONTINUOUS_KYB_AU` block in the response is only present when the customer has Continuous KYB enabled and the request included `CONTINUOUS_KYB_AU`.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/monitor","href":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Turn on/off monitoring for a given organization","responses":{"200":"a1aa205f-3c80-4fe2-8dfe-0c7752ea699a","400":"a054ad27-9fff-40b5-b5f9-77ccf3e75cb6","401":"4613b87f-afc0-4c9f-b459-9936f16560a3","403":"141326bd-9e49-49ac-88d7-69c3a1bdcbf4","404":"0954a2d0-8e1d-4d80-852a-e8b1d7501580","500":"97a9b98c-5fb6-4ceb-a08d-59d8d3e98ffd","502":"486e7bd9-6d4f-491b-957c-9560ef03888e","503":"97525735-cea5-49cb-b53d-456a59f73bed"},"requestBody":"e439dfdc-1eb0-4331-b31a-8ac6ab56d249","operationId":"patchOrganizationMonitoring","description":"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either:\n- Enable monitoring - System will start monitoring the organization for potential changes.\n- Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts.\n\nThe endpoint will effectively manage the monitoring status of the organization.\nHaving monitoring status of a type enabled means that the organization is being monitored for that type.\nIf the organization has several services under the entity, the endpoint will manage the subscription status of the organization for each service for the types requested.\nRequest:\nThe request object contains the `entityId` and list of `monitoring` that are about to toggle.\nAlso, the request body contains comment to be added to audit logs\nResponse:\nThe response object contains the `requestId` and the `subscriptions` that associated with the organization.\nThe subscriptions object contains the type of monitoring and the details of the subscriptions.\nThe details of the subscriptions includes:\n - service name\n - service profile ID\n - status of the subscription\n - the workflows that will be executed by the type for the service profile.\n\nContinuous KYB AU:\n`CONTINUOUS_KYB_AU` monitors Australian organisations through CreditorWatch notifications, including credit score changes.\nIt requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes `CONTINUOUS_KYB_AU` returns 403 with error code `VAL-403`.\nThe `CONTINUOUS_KYB_AU` block in the response is only present when the customer has Continuous KYB enabled and the request included `CONTINUOUS_KYB_AU`.","parameters":["4cb7b08b-b899-4496-900e-c4abec0ea288","9463ef8d-0c66-45ce-b48c-35770ab49d7b","cbea9f0e-8aec-46bd-b0df-42d76e27e460","c4800fcb-2038-4436-842f-8b534f1b0bb6","9c012c93-a895-4a6d-8b8a-63e8b82c84fe","75ba9e48-5a4a-4ca7-af02-fead6742cf7d"],"tags":["Organization Monitoring"],"security":["640031ed-1249-4a29-b7cf-4c28095d43c8","cab90247-1217-414d-8700-04802b1e2f76"],"method":"patch","type":"path","servers":["6734e950-f09c-4b6e-9778-94aa10d78805","a1a8c4fb-5482-49a1-954f-d93fec6f9ad8"],"path":"/v2/organizations/{entityId}/monitor","baseUrlOptions":["https://api.uat.frankie.one","https://api.frankie.one"],"title":"Turn on/off monitoring for a given organization","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4cb7b08b-b899-4496-900e-c4abec0ea288":{"name":"api_key","in":"header","schema":{"type":"string","example":"245c765b124a098d09ef8765....","isRequired":true,"description":"Your API key provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your API key provided by FrankieOne","required":true},"9463ef8d-0c66-45ce-b48c-35770ab49d7b":{"name":"X-Frankie-CustomerID","in":"header","required":true,"schema":{"type":"string","example":"12345678-1234-1234-1234-123456789012","isRequired":true,"description":"Your Customer ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer ID provided by FrankieOne"},"cbea9f0e-8aec-46bd-b0df-42d76e27e460":{"name":"X-Frankie-CustomerChildID","in":"header","required":false,"schema":{"type":"string","example":"87654321-4321-4321-4321-210987654321","isRequired":false,"description":"Your Customer Child ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer Child ID provided by FrankieOne"},"c4800fcb-2038-4436-842f-8b534f1b0bb6":{"name":"X-Frankie-Channel","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"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.","uniqueKey":"","typeLabel":"string"},"description":"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."},"9c012c93-a895-4a6d-8b8a-63e8b82c84fe":{"in":"query","name":"enabled","schema":{"type":"boolean","isRequired":true,"description":"Enable or disable monitoring for the given organization. Set to true to turn monitoring on or set to false to turn monitoring off.","uniqueKey":"","typeLabel":"boolean"},"description":"Enable or disable monitoring for the given organization. Set to true to turn monitoring on or set to false to turn monitoring off.","required":true},"75ba9e48-5a4a-4ca7-af02-fead6742cf7d":{"in":"query","name":"monitoringTypes","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","description":"Specifies the type of service profile subscription for an organisation. Contains every `Subscription-Type` value plus the subscription types that apply to organisations only.\n\n- `AML`: Anti-money laundering monitoring.\n- `ACTIVITY`: Activity monitoring.\n- `CONTINUOUS_KYB_AU`: Continuous KYB for Australian organisations (CreditorWatch notifications, including credit score changes). Requires the customer to have Continuous KYB enabled.","enum":["AML","ACTIVITY","CONTINUOUS_KYB_AU"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The type of ongoing monitoring to be enabled/disabled for the given organization. Exclude this parameter to set the monitoring status for all types.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"The type of ongoing monitoring to be enabled/disabled for the given organization. Exclude this parameter to set the monitoring status for all types."},"9511517d-b031-45fa-acf0-a20ec641ed8a":{"name":"entityId","in":"path","schema":{"type":"string","isRequired":true,"description":"Unique FrankieOne identifier for an entity","uniqueKey":"","typeLabel":"string"},"description":"Unique FrankieOne identifier for an entity","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the comment.","example":"Update after speaking to customer over the phone directly.","uniqueKey":"comment.text","typeLabel":"string"},"entityId":{"type":"string","description":"Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.\nTo modify an entity, set the entityId of the entity you wish to update in an update request.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","uniqueKey":"comment.entityId","typeLabel":"string"},"entityType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","UNKNOWN"],"description":"The type of entity within Frankie. This can be \"INDIVIDUAL\", \"ORGANIZATION\", or \"UNKNOWN\".","uniqueKey":"comment.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"comment","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"comment":{"text":"Update after speaking to customer over the phone directly.","entityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a1aa205f-3c80-4fe2-8dfe-0c7752ea699a":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"},"monitoring":{"type":"object","properties":{"AML":{"type":"object","description":"The subscription details for AML monitoring","properties":{"subscriptions":{"type":"array","description":"The list of AML monitoring subscriptions","items":{"type":"object","description":"The subscription details for monitoring, this object is returned per monitoring type","properties":{"serviceName":{"type":"string","description":"The name of service associated the service profile","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].serviceName","typeLabel":"string"},"serviceProfileId":{"type":"string","description":"The ID of the service profile","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].serviceProfileId","typeLabel":"string"},"status":{"type":"string","description":"Indicates the current status of the subscription.\n\n - `ENABLED`: The subscription is active and operational.\n - `DISABLED`: The subscription is inactive and not operational.","enum":["ENABLED","DISABLED"],"uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"enabledAt":{"type":"string","format":"date-time","description":"The date and time when the subscription was last enabled","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].enabledAt","typeLabel":"string\u003cdate-time>"},"enabledRequestId":{"type":"string","description":"The request id when the subscription was last enabled","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].enabledRequestId","typeLabel":"string"},"enabledBy":{"type":"string","description":"The username of last user who enabled the subscription","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].enabledBy","typeLabel":"string"},"disabledAt":{"type":"string","format":"date-time","description":"The date and time when the subscription was last disabled","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].disabledAt","typeLabel":"string\u003cdate-time>"},"disabledRequestId":{"type":"string","description":"The request id when the subscription was last disabled","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].disabledRequestId","typeLabel":"string"},"disabledBy":{"type":"string","description":"The username of last user who disabled the subscription","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].disabledBy","typeLabel":"string"},"workflows":{"type":"array","description":"The workflows that will be executed by the type for the service profile","items":{"type":"object","properties":{"workflowName":{"type":"string","description":"Name of the workflow.","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].workflows.items.[INDEX].workflowName","typeLabel":"string"},"workflowId":{"type":"string","description":"Unique ID of the workflow.","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].workflows.items.[INDEX].workflowId","typeLabel":"string"},"lifecyclePhase":{"type":"string","description":"Specifies the lifecycle phase of the customer in which this workflow is executed:\n - ONBOARDING: Workflow is in the onboarding stage.\n - MONITORING: Workflow is in the monitoring stage.\n - REFRESH: Workflow is in the refresh stage.\n - OTHER: Workflow is in another stage.\n","enum":["ONBOARDING","MONITORING","REFRESH","OTHER"],"default":"OTHER","uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].workflows.items.[INDEX].lifecyclePhase","typeLabel":"enum\u003cstring>"}},"uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].workflows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"monitoring.AML.subscriptions.items.[INDEX].workflows","typeLabel":"object[]"}},"uniqueKey":"monitoring.AML.subscriptions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"monitoring.AML.subscriptions","typeLabel":"object[]"},"providers":{"type":"array","description":"The providers that will be affected by the subscription","items":{"type":"string","description":"The provider name","uniqueKey":"monitoring.AML.providers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"monitoring.AML.providers","typeLabel":"string[]"},"status":{"type":"string","description":"Indicates the current status of the subscription.\n\n - `ENABLED`: The subscription is active and operational.\n - `DISABLED`: The subscription is inactive and not operational.","enum":["ENABLED","DISABLED"],"uniqueKey":"monitoring.AML.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"monitoring.AML","typeLabel":"object"},"CONTINUOUS_KYB_AU":{"type":"object","description":"The subscription details for Continuous KYB AU monitoring (CreditorWatch notifications, including credit score changes).\nThis block is only present when the customer has Continuous KYB enabled and the request included `CONTINUOUS_KYB_AU` in `monitoringTypes`.","properties":{"subscriptions":{"type":"array","description":"The list of Continuous KYB AU monitoring subscriptions","items":{"type":"object","description":"The subscription details for monitoring, this object is returned per monitoring type","properties":{"serviceName":{"type":"string","description":"The name of service associated the service profile","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].serviceName","typeLabel":"string"},"serviceProfileId":{"type":"string","description":"The ID of the service profile","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].serviceProfileId","typeLabel":"string"},"status":{"type":"string","description":"Indicates the current status of the subscription.\n\n - `ENABLED`: The subscription is active and operational.\n - `DISABLED`: The subscription is inactive and not operational.","enum":["ENABLED","DISABLED"],"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"enabledAt":{"type":"string","format":"date-time","description":"The date and time when the subscription was last enabled","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].enabledAt","typeLabel":"string\u003cdate-time>"},"enabledRequestId":{"type":"string","description":"The request id when the subscription was last enabled","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].enabledRequestId","typeLabel":"string"},"enabledBy":{"type":"string","description":"The username of last user who enabled the subscription","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].enabledBy","typeLabel":"string"},"disabledAt":{"type":"string","format":"date-time","description":"The date and time when the subscription was last disabled","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].disabledAt","typeLabel":"string\u003cdate-time>"},"disabledRequestId":{"type":"string","description":"The request id when the subscription was last disabled","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].disabledRequestId","typeLabel":"string"},"disabledBy":{"type":"string","description":"The username of last user who disabled the subscription","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].disabledBy","typeLabel":"string"},"workflows":{"type":"array","description":"The workflows that will be executed by the type for the service profile","items":{"type":"object","properties":{"workflowName":{"type":"string","description":"Name of the workflow.","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].workflows.items.[INDEX].workflowName","typeLabel":"string"},"workflowId":{"type":"string","description":"Unique ID of the workflow.","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].workflows.items.[INDEX].workflowId","typeLabel":"string"},"lifecyclePhase":{"type":"string","description":"Specifies the lifecycle phase of the customer in which this workflow is executed:\n - ONBOARDING: Workflow is in the onboarding stage.\n - MONITORING: Workflow is in the monitoring stage.\n - REFRESH: Workflow is in the refresh stage.\n - OTHER: Workflow is in another stage.\n","enum":["ONBOARDING","MONITORING","REFRESH","OTHER"],"default":"OTHER","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].workflows.items.[INDEX].lifecyclePhase","typeLabel":"enum\u003cstring>"}},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].workflows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX].workflows","typeLabel":"object[]"}},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.subscriptions","typeLabel":"object[]"},"providers":{"type":"array","description":"The providers that will be affected by the subscription, e.g. `creditorwatch`","items":{"type":"string","description":"The provider name","uniqueKey":"monitoring.CONTINUOUS_KYB_AU.providers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.providers","typeLabel":"string[]"},"status":{"type":"string","description":"Indicates the current status of the subscription.\n\n - `ENABLED`: The subscription is active and operational.\n - `DISABLED`: The subscription is inactive and not operational.","enum":["ENABLED","DISABLED"],"uniqueKey":"monitoring.CONTINUOUS_KYB_AU.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"monitoring.CONTINUOUS_KYB_AU","typeLabel":"object"}},"uniqueKey":"monitoring","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"requestId":"01HN9XHZN6MGXM9JXG50K59Q85","monitoring":{"AML":{"subscriptions":[{"serviceName":"\u003cstring>","serviceProfileId":"\u003cstring>","status":"ENABLED","enabledAt":"2023-11-07T05:31:56Z","enabledRequestId":"\u003cstring>","enabledBy":"\u003cstring>","disabledAt":"2023-11-07T05:31:56Z","disabledRequestId":"\u003cstring>","disabledBy":"\u003cstring>","workflows":[{"workflowName":"\u003cstring>","workflowId":"\u003cstring>","lifecyclePhase":"OTHER"}]}],"providers":["\u003cstring>"],"status":"ENABLED"},"CONTINUOUS_KYB_AU":{"subscriptions":[{"serviceName":"\u003cstring>","serviceProfileId":"\u003cstring>","status":"ENABLED","enabledAt":"2023-11-07T05:31:56Z","enabledRequestId":"\u003cstring>","enabledBy":"\u003cstring>","disabledAt":"2023-11-07T05:31:56Z","disabledRequestId":"\u003cstring>","disabledBy":"\u003cstring>","workflows":[{"workflowName":"\u003cstring>","workflowId":"\u003cstring>","lifecyclePhase":"OTHER"}]}],"providers":["\u003cstring>"],"status":"ENABLED"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a054ad27-9fff-40b5-b5f9-77ccf3e75cb6":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid EntityId":{"title":"Invalid EntityId","value":{"errorCode":"API-0400,","errorMsg":"Multiple Errors: See Issues list","details":[{"issue":"entityId in path must be of type uuid: \"test\"","issueLocation":"VALIDATE-entityId"}],"requestId":"01HM5XJ7VASZ3EJMB1VQGTBFJ4"}}},"exampleType":"examples"}},"exampleType":"examples"},"4613b87f-afc0-4c9f-b459-9936f16560a3":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid authentication":{"title":"Invalid authentication","value":{"errorCode":"AUTH-0002,","errorMsg":"Unauthorized","details":[{"issue":"Invalid Authentication provided. Access denied.","issueLocation":"request"}],"requestId":"00000000S6MNG7624K2TDXT1E3"}},"No Api-Key":{"title":"No Api-Key","value":{"errorCode":"AUTH-0401","errorMsg":"Unauthorized","details":[{"issue":"No api key provided. Access denied.","issueLocation":"request"}],"requestId":"00000001S6MNG7624K2TDXT1E3"}}},"exampleType":"examples"}},"exampleType":"examples"},"141326bd-9e49-49ac-88d7-69c3a1bdcbf4":{"description":"Forbidden. Returned when `CONTINUOUS_KYB_AU` is requested and the customer does not have Continuous KYB enabled (error code `VAL-403`).","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Continuous KYB not enabled":{"title":"Continuous KYB not enabled","value":{"errorCode":"VAL-403","errorMsg":"Continuous KYB (AU) is not enabled for this customer","details":[{"issue":"CONTINUOUS_KYB_AU monitoring requires Continuous KYB (AU) to be enabled for the customer.","issueLocation":"monitoringTypes"}],"requestId":"01HM5EM2QNNSC9K0PX9VC06HX3"}}},"exampleType":"examples"}},"exampleType":"examples"},"0954a2d0-8e1d-4d80-852a-e8b1d7501580":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"97a9b98c-5fb6-4ceb-a08d-59d8d3e98ffd":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"486e7bd9-6d4f-491b-957c-9560ef03888e":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"97525735-cea5-49cb-b53d-456a59f73bed":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"640031ed-1249-4a29-b7cf-4c28095d43c8":{"Api-Key":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[]}},"cab90247-1217-414d-8700-04802b1e2f76":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":["kyb:api","write:kyb:api"]}}},"servers":{"6734e950-f09c-4b6e-9778-94aa10d78805":{"url":"https://api.uat.frankie.one","description":"UAT Environment API Base URL"},"a1a8c4fb-5482-49a1-954f-d93fec6f9ad8":{"url":"https://api.frankie.one","description":"Production API Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[]},"schema":{"title":"api_key","type":"string","description":"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Api-Key","name":"api_key"}],"title":"Api-Key"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":["kyb:api","write:kyb:api"]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"jwt","name":"Authorization"}],"title":"jwt"}]},"originalFileLocation":"specs/fc-kyb-bundled_generated.yaml"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Turn on/off monitoring for a given organization - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization","matchLevel":0},"v1":{"href":"/docs/v1/introduction/getting-started/welcome-to-frankie","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-30T05:08:26.908Z","originalFileLocation":"api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"system\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either: - Enable monitoring - System will start monitoring the organization for potential changes. - Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts. The endpoint will effectively manage the monitoring status of the organization. Having monitoring status of a type enabled means that the organization is being monitored for that type. If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization. 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. Continuous KYB AU: CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes. It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403. The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.\">\u003cmeta data-mint-head name=\"application-name\" content=\"frankieone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Turn on/off monitoring for a given organization - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either: - Enable monitoring - System will start monitoring the organization for potential changes. - Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts. The endpoint will effectively manage the monitoring status of the organization. Having monitoring status of a type enabled means that the organization is being monitored for that type. If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization. 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. Continuous KYB AU: CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes. It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403. The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"frankieone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://frankieone-f5583b1b.mintlify.app/_mintlify/api/og/v2?division=Organization+Monitoring\u0026amp;title=Turn+on%2Foff+monitoring+for+a+given+organization\u0026amp;description=Toggle+monitoring+on+or+off+for+a+given+organization+e.g.+AML+or+Continuous+KYB+AU+monitoring.+Use+this+endpoint+to+either%3A%0A-+Enable+monitoring+-+System+will+st\u0026amp;theme=c47e43939fad196e0932957d\u0026amp;signature=5568d6b6415585209fb678fcf9253c0395a28b39079a2b991e7439c0cb2ef427\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Turn on/off monitoring for a given organization - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either: - Enable monitoring - System will start monitoring the organization for potential changes. - Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts. The endpoint will effectively manage the monitoring status of the organization. Having monitoring status of a type enabled means that the organization is being monitored for that type. If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization. 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. Continuous KYB AU: CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes. It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403. The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frankieone-f5583b1b.mintlify.app/_mintlify/api/og/v2?division=Organization+Monitoring\u0026amp;title=Turn+on%2Foff+monitoring+for+a+given+organization\u0026amp;description=Toggle+monitoring+on+or+off+for+a+given+organization+e.g.+AML+or+Continuous+KYB+AU+monitoring.+Use+this+endpoint+to+either%3A%0A-+Enable+monitoring+-+System+will+st\u0026amp;theme=c47e43939fad196e0932957d\u0026amp;signature=5568d6b6415585209fb678fcf9253c0395a28b39079a2b991e7439c0cb2ef427\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"frankieone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A6CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.frankieone.com/#organization\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.frankieone.com#website\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization#webpage\",\"url\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization\",\"name\":\"Turn on/off monitoring for a given organization\",\"description\":\"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either: - Enable monitoring - System will start monitoring the organization for potential changes. - Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts. The endpoint will effectively manage the monitoring status of the organization. Having monitoring status of a type enabled means that the organization is being monitored for that type. If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization. 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. Continuous KYB AU: CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes. It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403. The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.\",\"dateModified\":\"2026-09-30T05:08:26.908Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KYB V2 API\",\"item\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Turn on/off monitoring for a given organization\",\"item\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization#apireference\",\"headline\":\"Turn on/off monitoring for a given organization\",\"name\":\"Turn on/off monitoring for a given organization\",\"description\":\"Toggle monitoring on or off for a given organization e.g. AML or Continuous KYB AU monitoring. Use this endpoint to either: - Enable monitoring - System will start monitoring the organization for potential changes. - Disable monitoring - System will no longer monitor the organization for new potential matches and will no longer send alerts. The endpoint will effectively manage the monitoring status of the organization. Having monitoring status of a type enabled means that the organization is being monitored for that type. If the organization has several services under the entity, the endpoint will manage the subscription status of the organization 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 organization. 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. Continuous KYB AU: CONTINUOUS_KYB_AU monitors Australian organisations through CreditorWatch notifications, including credit score changes. It requires the customer to have Continuous KYB enabled. If the customer does not, a request that includes CONTINUOUS_KYB_AU returns 403 with error code VAL-403. The CONTINUOUS_KYB_AU block in the response is only present when the customer has Continuous KYB enabled and the request included CONTINUOUS_KYB_AU.\",\"url\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization#webpage\"},\"dateModified\":\"2026-09-30T05:08:26.908Z\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"frankieone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"frankieone","nav":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"versions":[{"version":"v2","tabs":[{"tab":"Introduction","icon":"book","pages":[{"title":"Introduction","href":"/v2/introduction/overview"}]},{"tab":"KYC","icon":"user-group","pages":[{"title":"KYC","href":"/docs/frankieone-introduction-to-kyc"}]},{"tab":"KYB","icon":"building","pages":[{"title":"KYB","href":"/docs/introduction-to-kyb"}]},{"tab":"Fraud and Transaction Monitoring","icon":"shield-halved","pages":[{"title":"Fraud and Transaction Monitoring","href":"/v2/docs/tm/fraud-and-transaction-monitoring-introduction"}]},{"tab":"OneSDK","icon":"display-code","pages":[{"title":"OneSDK","href":"/docs/about-onesdk"}]},{"tab":"Portal","icon":"credit-card","pages":[{"title":"Portal","href":"/docs/getting-started-with-the-frankieone-portal"}]},{"tab":"API","icon":"terminal","pages":[{"group":"Introduction","pages":[{"title":"Introduction to FrankieOne API","href":"/v2/api/introduction/introduction-to-frankie-one-api"},{"title":"Authentication","href":"/docs/reference/authentication"},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Overview","href":"/docs/reference/errors"},{"title":"API Error Codes","href":"/docs/reference/error-codes"}]},{"title":"Data Sources Codes","href":"/docs/reference/datasource-codes"},{"title":"UAT Test Data","sidebarTitle":"UAT Test Data","href":"/docs/uat-test-data"},{"title":"API Testing Tips","href":"/v2/api/developers/api-testing-guide"},{"title":"KYC API Enums Reference","href":"/docs/reference/kyc-enums"},{"title":"API endpoints","href":"/docs/reference/api-endpoints"},{"title":"Outbound IP addresses","href":"/docs/reference/outbound-ip-addresses"},{"title":"Risk Factors","sidebarTitle":"Risk Factors","hidden":false,"href":"/docs/risk-factors"},{"title":"Event Notifications \u0026 Webhooks","sidebarTitle":"Webhooks \u0026 Event Notifications","href":"/docs/reference/webhooks"},{"title":"API Versioning","href":"/v2/api/introduction/api-versioning"},{"title":"Resources","href":"/docs/introduction/resources"}]},{"group":"KYC V2 API","pages":[{"group":"Individual Entities","pages":[{"title":"Create an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals","href":"/api-reference/individual-entities/create-an-individual-entity"},{"title":"Get an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}","href":"/api-reference/individual-entities/get-an-individual-entity"},{"title":"Delete an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}","href":"/api-reference/individual-entities/delete-an-individual-entity"},{"title":"Update an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}","href":"/api-reference/individual-entities/update-an-individual-entity"}]},{"group":"Individual Workflows","pages":[{"title":"Get a list of executable workflows","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/workflows","href":"/api-reference/individual-workflows/get-a-list-of-executable-workflows"},{"title":"Create an individual and execute a workflow for the given service profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/individual-workflows/create-an-individual-and-execute-a-workflow-for-the-given-service-profile"},{"title":"Execute a workflow for the given service profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/individual-workflows/execute-a-workflow-for-the-given-service-profile"},{"title":"Evaluate a workflow for the given service profile using existing results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/evaluate","href":"/api-reference/individual-workflows/evaluate-a-workflow-for-the-given-service-profile-using-existing-results"},{"title":"Get a list of executions and their results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions","href":"/api-reference/individual-workflows/get-a-list-of-executions-and-their-results"},{"title":"Get the result of a specific execution by its executionId.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/individual-workflows/get-the-result-of-a-specific-execution-by-its-executionid"},{"title":"Override the status of a specific workflow execution.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/individual-workflows/override-the-status-of-a-specific-workflow-execution"}]},{"group":"Individual Profiles","pages":[{"title":"Get a service profile for a given individual entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/individual-profiles/get-a-service-profile-for-a-given-individual-entity"},{"title":"Update a profile for a given individual entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/individual-profiles/update-a-profile-for-a-given-individual-entity"}]},{"group":"Individual Results","pages":[{"title":"Approve Manual KYC for an individual","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/results/mkyc","href":"/api-reference/individual-results/approve-manual-kyc-for-an-individual"},{"title":"Invalidate any Manual KYC evidences of an individual","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/results/mkyc/invalidate","href":"/api-reference/individual-results/invalidate-any-manual-kyc-evidences-of-an-individual"},{"title":"Update the status of AML process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/aml","href":"/api-reference/individual-results/update-the-status-of-aml-process-results"},{"title":"Update the status of IDV process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/idv","href":"/api-reference/individual-results/update-the-status-of-idv-process-results"},{"title":"Update the status of Matchlist process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/matchlist","href":"/api-reference/individual-results/update-the-status-of-matchlist-process-results"},{"title":"Update the status of Duplicate process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/duplicate","href":"/api-reference/individual-results/update-the-status-of-duplicate-process-results"},{"title":"Update the status of Fraud process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/fraud","href":"/api-reference/individual-results/update-the-status-of-fraud-process-results"},{"title":"Get a list of process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/results","href":"/api-reference/individual-results/get-a-list-of-process-results"},{"title":"Get a process result","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/results/{processResultId}","href":"/api-reference/individual-results/get-a-process-result"},{"title":"Update the status of a supporting document","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/documents/{documentId}/status","href":"/api-reference/individual-results/update-the-status-of-a-supporting-document"}]},{"group":"Individual Entity Elements","pages":[{"title":"Delete a name","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/names/{nameId}","href":"/api-reference/individual-entity-elements/delete-a-name"},{"title":"Delete a date of birth","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/datesOfBirth/{dateOfBirthId}","href":"/api-reference/individual-entity-elements/delete-a-date-of-birth"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/addresses/{addressId}","href":"/api-reference/individual-entity-elements/delete-an-address"},{"title":"Delete an email address","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/emailaddresses/{emailAddressId}","href":"/api-reference/individual-entity-elements/delete-an-email-address"},{"title":"Delete phone number","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/phonenumbers/{phoneNumberId}","href":"/api-reference/individual-entity-elements/delete-phone-number"},{"title":"Withdraw a previously provided consent","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/consents/{consentType}","href":"/api-reference/individual-entity-elements/withdraw-a-previously-provided-consent"},{"title":"Get a list of external references","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/externalreferences","href":"/api-reference/individual-entity-elements/get-a-list-of-external-references"},{"title":"Delete an external reference","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/externalreferences/{referenceId}","href":"/api-reference/individual-entity-elements/delete-an-external-reference"}]},{"group":"Search","pages":[{"title":"Search for individual profiles","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/search/serviceprofiles","href":"/api-reference/search/search-for-individual-profiles"}]},{"group":"Individual Documents","pages":[{"title":"Get all documents for an entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/documents","href":"/api-reference/individual-documents/get-all-documents-for-an-entity"},{"title":"Create a new document for an individual.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/documents","href":"/api-reference/individual-documents/create-a-new-document-for-an-individual"},{"title":"Get a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/get-a-single-document-by-its-id"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/delete-a-document"},{"title":"Update a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/update-a-single-document-by-its-id"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/individual-documents/delete-an-attachment"}]},{"group":"Individual Risks","pages":[{"title":"Update an individual entity's risk level for a service profile.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}/risk","href":"/api-reference/individual-risks/update-an-individual-entitys-risk-level-for-a-service-profile"}]},{"group":"Monitoring","pages":[{"title":"Turn on/off monitoring for a given entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/monitor","href":"/api-reference/monitoring/turn-onoff-monitoring-for-a-given-entity"}]},{"group":"IDV","pages":[{"title":"Get an IDV Token for the given individual.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/token","href":"/api-reference/idv/get-an-idv-token-for-the-given-individual"},{"title":"Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/ocr","href":"/api-reference/idv/submit-an-identity-document-photo-for-ocr-processing-results-will-be-in-the-form-of-an-identity-document-with-populated-with-ocr-results"},{"title":"At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/process","href":"/api-reference/idv/at-the-end-of-the-idv-data-capture-process-with-all-photos-and-videos-captured-signal-to-idv-provider-that-check-is-ready-to-analyse-and-check"},{"title":"At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/checkstatus","href":"/api-reference/idv/at-the-end-of-the-idv-data-capture-process-with-all-photos-and-videos-captured-signal-to-idv-provider-that-check-is-ready-to-analyse-and-check-1"}]},{"group":"HostedURL","pages":[{"title":"Provide hosted url for a hosted version of onesdk.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/hostedurl","href":"/api-reference/hostedurl/provide-hosted-url-for-a-hosted-version-of-onesdk"}]}]},{"group":"Transaction and Activity Monitoring V2 API","pages":[{"group":"Activities","pages":[{"title":"Evaluate an activity","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/activities","href":"/api-reference/activities/evaluate-an-activity"},{"title":"Classify activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/activities/classify","href":"/api-reference/activities/classify-activities"},{"title":"Get Individual Activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml get /v2/individuals/{entityId}/activities","href":"/api-reference/activities/get-individual-activities"},{"title":"Get Organization Activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml get /v2/organizations/{entityId}/activities","href":"/api-reference/activities/get-organization-activities"}]},{"group":"Results","pages":[{"title":"Update Results","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml patch /v2/individuals/{entityId}/results/activity","href":"/api-reference/results/update-results"},{"title":"Update Organization Results","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml patch /v2/organizations/{entityId}/results/activity","href":"/api-reference/results/update-organization-results"}]},{"group":"Sessions","pages":[{"title":"Create Individual Session.\n","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/individuals/{entityId}/sessions","href":"/api-reference/sessions/create-individual-session"}]}]},{"group":"KYB V2 API","pages":[{"group":"Organizations","pages":[{"title":"Lookup organizations","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/lookup-organizations"},{"title":"Get an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}","href":"/api-reference/organizations/get-an-organization-entity"},{"title":"Delete an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}","href":"/api-reference/organizations/delete-an-organization-entity"},{"title":"Update basic attributes of an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}","href":"/api-reference/organizations/update-basic-attributes-of-an-organization-entity"},{"title":"Create an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations","href":"/api-reference/organizations/create-an-organization-entity"}]},{"group":"Organization Workflows","pages":[{"title":"Execute a workflow with organization details","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/workflows/{workflowName}/execute","href":"/api-reference/organization-workflows/execute-a-workflow-with-organization-details"},{"title":"Execute a workflow for the given orgnaization entityId","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/organization-workflows/execute-a-workflow-for-the-given-orgnaization-entityid"},{"title":"Evaluate a workflow for the given organization entityId using existing results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/evaluate","href":"/api-reference/organization-workflows/evaluate-a-workflow-for-the-given-organization-entityid-using-existing-results"},{"title":"Get the result of a specific execution by its executionId","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/organization-workflows/get-the-result-of-a-specific-execution-by-its-executionid"},{"title":"Get a list of executions and their results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions","href":"/api-reference/organization-workflows/get-a-list-of-executions-and-their-results"}]},{"group":"Organization Results","pages":[{"title":"Get a list of process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/results","href":"/api-reference/organization-results/get-a-list-of-process-results"},{"title":"Get a process result","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/results/{processResultId}","href":"/api-reference/organization-results/get-a-process-result"},{"title":"Update the status of AML process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/results/aml","href":"/api-reference/organization-results/update-the-status-of-aml-process-results"}]},{"group":"Organization Profiles","pages":[{"title":"Get a service profile for a given organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/organization-profiles/get-a-service-profile-for-a-given-organization-entity"},{"title":"Update a profile for a given organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/organization-profiles/update-a-profile-for-a-given-organization-entity"}]},{"group":"Organization Documents","pages":[{"title":"Get all documents for an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/get-all-documents-for-an-organization-entity"},{"title":"Create a new document for an organization.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/create-a-new-document-for-an-organization"},{"title":"Get a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/get-a-single-document-by-its-id"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/delete-a-document"},{"title":"Update a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/update-a-single-document-by-its-id"},{"title":"Get trust analyses results for a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/analyses","href":"/api-reference/organization-documents/get-trust-analyses-results-for-a-document"},{"title":"Confirm a trust analysis result for a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm","href":"/api-reference/organization-documents/confirm-a-trust-analysis-result-for-a-document"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/organization-documents/delete-an-attachment"}]},{"group":"Hosted URL","pages":[{"title":"Generate Hosted URL","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/hostedUrl","href":"/api-reference/hosted-url/generate-hosted-url"}]},{"group":"Organization Risks","pages":[{"title":"Update an organization entity's risk level for a service profile.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/serviceprofiles/{serviceName}/risk","href":"/api-reference/organization-risks/update-an-organization-entitys-risk-level-for-a-service-profile"}]},{"group":"Organization Relationships","pages":[{"title":"Get all manually added relationships for organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/get-all-manually-added-relationships-for-organization"},{"title":"Add or update relationships for an organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml put /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/add-or-update-relationships-for-an-organization"},{"title":"Delete relationships for an organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/delete-relationships-for-an-organization"}]},{"group":"Organization Addresses","pages":[{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/addresses/{addressId}","href":"/api-reference/organization-addresses/delete-an-address"}]},{"group":"Organization Custom Attributes","pages":[{"title":"Delete a custom attribute","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/customattributes/{key}","href":"/api-reference/organization-custom-attributes/delete-a-custom-attribute"}]},{"group":"Organization External References","pages":[{"title":"Delete an organization external reference","description":"Delete an organization's external reference with the given id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/externalreferences/{referenceId}","href":"/api-reference/organization-external-references/delete-an-organization-external-reference"}]},{"group":"Organization Monitoring","pages":[{"title":"Turn on/off monitoring for a given organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/monitor","href":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization"}]}]},{"group":"Core V2 API","pages":[{"group":"Audit","pages":[{"title":"List audit events","description":"List all audit events with filtering.\n\nNote that entityId and caseId is mutually exclusive and filtering for both at once will never return any results.\n","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/audit","href":"/api-reference/audit/list-audit-events"}]},{"group":"Comments","pages":[{"title":"Add a comment to an object","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/comments","href":"/api-reference/comments/add-a-comment-to-an-object"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/tags","href":"/api-reference/tags/list-tags"},{"title":"List tags objects","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/tags/objects","href":"/api-reference/tags/list-tags-objects"},{"title":"Remove tag objects","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/tags/objects/remove","href":"/api-reference/tags/remove-tag-objects"}]},{"group":"Workflows","pages":[{"title":"Get a list of executable workflows","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/workflows","href":"/api-reference/workflows/get-a-list-of-executable-workflows"},{"title":"Update Workflow Information","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/workflows/{workflowId}","href":"/api-reference/workflows/update-workflow-information"}]},{"group":"Workflow Definitions","pages":[{"title":"Create or update a workflow definition","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml put /v2/workflowDefinitions/{workflowDefinitionId}","href":"/api-reference/workflow-definitions/create-or-update-a-workflow-definition"}]},{"group":"Search","pages":[{"title":"Search for profiles","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/search/serviceprofiles","href":"/api-reference/search/search-for-profiles"}]},{"group":"Matchlists","pages":[{"title":"Search for matchlist entries","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/search/matchlists","href":"/api-reference/matchlists/search-for-matchlist-entries"},{"title":"Retrieve a list of matchlist details","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists","href":"/api-reference/matchlists/retrieve-a-list-of-matchlist-details"},{"title":"Get a list of matchlist entries","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists/{matchlistName}/entries","href":"/api-reference/matchlists/get-a-list-of-matchlist-entries"},{"title":"Create one or more entries in a matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/matchlists/{matchlistName}/entries","href":"/api-reference/matchlists/create-one-or-more-entries-in-a-matchlist"},{"title":"Retrieve a matchlist entry","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists/{matchlistName}/entries/{entryId}","href":"/api-reference/matchlists/retrieve-a-matchlist-entry"},{"title":"Modify a matchlist entry","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/matchlists/{matchlistName}/entries/{entryId}","href":"/api-reference/matchlists/modify-a-matchlist-entry"},{"title":"Add an individual entity to a matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/matchlists/{matchlistName}/entries/addEntity","href":"/api-reference/matchlists/add-an-individual-entity-to-a-matchlist"},{"title":"Remove an individual entity matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/matchlists/{matchlistName}/entries/removeEntity","href":"/api-reference/matchlists/remove-an-individual-entity-matchlist"}]},{"group":"Results","pages":[{"title":"Redact Process Result","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/results/{entityId}/processes/{processResultId}/redact","href":"/api-reference/results/redact-process-result"}]},{"group":"Reports","pages":[{"title":"List Extract PII jobs","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/report/extractPII","href":"/api-reference/reports/list-extract-pii-jobs"},{"title":"Extract PII report","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/report/extractPII","href":"/api-reference/reports/extract-pii-report"},{"title":"Download Extract PII files","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/report/extractPII/download","href":"/api-reference/reports/download-extract-pii-files"}]}]}]},{"tab":"Implementations","icon":"play","pages":[{"title":"Implementations","href":"/v2/api/developers/frankie-one-key-terms"}]},{"tab":"Release Notes","icon":"code","pages":[{"title":"Release Notes","href":"/docs/release-notes"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/docs/v1/introduction/getting-started/welcome-to-frankie"}]}]},"title":"Turn on/off monitoring for a given organization - frankieone","buildId":"dpl_48qhjNLiu9iJQQSZJz9Fa2ihBbPH","deploymentId":"dpl_48qhjNLiu9iJQQSZJz9Fa2ihBbPH","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rBlzXElK.js","utils-AjnlCZis.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-swvqTHUt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CG9fqVU0.js","snippetPresets-CQaUsst6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DAdT3l54.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B1x8JMQI.js","shallow-D3oUTT8_.js","getApiPlaygroundDisplay-CXVJ98Sz.js","CodeSnippet-HbTSvyGs.js","CodeSnippets-DvgXFP0T.js","Page-C2raW8UD.js","getPastedJson-CfDE0eLj.js","icon-DBPqa2DN.js","MethodPill-86CHHFOO.js","DuplicateIcon-B5BXvyBd.js","createIcon-C_r05QJX.js","DynamicMarkdown-Cp6hhEk1.js","SectionHeading-RZjzOLoo.js","axios-vUo_bRtp.js","Markdown-B0YOyiNO.js","clsx-Q3eNRTcf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-tb1XVL5i.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9O1lyZBL.js"]}