Skip to main content

Check templates

A check template is a configuration option that determines how Maxsight communicates with your integration.

There are four main concepts that determine how Maxsight can communicate with your integration:

  • One-time: Maxsight makes a single request and the check is considered complete once the response is received from the integration.

    Applies to: ONE_TIME_SYNCHRONOUS, ONE_TIME_POLLING, ONE_TIME_CALLBACK

  • Polled: Maxsight continually polls your integration by making a new request to your integration at set intervals until the completed response is received. This type of check template is rarely used and isn't recommended for new integrations.

    Applies to: ONE_TIME_POLLING

  • Callback: Maxsight waits for a notification from the integration that the check response is ready. These notifications are made from the integration to Maxsight via the callback mechanism. Learn more about the Maxsight callback endpoints.

    Applies to: ONE_TIME_CALLBACK, MONITORED_CALLBACK

  • Monitored: Maxsight continually monitors for callbacks from an integration. This is used when new and updated data is required from an integration on an ongoing basis, such as for monitoring an entity for sanctions or politically exposed person risks.

    Applies to: MONITORED_CALLBACK

These communication concepts can be invoked by setting your integration to one of the following check templates:

Check template

Description

When to use

ONE_TIME_SYNCHRONOUS

A single request is made to the data provider and waits until the data provider completes processing and sends the completed response.

  • The provider returns the data required for the check output synchronously in response to the initial request.

  • The provider doesn’t use callbacks.

  • Ongoing monitoring of the check result isn't supported or desired.

ONE_TIME_POLLING

A single request is made to the data provider and an acknowledgment response is immediately returned. The data provider processing is then completed asynchronously. Maxsight continues to poll the data provider until the the processing is finished and a completed response is received.

  • The provider doesn't return the data required for the check output in response to the initial request.

  • The provider doesn't support callback functionality.

  • Ongoing monitoring of the check result isn't supported or desired.

ONE_TIME_CALLBACK

A single request is made to the data provider and an acknowledgment response is immediately returned. The data provider processing is then completed asynchronously, and the completed response is sent to the platform's callback URL when completed.

  • The provider doesn't return the data required for the check output in response to the initial request.

  • The provider uses callbacks to communicate when the data is ready to be retrieved.

  • Ongoing monitoring of the check result isn't supported or desired.

MONITORED_CALLBACK

Similar to the ONE_TIME_CALLBACK check template, but it is repeated for ongoing monitoring until canceled.

  • The provider doesn't return the data required for the check output in response to the initial request.

  • The provider uses callbacks to communicate when the data is ready to be retrieved.

  • Ongoing monitoring of the check result is supported and required.

Additional information

In this section: