Testing Watchlists Ongoing Monitoring in Sandbox

On this page, you will learn how to test Watchlists Ongoing Monitoring in the Sandbox environment.

This guide will explain how to test the Ongoing Monitoring for a Natural Person without incurring charges in the Sandbox environment.

In the Sandbox, we do not watch the person but we will provide you a simulated experience that closely mirrors the production behavior. The requests, the statuses and the webhook payloads are identical to production.

Two things differ from production:

  • the Ongoing Monitoring is activated immediately after creation, instead of waiting for the provider;
  • you trigger the change notifications yourself, from a simulation page, instead of waiting weeks or months for a real change.

Activate the Ongoing Monitoring

Create the Ongoing Monitoring with the designated endpoint. The response has the status pending, as in production, then a few seconds later the Ongoing Monitoring becomes automatically active and you receive the monitoring.natural_person.activated event.

⚠️ Keep the id of the response: you need it to simulate the changes.

ℹ️ In the Sandbox, the activation always succeeds. The status inconclusive cannot be simulated.

Simulate a change

Open the simulation page in your browser, replacing {id} with the id of your Ongoing Monitoring:

https://api.yousign.app/sandbox/sandbox_provider/monitorings/natural_person/{id}

The page shows four buttons, one per scenario: new sanction, new political mandate, company change, and updated natural person details. Each one sends one notification immediately, and you can send as many as you need while the Ongoing Monitoring is active.

ℹ️ The page exists only in the Sandbox, and does not ask for an API key: knowing the id is enough to open it. A production id does not work. The page returns a 404 for an unknown id, and refuses the request with a 400 as soon as the Ongoing Monitoring is no longer active.

Retrieve the result

To see the result, subscribe in the Sandbox to the monitoring.natural_person.updated event. Each simulated change sends one webhook, with the same payload structure as in production and the metadata property sandbox set to true.

The detected changes are not stored on the monitoring and no endpoint returns them: the webhook is the only channel that delivers them, in Sandbox as in production.