Company screening

1. Register Company

Start with Register company to add the company you wish to screen the watchlists for and get potential matches. The field companyReferenceId should be set to a unique ID from your system, for example the Database ID for the company you are registering.

Node.js

let request: RegisterCompanyCommand = {
  companyReferenceId: "company-223",
  name: "Korea Daesong Bank"
};
let response = await client.registerCompany(request);

Python

request = {
  "companyReferenceId": "company-223",
  "name": "Korea Daesong Bank"
}
response = client.register_company(request)

Java

RegisterCompanyCommand request = new RegisterCompanyCommand();
request.companyReferenceId = "company-223";
request.name = "Korea Daesong Bank";

RegisterCompanyResponse response = client.registerCompany(request);

.Net

var request = new RegisterCompanyCommand
{
  CompanyReferenceId = "company-223",
  Name = "Korea Daesong Bank",
};

var response = await client.RegisterCompany(request);

tip

See Search Options for more information about possible options to modifying the search algorithm.

Response

{
  "data": {
    "companyReferenceId": "company-223",
    "identity": null,
    "name": "Korea Daesong Bank",
    "beneficiaries": [],
    "archived": false,
    "highRiskCountry": false,
    "hits": [
      [
        {
          "matchId": "c240d937a0e1635f222e3589b8760377",
          "aliasId": "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695",
          "isSanction": true,
          "classification": "Unknown",
          "name": "Korea Daesong Bank",
          "matchedName": [
            {
              "text": "Korea",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "Daesong",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "Bank",
              "isMatch": true
            }
          ],
          "score": 1.0
        }
      ]
    ],
    "lastChanged": {
      "timestampUtc": "2022-01-04T21:03:53.654408Z",
      "checkpoint": "37133c1f1b58ccd4a28d480bd2a9aeaa9f30170ae9689578020a025d2998c529"
    },
    "isSanction": true,
    "description": null,
    "corporateForm": null,
    "registrationDate": null,
    "representatives": []
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "37133c1f1b58ccd4a28d480bd2a9aeaa9f30170ae9689578020a025d2998c529"
}

We got a Sanction Match

With the example we submitted, we can see the company has matched with a sanctioned company. The Watchlist endpoint can then be queried for further information about the matches. To decide whether the match was a true match or a false positive.

Node.js

let request: WatchlistCompanyQuery = {
  matchId: "c240d937a0e1635f222e3589b8760377",
  companyReferenceId: "company-223"
};

let response = await client.watchlistCompany(request);

Python

request = {
  "matchId": "c240d937a0e1635f222e3589b8760377",
  "companyReferenceId": "company-223"
}

response = client.watchlist_company(request)

Java

WatchlistCompanyQuery request = new WatchlistCompanyQuery();
request.matchId = "c240d937a0e1635f222e3589b8760377";
request.companyReferenceId = "company-223";

WatchlistCompanyQueryResult response = client.watchlistCompany(request);

.Net

var request = new WatchlistCompanyQuery
{
  MatchId = "c240d937a0e1635f222e3589b8760377",
  CompanyReferenceId = "company-223",
};

var response = await client.WatchlistCompany(request);

Response

{
  "data": null,
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

2. Monitoring status changes

Pliance will monitor the company for any PEP and Sanction status changes. To keep your system updated on these changes you have the following options.

Using view company

Node.js

let request: ViewCompanyQuery = {
  companyReferenceId: "company-223"
};

let response = await client.viewCompany(request);

Python

request = {
  "companyReferenceId": "company-223"
}

response = client.view_company(request)

Java

ViewCompanyQuery request = new ViewCompanyQuery();
request.companyReferenceId = "company-223";

ViewCompanyQueryResult response = client.viewCompany(request);

.Net

var request = new ViewCompanyQuery
{
  CompanyReferenceId = "company-223",
};

var response = await client.ViewCompany(request);

Response

{
  "data": {
    "companyReferenceId": "company-223",
    "identity": null,
    "name": "Korea Daesong Bank",
    "beneficiaries": [],
    "archived": false,
    "highRiskCountry": false,
    "hits": [
      [
        {
          "matchId": "c240d937a0e1635f222e3589b8760377",
          "aliasId": "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695",
          "isSanction": true,
          "classification": "FalsePositive",
          "name": "Korea Daesong Bank",
          "matchedName": [
            {
              "text": "Korea",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "Daesong",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "Bank",
              "isMatch": true
            }
          ],
          "score": 1.0
        }
      ]
    ],
    "lastChanged": {
      "timestampUtc": "2022-01-04T21:03:54.068772Z",
      "checkpoint": "94b7ba0d433c3d1494dbd5c93b7ace39728a520fa2d976c5cc7dcf11133b9fee"
    },
    "isSanction": false,
    "description": null,
    "corporateForm": null,
    "registrationDate": null,
    "representatives": []
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "94b7ba0d433c3d1494dbd5c93b7ace39728a520fa2d976c5cc7dcf11133b9fee"
}

Using Search

Node.js

let request: CompanySearchQuery {
    filter: {
      isUnclassified: true
  }
};

let response = await client.searchCompany(request);

Python

request = {
  "filter": {
    "isUnclassified": True
  }
}

response = client.search_company(request)

Java

CompanySearchQuery request = new CompanySearchQuery();
request.filter = new CompanyFilter();
request.filter.isUnclassified = true;

CompanySearchQueryResult response = client.searchCompany(request);

.Net

var request = new CompanySearchQuery
{
  Filter = new CompanyFilter
  {
      IsUnclassified = true,
  }
};

var response = await client.SearchCompany(request);

Response

{
  "data": {
    "result": [
      {
        "companyReferenceId": "company-223",
        "name": [
          {
            "text": "Korea",
            "isMatch": false
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Daesong",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Bank",
            "isMatch": false
          }
        ],
        "isPep": false,
        "isRca": false,
        "isSanction": false,
        "identity": null,
        "archived": false
      }
    ]
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Using Webhooks

You also have the possibility to be notified about sanction changes on your active companies by registering a webhook. Please refer to Webhooks for further details.

3. Manage watchlist matches

Pliance algorithms are designed to provide accurate screening results and we do our best to minimize false positives. In the event you need to correct an erroneous match, use the classify company command.

Node.js

let request: ClassifyCompanyHitCommand = {
  companyReferenceId: "company-223",
  matchId: "c240d937a0e1635f222e3589b8760377",
  aliasId: "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695",
  classification: ClassificationType.FalsePositive
};

let response = await client.classifyCompanyHit(request);

Python

request = {
  "companyReferenceId": "company-223",
  "matchId": "c240d937a0e1635f222e3589b8760377",
  "aliasId": "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695",
  "classification": "FalsePositive"
}

response = client.classify_company_hit(request)

Java

ClassifyCompanyHitCommand request = new ClassifyCompanyHitCommand();
request.companyReferenceId = "company-223";
request.matchId = "c240d937a0e1635f222e3589b8760377";
request.aliasId = "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695";
request.classification = ClassificationType.FalsePositive;

ClassifyCompanyHitResponse response = client.classifyCompanyHit(request);

.Net

var request = new ClassifyCompanyHitCommand
{
  CompanyReferenceId = "company-223",
  MatchId = "c240d937a0e1635f222e3589b8760377",
  AliasId = "85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695",
  Classification = ClassificationType.FalsePositive,
};

var response = await client.ClassifyCompanyHit(request);

Response

{
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "fd362e0faabd9e19de260ae542fc782210c05067118b61d99a327f4d77adbe1b"
}

4. Archive a company

When you no longer wish to monitor the company, use the archive command. An archived company is no longer daily screened and will be exempt from billing (if it has been archived for the entire month).

Node.js

let request: ArchiveCompanyCommand = {
  companyReferenceId: "company-223"
};

let response = await client.archiveCompany(request);

Python

request = {
  "companyReferenceId": "company-223"
}

response = client.archive_company(request)

Java

ArchiveCompanyCommand request = new ArchiveCompanyCommand();
request.companyReferenceId = "company-223";

ArchiveCompanyResponse response = client.archiveCompany(request);

.Net

var request = new ArchiveCompanyCommand
{
  CompanyReferenceId = "company-223",
};

var response = await client.ArchiveCompany(request);

Response

{
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "7b38885933fba97af8c2715bddccd2639858d542021737d50d128f438814ddd1"
}

5. Unarchive a Company

Archived companies can be actively screened again by submitting an unarchive command.

Node.js

let request: UnarchiveCompanyCommand {
  companyReferenceId: "company-223"
};

let response = await client.unarchiveCompany(request);

Python

request = {
  "companyReferenceId": "company-223"
}

response = client.unarchive_company(request)

Java

UnarchiveCompanyCommand request = new UnarchiveCompanyCommand();
request.companyReferenceId = "company-223";

UnarchiveCompanyResponse response = client.unarchiveCompany(request);

.Net

var request = new UnarchiveCompanyCommand
{
  CompanyReferenceId = "company-223",
};

var response = await client.UnarchiveCompany(request);

Response

{
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "fd362e0faabd9e19de260ae542fc782210c05067118b61d99a327f4d77adbe1b"
}

6. Delete a Company

Lastly, use Delete company to delete a registered company once there is no longer any business relationship with the company.

danger

This operation is irreversible. This will remove all data for the company.

Node.js

let request: DeleteCompanyCommand = {
  companyReferenceId: "company-223"
};

let response = await client.deleteCompany(request);

Python

request = {
  "companyReferenceId": "company-223"
}

response = client.delete_company(request)

Java

DeleteCompanyCommand request = new DeleteCompanyCommand();
request.companyReferenceId = "company-223";

DeleteCompanyResponse response = client.deleteCompany(request);

.Net

var request = new DeleteCompanyCommand
{
  CompanyReferenceId = "company-223",
};

var response = await client.DeleteCompany(request);

Response

{
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "fd362e0faabd9e19de260ae542fc782210c05067118b61d99a327f4d77adbe1b"
}