Ongoing monitoring

Available on request. Contact IDCanopy for access; details may change.

Pending verification. The field names and the examples below follow the data provider's model plus our design and are to be defined with the contract. Treat them as indicative, not as a contract.

Ongoing monitoring re-screens a registered person or entity on a schedule. You register profiles into a monitoring group that IDCanopy sets up for you. The matches the schedule finds are read with query monitoring results.

The monitoring group ID (Monitoring_Group_Id in the retired guide) is issued with your access setup. Its name and how it is supplied are to be defined with the contract.

Full AML uses its own paths, separate from AML light.

Register an individual

Path to be defined (separate from AML light).

Registers a person for periodic re-screening against the rule set of the monitoring group.

Pending verification: the source is inconsistent here; the contract will define it. The retired guide's request table gives countries as a comma-separated string, while its example nests the fields under a data object and shows countries as an array.

Example request, not a contract. It is shown as the retired guide has it, so the nesting and the countries type mismatch with the table stay visible:

{
  "Monitoring_Group_Id": "example-monitoring-group",
  "type": "subscriptions",
  "data": {
    "name": "Example, Alex",
    "countries": ["GB"],
    "dateOfBirth": "1980-01-02",
    "gender": "female"
  }
}

The response echoes the registered profile and returns its subscription ID.

Register an entity

Path to be defined (separate from AML light).

Registers a company or organisation for periodic re-screening.

Pending verification: the source is inconsistent here; the contract will define it. This example is flat and shows countries as an array, while the individual registration above nests its fields under data and both request tables give countries as a comma-separated string.

Example request, not a contract:

{
  "Monitoring_Group_Id": "example-monitoring-group",
  "type": "subscriptions",
  "name": "Acme Holdings Ltd",
  "countries": ["GB"]
}

The response has the same shape as the individual registration: data.subscriptionId, data.type and data.attributes with the echoed name and countries.

Remove a search profile

Path to be defined (separate from AML light).

Removes an existing profile from monitoring, for a person or an entity.

Example request, not a contract:

{
  "Monitoring_Group_Id": "example-monitoring-group",
  "subscriptionId": "example-subscription-1",
  "entityType": "Person"
}

Contract status

The registration shapes, the monitoring group identifier and the paths are to be defined with the contract. Full AML uses its own paths, separate from AML light.