Skip to main content
Continuous KYB monitors an Australian organization after onboarding and notifies you when its registered business details change, including credit score changes. This page is for developers integrating with the FrankieOne v2 API. It covers how to turn monitoring on or off for an organization and what the API returns. Applies to FrankieOne KYB v2, for organizations registered in Australia. For the v1 API, see Continuous KYB for an Entity.

Before you start

  • Continuous KYB must be turned on for your customer account. If it is not, requests for this monitoring type return 403. To turn it on, reach out to your Customer Success Manager.
  • The organization must already exist in FrankieOne. See Creating & Managing Organizations to create one and get its entityId.
  • The organization must be registered in Australia and have a valid ABN or ACN. Monitoring does not apply to deleted organizations.

How Continuous KYB works

1

Turn on monitoring

Send one API request to turn on Continuous KYB for the organization. FrankieOne registers the organization’s ABN or ACN for monitoring and creates a CONTINUOUS_KYB_AU subscription on its service profile.
2

FrankieOne monitors the organization

FrankieOne checks for changes to the organization’s registered details. You don’t need to take any further action.
3

Receive notifications

When a change is detected, FrankieOne sends a notification to your configured webhook.

Turn monitoring on or off

Use the Turn on/off monitoring for a given organization endpoint with monitoringTypes=CONTINUOUS_KYB_AU. Endpoint: PATCH /v2/organizations/{entityId}/monitor Query parameters: You can include a comment in the request body. FrankieOne adds it to the organization’s audit log.

Example: turn on Continuous KYB

Response

A successful request returns 200 OK. The monitoring.CONTINUOUS_KYB_AU object shows the subscription status. It is present only when Continuous KYB is turned on for your account and the request included CONTINUOUS_KYB_AU.

Example: turn off Continuous KYB

Send the same request with enabled=false. The subscription status changes to DISABLED, and FrankieOne stops sending notifications for the organization.

Turning on monitoring that is already on

If Continuous KYB is already turned on for the organization, a request with enabled=true returns 200 OK with the current subscription. It does not create a second subscription.

Automatic unsubscribe

To optimize your costs, FrankieOne automatically disables Continuous KYB for an organization when:
  • The organization is deleted.
  • The organization’s KYB service profile is archived or becomes inactive.