How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FrankieOne Monitoring API

Turn on/off ongoing monitoring for an individual entity

FrankieOne Monitoring API is one of 13 APIs that FrankieOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monitoring. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.uat.frankie.one.

1 operations 1 paths 13 schemas 1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.frankie.one
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

FrankieOne Monitoring API declares 2 security schemes for authenticating requests. An API key is passed in the header as api_key (Api-Key). It accepts HTTP bearer tokens (JWT) (jwt). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Monitoring 1

Turn on/off ongoing monitoring for an individual entity

PATCH
/v2/individuals/{entityId}/monitor
Turn on/off monitoring for a given entity
patchMonitoring 7 params body → 200400401404500502503

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are entity_patch_monitoring_subscriptions_details_response (10 properties), Error-Base (3 properties), entity_patch_monitoring_subscriptions_aml_response (3 properties), Issue (3 properties). Each schema is shown below with its type and property counts.

Subscription-Status
string
Indicates the current status of the subscription. - ENABLED: The subscription is active and operational. - DISABLED: The subscription is inactive and not opera…
Monitoring-Type
string
The type of workflow subscription. This determines which types are subscribing to a workflow.
entity_patch_monitoring_subscriptions_response
object
1 property
Comment
object
2 properties
Workflow-LifecyclePhaseEnum
string
Specifies the lifecycle phase of the customer in which this workflow is executed: - ONBOARDING: Workflow is in the onboarding stage. - MONITORING: Workflow is…
Error-Base
object
3 properties
Issue
object
3 properties
Subscription-Type
string
Specifies the type of service profile subscription. This value determines the category of the service profile subscription.
Error
object
Request-ID
string
The unique request identifier for the API call made.
entity_patch_monitoring_subscriptions_aml_response
object
The subscription details for AML monitoring
3 properties
entity_patch_monitoring_subscriptions_details_response
object
The subscription details for monitoring, this object is returned per monitoring type
10 properties
entity_patch_monitoring_response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

frankieone-monitoring-api-openapi.yml Raw ↑

Other APIs FrankieOne publishes across the network.

FrankieOne Audit API
FrankieOne HostedURL API
FrankieOne IDV API
FrankieOne Individual Documents API
FrankieOne Individual Entities API
FrankieOne Individual Entity Elements API
FrankieOne Individual Profiles API
FrankieOne Individual Results API
FrankieOne Individual Risks API
FrankieOne Individual Workflows API
FrankieOne Matchlists API
FrankieOne Search API
Where this information came from

This is an independent, third-party profile of FrankieOne Monitoring API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.