Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If any of your monitored business records gets a match in our AML datasets, you can retrieve it.

...

1️⃣ Retrieve all matches of the business

Info
  • You can retrieve all matches of the business.

  • To do this, call the following endpoint:

    • POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search

...

Expand
titleExpand to see the example response
Code Block
languagejson
{
  "hasErrors": false,
  "records": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8",
      "createdAt": "2023-03-20T10:05:07.600Z",
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference",
      "error": {
        "code": "MS101",
        "message": "Error message"
      }
    }
  ]
}

...

8️⃣ Retrieve all matches of the business

🗒️ Example response

Expand
titleExpand to see the example response
Code Block
languagejson
{
  "totalCount": 15,
  "matches": [
    {
      "currentStatus": "Open",
      "matchId": "432523",
      "version": 15346444345,
      "resourceId": "1f5a940e6a16d390bfe75055c3176f64c5b397880ff08e04b61ad7325af76cc4",
      "score": 100,
      "match": "Business name",
      "name": "Found Business name",
      "countries": [
        "US"
      ],
      "dataSets": [
        "OndatoSanctions",
        "ExternalSanctionsCurrent"
      ],
      "matchVersion": 1
    }
  ]
}

...