Query monitoring results

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

Pending verification. The field names and the example 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.

Returns the matches found for a registered profile since registration. Register profiles with ongoing monitoring.

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

Path

Path to be defined (separate from AML light).

Response

Field	Type	Description
`data.type`	string	The alert type, for example `"reviews"` or `"alerts"`.
`data.id`	string	Identifier of the alert.
`data.attributes`	object	The alert fields, see below.
`links`	object or null	Optional hypermedia links.

Alert attributes (`data.attributes`)

Field	Type	Description
`currentStatus`	string	Status of the match: `open`, `true-positive`, `false-positive` or `discarded`.
`version`	integer	Version number, usable to detect when the profile changed.
`personID`	string	Profile ID, usable to retrieve the full profile.
`score`	integer	Confidence score of the match, `50` to `100`.
`match`	string	The name on the profile that matched the search.
`name`	string	Primary name of the person on the profile.
`countries`	string array	Countries from the addresses and nationalities of the profile.
`datesOfBirth`	string array	Dates of birth, as `YYYY-MM-DD` or `YYYY`.
`gender`	string	Gender of the person, if known.
`profileImage`	string	Main profile image URL.
`datasets`	string array	Datasets that apply to the profile.
`pepTier`	string	PEP tier of the person, for example `PEP Tier 1`.

Pending verification: the source is inconsistent here; the contract will define it. The alert fields are person-shaped (personID, datesOfBirth, gender, profileImage, pepTier). How an entity alert is shaped is to be defined with the contract; the example below is a person.

Alert status

Value	Meaning
`open`	The alert needs review.
`true-positive`	The alert is closed: the profile matched correctly.
`false-positive`	The alert is closed: the profile matched incorrectly.
`discarded`	The profile no longer matches the subscription after a change in the profile, the subscription or the follow list.

Example response, not a contract:

{
  "data": {
    "type": "reviews",
    "id": "example-alert-1",
    "attributes": {
      "currentStatus": "open",
      "version": 1673422459,
      "personID": "example-person-1",
      "score": 95,
      "match": "Example, Alex",
      "name": "Alex Example",
      "countries": ["GB"],
      "datesOfBirth": ["1980-01-02"],
      "gender": "female",
      "profileImage": "https://example.com/profile.jpg",
      "datasets": ["PEP-CURRENT", "SAN-CURRENT"],
      "pepTier": "PEP Tier 1"
    },
    "links": null
  }
}

Contract status

The result shape, the alert fields and the path are to be defined with the contract. Full AML uses its own paths, separate from AML light.