NAV Navbar
C# cURL Java JavaScript Python

Introduction

This specification is documented in OpenAPI format, it describes the REST APIs of Pliance.

Code samples of requests and responses will be show here.

Select preferred language in the tabs above, or in the menu if using a mobile browser.

SDK

Pliance provides publicly available open source code, and packages for several popular languages to ease the the development.

.NET

Installation

dotnet add package Pliance.NET-SDK

Nuget

Source code

https://github.com/pliance/Pliance.Net.SDK

Java

Installation

Maven Central

Source code

https://github.com/pliance/Pliance.Java.SDK

Node.js

Installation

npm i @pliance/pliance.js.sdk

npm

Source code

https://github.com/pliance/Pliance.JS.SDK

Python

Installation

pip install pliance.py.sdk

PyPI

Source Code

https://github.com/pliance/Pliance.Py.SDK

Authentication

Pliance.io uses bearer authentication.

This form of authentication is using security tokens. The clients send the HTTP-header Authorization with each request to the API-service.

These tokens can be used in either a web browser or a system.

Security

Pliance uses secure communication over HTTPS for all data during transit.

Additional security can be archived by adding IP-filtering or client certificates.

Generating Security Token

We are using JSON Web Token. To generate a valid token, add the same fields as specified below and sign with your secret.

For assistance debugging your tokens, we recommend using https://jwt.io/.

{
    "typ": "JWT",
    "alg": "HS256"
}
{
    "iat": 1555495956,
    "nbf": 1555495956,
    "exp": 1555496256,
    "aud": "pliance.io",
    "iss": "CUSTOMER_ID",
    "given_name": "USERNAME",
    "sub": "USER_ID"
}
Property Meaning Description
iat Issued At When the token was generated
nbf Not Before Token can't be used before
exp Expiration Time Token can't be used after
aud Audience The recipient of the token, always pliance.io
iss Issuer The one who is issuing the token, your company name
given_name Username Name of the user or system consuming the service
sub UserId UserId of the user or system consuming the server

Ping

Ping

GET api/Ping

Test the accessable of service without mutating the system.

Code Samples

curl "$HOST/api/Ping" -H "Authorization: Bearer $JWT"

request = {}

response = client.ping(request)

let request = new PingQuery
{
};

let response = await client.ping(request);

var request = new PingQuery
{
};

var response = await client.Ping(request);

PingQuery request = new PingQuery();

PingResponse response = client.ping(request);

Successful response

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

Parameters

Name In Type Required Description

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Company command

Register company

PUT api/CompanyCommand

Create or update a company.

Code Samples

curl -XPUT "$HOST/api/CompanyCommand" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"companyReferenceId":"company-id","name":"Korea Daesong Bank"}'

request = {
  "companyReferenceId": "company-id",
  "name": "Korea Daesong Bank"
}

response = client.register_company(request)

let request = new RegisterCompanyCommand
{
  companyReferenceId = "company-id",
  name = "Korea Daesong Bank",
};

let response = await client.registerCompany(request);

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

var response = await client.RegisterCompany(request);

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

RegisterCompanyResponse response = client.registerCompany(request);

Successful response

{
  "data": {
    "companyReferenceId": "company-id",
    "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": "2020-10-14T15:02:51.584664Z",
      "checkpoint": "bb98b06adbe07c764bbd7c384bf69d224b980a030c458d9bb7ebbbefaa258b49"
    },
    "isSanction": true,
    "description": null,
    "corporateForm": null,
    "registrationDate": null,
    "representatives": []
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "bb98b06adbe07c764bbd7c384bf69d224b980a030c458d9bb7ebbbefaa258b49"
}

Parameters

Name In Type Required Description
CompanyReferenceId body string Yes Unique identifer for the company.
Identity body Company identity No
Name body string Yes The company's name.
Options body Register company options No

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data View company response data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Archive company

POST api/CompanyCommand/Archive

Archive a company.

Code Samples

curl -XPOST "$HOST/api/CompanyCommand/Archive" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"companyReferenceId":"company-id"}'

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

response = client.archive_company(request)

let request = new ArchiveCompanyCommand
{
  companyReferenceId = "company-id",
};

let response = await client.archiveCompany(request);

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

var response = await client.ArchiveCompany(request);

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

ArchiveCompanyResponse response = client.archiveCompany(request);

Successful response

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

Parameters

Name In Type Required Description
CompanyReferenceId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Unarchive company

POST api/CompanyCommand/Unarchive

Unarchive a company.

Code Samples

curl -XPOST "$HOST/api/CompanyCommand/Unarchive" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"companyReferenceId":"company-id"}'

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

response = client.unarchive_company(request)

let request = new UnarchiveCompanyCommand
{
  companyReferenceId = "company-id",
};

let response = await client.unarchiveCompany(request);

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

var response = await client.UnarchiveCompany(request);

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

UnarchiveCompanyResponse response = client.unarchiveCompany(request);

Successful response

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

Parameters

Name In Type Required Description
CompanyReferenceId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Classify company hit

POST api/CompanyCommand/Classify

Classify a match as either Unknown, Match or FalsePositive.

Code Samples

curl -XPOST "$HOST/api/CompanyCommand/Classify" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"companyReferenceId":"company-id","matchId":"c240d937a0e1635f222e3589b8760377","aliasId":"85dd36a12f919dbe2f74aba4f30c05f353fe238eb5df3235e4baca91c177a695","classification":"FalsePositive"}'

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

response = client.classify_company_hit(request)

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

let response = await client.classifyCompanyHit(request);

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

var response = await client.ClassifyCompanyHit(request);

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

ClassifyCompanyHitResponse response = client.classifyCompanyHit(request);

Successful response

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

Parameters

Name In Type Required Description
AliasId body string Yes
Classification body Classification type Yes
CompanyReferenceId body string Yes
MatchId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Delete company

DELETE api/CompanyCommand

Delete a company.

Code Samples

curl -XDELETE "$HOST/api/CompanyCommand?companyReferenceId=company-id" -H "Authorization: Bearer $JWT"

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

response = client.delete_company(request)

let request = new DeleteCompanyCommand
{
  companyReferenceId = "company-id",
};

let response = await client.deleteCompany(request);

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

var response = await client.DeleteCompany(request);

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

DeleteCompanyResponse response = client.deleteCompany(request);

Successful response

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

Parameters

Name In Type Required Description
CompanyReferenceId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Company query

Search company

GET api/CompanyQuery/Search

Search for companies matchings specified criterias.

Code Samples

curl "$HOST/api/CompanyQuery/Search?query=Daesong" -H "Authorization: Bearer $JWT"

request = {
  "query": "Daesong"
}

response = client.search_company(request)

let request = new CompanySearchQuery
{
  query = "Daesong",
};

let response = await client.searchCompany(request);

var request = new CompanySearchQuery
{
  Query = "Daesong",
};

var response = await client.SearchCompany(request);

CompanySearchQuery request = new CompanySearchQuery();
request.query = "Daesong";

CompanySearchQueryResult response = client.searchCompany(request);

Successful response

{
  "data": {
    "result": [
      {
        "companyReferenceId": "company-id",
        "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
      },
      {
        "companyReferenceId": "Daesong",
        "name": [
          {
            "text": "Korea",
            "isMatch": false
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Daesong",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Bank",
            "isMatch": false
          }
        ],
        "isPep": false,
        "isRca": false,
        "isSanction": true,
        "identity": {
          "identity": "999",
          "country": "kp"
        },
        "archived": false
      }
    ]
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description
Filter query Filter No
Page query Page No
Query query string No

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data Company search response data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

View company

GET api/CompanyQuery

View a specific company.

Code Samples

curl "$HOST/api/CompanyQuery?companyReferenceId=company-id" -H "Authorization: Bearer $JWT"

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

response = client.view_company(request)

let request = new ViewCompanyQuery
{
  companyReferenceId = "company-id",
};

let response = await client.viewCompany(request);

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

var response = await client.ViewCompany(request);

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

ViewCompanyQueryResult response = client.viewCompany(request);

Successful response

{
  "data": {
    "companyReferenceId": "company-id",
    "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": "2020-10-14T15:02:51.748956Z",
      "checkpoint": "60636d709623c20e157485ca0f41163190c3076c37b3b9650e3ac0a01ccb69a3"
    },
    "isSanction": false,
    "description": null,
    "corporateForm": null,
    "registrationDate": null,
    "representatives": []
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "60636d709623c20e157485ca0f41163190c3076c37b3b9650e3ac0a01ccb69a3"
}

Parameters

Name In Type Required Description
CompanyReferenceId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data View company response data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Person command

Register person

PUT api/PersonCommand

Create or update a person.

Code Samples

curl -XPUT "$HOST/api/PersonCommand" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"identity":{"country":"us"},"personReferenceId":"person-id","firstName":"John F.","lastName":"Kennedy"}'

request = {
  "identity": {
    "country": "us"
  },
  "personReferenceId": "person-id",
  "firstName": "John F.",
  "lastName": "Kennedy"
}

response = client.register_person(request)

let request = new RegisterPersonCommand
{
  identity = new PersonIdentity
  {
    country = "us",
  },
  personReferenceId = "person-id",
  firstName = "John F.",
  lastName = "Kennedy",
};

let response = await client.registerPerson(request);

var request = new RegisterPersonCommand
{
  Identity = new PersonIdentity
  {
    Country = "us",
  },
  PersonReferenceId = "person-id",
  FirstName = "John F.",
  LastName = "Kennedy",
};

var response = await client.RegisterPerson(request);

PersonIdentity identity = new PersonIdentity();
identity.country = "us";
RegisterPersonCommand request = new RegisterPersonCommand();
request.identity = identity;
request.personReferenceId = "person-id";
request.firstName = "John F.";
request.lastName = "Kennedy";

RegisterPersonResponse response = client.registerPerson(request);

Successful response

{
  "hits": [
    [
      {
        "aliasId": "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
        "referenceId": "person-id",
        "matchedFirstName": [
          {
            "text": "John",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "F",
            "isMatch": true
          },
          {
            "text": ".",
            "isMatch": false
          }
        ],
        "matchedLastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "isSanction": false,
        "isPep": true,
        "isRca": false,
        "firstName": "John F.",
        "lastName": "Kennedy",
        "matchId": "7116f1a85030f2ed16d5d53224d772b9",
        "classification": "Unknown",
        "score": 1.0
      }
    ]
  ],
  "data": {
    "personReferenceId": "person-id",
    "identity": {
      "identity": null,
      "country": "us"
    },
    "firstName": "John F.",
    "lastName": "Kennedy",
    "birthdate": "????-??-??",
    "addresses": [],
    "hits": [
      [
        {
          "aliasId": "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
          "referenceId": "person-id",
          "matchedFirstName": [
            {
              "text": "John",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "F",
              "isMatch": true
            },
            {
              "text": ".",
              "isMatch": false
            }
          ],
          "matchedLastName": [
            {
              "text": "Kennedy",
              "isMatch": true
            }
          ],
          "isSanction": false,
          "isPep": true,
          "isRca": false,
          "firstName": "John F.",
          "lastName": "Kennedy",
          "matchId": "7116f1a85030f2ed16d5d53224d772b9",
          "classification": "Unknown",
          "score": 1.0
        }
      ]
    ],
    "gender": "Unknown",
    "archived": false,
    "engagements": null,
    "isPep": true,
    "isRca": false,
    "isSanction": false,
    "birth": null,
    "highRiskCountry": false,
    "lastChanged": {
      "timestampUtc": "2020-10-14T15:02:51.617304Z",
      "checkpoint": "1cb120d406f9982d55b6de0c39066515e050e2f4ae07dcdb119f8e18854b71e7"
    }
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "1cb120d406f9982d55b6de0c39066515e050e2f4ae07dcdb119f8e18854b71e7"
}

Parameters

Name In Type Required Description
Addresses body [Address] No
Birthdate body Birthdate No
FirstName body string Yes
Gender body string No Valid values: f, female, m or male.
Identity body Person identity No
LastName body string Yes
Options body Register person options No
PersonReferenceId body string Yes Unique identifer for the person.

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data View person response data No None
Hits [[Person details hit model]] No None Legacy, use Data.Hits instead
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Archive person

POST api/PersonCommand/Archive

Archive a person.

Code Samples

curl -XPOST "$HOST/api/PersonCommand/Archive" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"personReferenceId":"person-id"}'

request = {
  "personReferenceId": "person-id"
}

response = client.archive_person(request)

let request = new ArchivePersonCommand
{
  personReferenceId = "person-id",
};

let response = await client.archivePerson(request);

var request = new ArchivePersonCommand
{
  PersonReferenceId = "person-id",
};

var response = await client.ArchivePerson(request);

ArchivePersonCommand request = new ArchivePersonCommand();
request.personReferenceId = "person-id";

ArchivePersonResponse response = client.archivePerson(request);

Successful response

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

Parameters

Name In Type Required Description
PersonReferenceId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Unarchive person

POST api/PersonCommand/Unarchive

Unarchive a person.

Code Samples

curl -XPOST "$HOST/api/PersonCommand/Unarchive" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"personReferenceId":"person-id"}'

request = {
  "personReferenceId": "person-id"
}

response = client.unarchive_person(request)

let request = new UnarchivePersonCommand
{
  personReferenceId = "person-id",
};

let response = await client.unarchivePerson(request);

var request = new UnarchivePersonCommand
{
  PersonReferenceId = "person-id",
};

var response = await client.UnarchivePerson(request);

UnarchivePersonCommand request = new UnarchivePersonCommand();
request.personReferenceId = "person-id";

UnarchivePersonResponse response = client.unarchivePerson(request);

Successful response

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

Parameters

Name In Type Required Description
PersonReferenceId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Classify person hit

POST api/PersonCommand/Classify

Classify a match as either Unknown, Match or FalsePositive.

Code Samples

curl -XPOST "$HOST/api/PersonCommand/Classify" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"personReferenceId":"person-id","matchId":"7116f1a85030f2ed16d5d53224d772b9","aliasId":"5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81","classification":"FalsePositive"}'

request = {
  "personReferenceId": "person-id",
  "matchId": "7116f1a85030f2ed16d5d53224d772b9",
  "aliasId": "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
  "classification": "FalsePositive"
}

response = client.classify_person_hit(request)

let request = new ClassifyPersonHitCommand
{
  personReferenceId = "person-id",
  matchId = "7116f1a85030f2ed16d5d53224d772b9",
  aliasId = "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
  classification = ClassificationType.FalsePositive,
};

let response = await client.classifyPersonHit(request);

var request = new ClassifyPersonHitCommand
{
  PersonReferenceId = "person-id",
  MatchId = "7116f1a85030f2ed16d5d53224d772b9",
  AliasId = "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
  Classification = ClassificationType.FalsePositive,
};

var response = await client.ClassifyPersonHit(request);

ClassifyPersonHitCommand request = new ClassifyPersonHitCommand();
request.personReferenceId = "person-id";
request.matchId = "7116f1a85030f2ed16d5d53224d772b9";
request.aliasId = "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81";
request.classification = ClassificationType.FalsePositive;

ClassifyPersonHitResponse response = client.classifyPersonHit(request);

Successful response

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

Parameters

Name In Type Required Description
AliasId body string Yes
Classification body Classification type Yes
MatchId body string Yes
PersonReferenceId body string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Delete person

DELETE api/PersonCommand

Delete a person.

Code Samples

curl -XDELETE "$HOST/api/PersonCommand?personReferenceId=person-id" -H "Authorization: Bearer $JWT"

request = {
  "personReferenceId": "person-id"
}

response = client.delete_person(request)

let request = new DeletePersonCommand
{
  personReferenceId = "person-id",
};

let response = await client.deletePerson(request);

var request = new DeletePersonCommand
{
  PersonReferenceId = "person-id",
};

var response = await client.DeletePerson(request);

DeletePersonCommand request = new DeletePersonCommand();
request.personReferenceId = "person-id";

DeletePersonResponse response = client.deletePerson(request);

Successful response

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

Parameters

Name In Type Required Description
PersonReferenceId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Person query

Search person

GET api/PersonQuery/Search

Search for persons matchings specified criterias.

Code Samples

curl "$HOST/api/PersonQuery/Search?query=kennedy" -H "Authorization: Bearer $JWT"

request = {
  "query": "kennedy"
}

response = client.search_person(request)

let request = new PersonSearchQuery
{
  query = "kennedy",
};

let response = await client.searchPerson(request);

var request = new PersonSearchQuery
{
  Query = "kennedy",
};

var response = await client.SearchPerson(request);

PersonSearchQuery request = new PersonSearchQuery();
request.query = "kennedy";

PersonSearchQueryResult response = client.searchPerson(request);

Successful response

{
  "data": {
    "result": [
      {
        "personReferenceId": "JFK",
        "firstName": [
          {
            "text": "John",
            "isMatch": false
          }
        ],
        "lastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "isPep": true,
        "isRca": false,
        "isSanction": false,
        "identity": {
          "identity": "19870211",
          "country": "us"
        },
        "archived": false
      },
      {
        "personReferenceId": "person-id",
        "firstName": [
          {
            "text": "John",
            "isMatch": false
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "F",
            "isMatch": false
          }
        ],
        "lastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "isPep": false,
        "isRca": false,
        "isSanction": false,
        "identity": {
          "identity": null,
          "country": "us"
        },
        "archived": false
      },
      {
        "personReferenceId": "Jacqueline",
        "firstName": [
          {
            "text": "Jacqueline",
            "isMatch": false
          }
        ],
        "lastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "isPep": false,
        "isRca": true,
        "isSanction": false,
        "identity": {
          "identity": "19870211",
          "country": "us"
        },
        "archived": false
      }
    ]
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description
Filter query Filter No
Page query Page No
Query query string No

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data Person search response data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

View person

GET api/PersonQuery

View a specific person.

Code Samples

curl "$HOST/api/PersonQuery?personReferenceId=person-id" -H "Authorization: Bearer $JWT"

request = {
  "personReferenceId": "person-id"
}

response = client.view_person(request)

let request = new ViewPersonQuery
{
  personReferenceId = "person-id",
};

let response = await client.viewPerson(request);

var request = new ViewPersonQuery
{
  PersonReferenceId = "person-id",
};

var response = await client.ViewPerson(request);

ViewPersonQuery request = new ViewPersonQuery();
request.personReferenceId = "person-id";

ViewPersonQueryResult response = client.viewPerson(request);

Successful response

{
  "data": {
    "personReferenceId": "person-id",
    "identity": {
      "identity": null,
      "country": "us"
    },
    "firstName": "John F.",
    "lastName": "Kennedy",
    "birthdate": "????-??-??",
    "addresses": [],
    "hits": [
      [
        {
          "aliasId": "5e9642c5f7b00dcebc42098008fde48e28d7e30962d8b128f9a3bd7dab080b81",
          "referenceId": "person-id",
          "matchedFirstName": [
            {
              "text": "John",
              "isMatch": true
            },
            {
              "text": " ",
              "isMatch": false
            },
            {
              "text": "F",
              "isMatch": true
            },
            {
              "text": ".",
              "isMatch": false
            }
          ],
          "matchedLastName": [
            {
              "text": "Kennedy",
              "isMatch": true
            }
          ],
          "isSanction": false,
          "isPep": true,
          "isRca": false,
          "firstName": "John F.",
          "lastName": "Kennedy",
          "matchId": "7116f1a85030f2ed16d5d53224d772b9",
          "classification": "FalsePositive",
          "score": 1.0
        }
      ]
    ],
    "gender": "Unknown",
    "archived": false,
    "engagements": null,
    "isPep": false,
    "isRca": false,
    "isSanction": false,
    "birth": null,
    "highRiskCountry": false,
    "lastChanged": {
      "timestampUtc": "2020-10-14T15:02:51.806346Z",
      "checkpoint": "cab8d3371c9f7a9e3187a34e4f92b2569faf3b2ffbae5c481229fb7eaa4213de"
    }
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "cab8d3371c9f7a9e3187a34e4f92b2569faf3b2ffbae5c481229fb7eaa4213de"
}

Parameters

Name In Type Required Description
PersonReferenceId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data View person response data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Watchlist query

Watchlist company

GET api/WatchlistQuery/Company

View detailed information about the sanction matches.

Code Samples

curl "$HOST/api/WatchlistQuery/Company?matchId=c240d937a0e1635f222e3589b8760377&companyReferenceId=company-id" -H "Authorization: Bearer $JWT"

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

response = client.watchlist_company(request)

let request = new WatchlistCompanyQuery
{
  matchId = "c240d937a0e1635f222e3589b8760377",
  companyReferenceId = "company-id",
};

let response = await client.watchlistCompany(request);

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

var response = await client.WatchlistCompany(request);

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

WatchlistCompanyQueryResult response = client.watchlistCompany(request);

Successful response

{
  "data": {
    "listId": "c240d937a0e1635f222e3589b8760377",
    "isSanction": true,
    "names": [
      {
        "type": "Primary Name",
        "name": "Korea Daesong Bank",
        "selectedName": [
          {
            "text": "Korea",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Daesong",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Bank",
            "isMatch": true
          }
        ]
      }
    ],
    "sanctionLists": [
      "Pliance Demo List"
    ]
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description
CompanyReferenceId query string Yes
MatchId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data List company view model No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Watchlist person

GET api/WatchlistQuery

View detailed information about the PEP or sanction matches.

Code Samples

curl "$HOST/api/WatchlistQuery?id=7116f1a85030f2ed16d5d53224d772b9&firstName=John+F.&lastName=Kennedy" -H "Authorization: Bearer $JWT"

request = {
  "id": "7116f1a85030f2ed16d5d53224d772b9",
  "firstName": "John F.",
  "lastName": "Kennedy"
}

response = client.watchlist_person(request)

let request = new WatchlistQuery
{
  id = "7116f1a85030f2ed16d5d53224d772b9",
  firstName = "John F.",
  lastName = "Kennedy",
};

let response = await client.watchlistPerson(request);

var request = new WatchlistQuery
{
  Id = "7116f1a85030f2ed16d5d53224d772b9",
  FirstName = "John F.",
  LastName = "Kennedy",
};

var response = await client.WatchlistPerson(request);

WatchlistQuery request = new WatchlistQuery();
request.id = "7116f1a85030f2ed16d5d53224d772b9";
request.firstName = "John F.";
request.lastName = "Kennedy";

WatchlistQueryResult response = client.watchlistPerson(request);

Successful response

{
  "data": {
    "listId": "7116f1a85030f2ed16d5d53224d772b9",
    "nationalIdentificationNumber": "",
    "names": [
      {
        "firstName": "John Fitzgerald",
        "lastName": "Kennedy",
        "selectedFirstName": [
          {
            "text": "John",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Fitzgerald",
            "isMatch": false
          }
        ],
        "selectedLastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "type": "Primary Name"
      },
      {
        "firstName": "John F.",
        "lastName": "Kennedy",
        "selectedFirstName": [
          {
            "text": "John",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "F",
            "isMatch": true
          },
          {
            "text": ".",
            "isMatch": false
          }
        ],
        "selectedLastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "type": "Alias"
      }
    ],
    "birthdates": [
      {
        "circa": false,
        "year": 1917,
        "month": 5,
        "day": 29,
        "fromYear": 0,
        "toYear": 0,
        "type": "Date"
      }
    ],
    "addresses": [],
    "countries": [],
    "isPep": true,
    "isRca": false,
    "isSanction": false,
    "nationalities": [
      "us"
    ],
    "images": [
      "https://images.pliance.io/?url=https%3a%2f%2fupload.wikimedia.org%2fwikipedia%2fcommons%2fthumb%2fc%2fc3%2fJohn_F._Kennedy%252C_White_House_color_photo_portrait.jpg%2f440px-John_F._Kennedy%252C_White_House_color_photo_portrait.jpg"
    ],
    "roles": [
      {
        "description": "35th President of the United States",
        "isActive": false,
        "sinceYear": "1961",
        "sinceMonth": "1",
        "sinceDay": "20",
        "toYear": "1963",
        "toMonth": "11",
        "toDay": "22"
      }
    ],
    "relations": [
      {
        "firstName": "Jacqueline Lee",
        "lastName": "Kennedy Onassis",
        "relationPersonId": "b8a437075479e71d102754462745f2ec",
        "isPep": false,
        "isRca": true,
        "isSanction": false,
        "relationType": "Wife"
      }
    ],
    "gender": "Male",
    "lists": [
      "Pliance Demo List"
    ],
    "active": false,
    "deceased": true
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description
FirstName query string Yes
Id query string Yes
LastName query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data List person view model No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

WatchlistPerson v2

GET api/WatchlistQuery/v2

View detailed information about the PEP or sanction matches.

Code Samples

curl "$HOST/api/WatchlistQuery/v2?matchId=7116f1a85030f2ed16d5d53224d772b9&personReferenceId=person-id" -H "Authorization: Bearer $JWT"

request = {
  "matchId": "7116f1a85030f2ed16d5d53224d772b9",
  "personReferenceId": "person-id"
}

response = client.watchlist_person_v2(request)

let request = new WatchlistQuery_v2
{
  matchId = "7116f1a85030f2ed16d5d53224d772b9",
  personReferenceId = "person-id",
};

let response = await client.watchlistPersonV2(request);

var request = new WatchlistQuery_v2
{
  MatchId = "7116f1a85030f2ed16d5d53224d772b9",
  PersonReferenceId = "person-id",
};

var response = await client.WatchlistPersonV2(request);

WatchlistQuery_v2 request = new WatchlistQuery_v2();
request.matchId = "7116f1a85030f2ed16d5d53224d772b9";
request.personReferenceId = "person-id";

WatchlistQueryResultV2 response = client.watchlistPersonV2(request);

Successful response

{
  "data": {
    "listId": "7116f1a85030f2ed16d5d53224d772b9",
    "nationalIdentificationNumber": "",
    "names": [
      {
        "firstName": "John Fitzgerald",
        "lastName": "Kennedy",
        "selectedFirstName": [
          {
            "text": "John",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "Fitzgerald",
            "isMatch": false
          }
        ],
        "selectedLastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "type": "Primary Name"
      },
      {
        "firstName": "John F.",
        "lastName": "Kennedy",
        "selectedFirstName": [
          {
            "text": "John",
            "isMatch": true
          },
          {
            "text": " ",
            "isMatch": false
          },
          {
            "text": "F",
            "isMatch": true
          },
          {
            "text": ".",
            "isMatch": false
          }
        ],
        "selectedLastName": [
          {
            "text": "Kennedy",
            "isMatch": true
          }
        ],
        "type": "Alias"
      }
    ],
    "birthdates": [
      {
        "circa": false,
        "year": 1917,
        "month": 5,
        "day": 29,
        "fromYear": 0,
        "toYear": 0,
        "type": "Date"
      }
    ],
    "addresses": [],
    "countries": [],
    "isPep": true,
    "isRca": false,
    "isSanction": false,
    "nationalities": [
      "us"
    ],
    "images": [
      "https://images.pliance.io/?url=https%3a%2f%2fupload.wikimedia.org%2fwikipedia%2fcommons%2fthumb%2fc%2fc3%2fJohn_F._Kennedy%252C_White_House_color_photo_portrait.jpg%2f440px-John_F._Kennedy%252C_White_House_color_photo_portrait.jpg"
    ],
    "roles": [
      {
        "description": "35th President of the United States",
        "isActive": false,
        "sinceYear": "1961",
        "sinceMonth": "1",
        "sinceDay": "20",
        "toYear": "1963",
        "toMonth": "11",
        "toDay": "22"
      }
    ],
    "relations": [
      {
        "firstName": "Jacqueline Lee",
        "lastName": "Kennedy Onassis",
        "relationPersonId": "b8a437075479e71d102754462745f2ec",
        "isPep": false,
        "isRca": true,
        "isSanction": false,
        "relationType": "Wife"
      }
    ],
    "gender": "Male",
    "lists": [
      "Pliance Demo List"
    ],
    "active": false,
    "deceased": true
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description
MatchId query string Yes
PersonReferenceId query string Yes

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data List person view model No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Webhook command

Save webhook

PUT api/WebhookCommand

Change webhook settings.

Code Samples

curl -XPUT "$HOST/api/WebhookCommand" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d '{"url":"https://webhook.pliance.io","secret":"031356FD-0686-4164-89F9-632882700679","enabled":true}'

request = {
  "url": "https://webhook.pliance.io",
  "secret": "031356FD-0686-4164-89F9-632882700679",
  "enabled": True
}

response = client.save_webhook(request)

let request = new WebhookUpdateCommand
{
  url = "https://webhook.pliance.io",
  secret = "031356FD-0686-4164-89F9-632882700679",
  enabled = true,
};

let response = await client.saveWebhook(request);

var request = new WebhookUpdateCommand
{
  Url = "https://webhook.pliance.io",
  Secret = "031356FD-0686-4164-89F9-632882700679",
  Enabled = true,
};

var response = await client.SaveWebhook(request);

WebhookUpdateCommand request = new WebhookUpdateCommand();
request.url = "https://webhook.pliance.io";
request.secret = "031356FD-0686-4164-89F9-632882700679";
request.enabled = true;

WebhookUpdateResponse response = client.saveWebhook(request);

Successful response

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

Parameters

Name In Type Required Description
Enabled body boolean No
Secret body string No
Url body string No

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Webhook query

Get webhook

GET api/WebhookQuery

View current webhook settings.

Code Samples

curl "$HOST/api/WebhookQuery" -H "Authorization: Bearer $JWT"

request = {}

response = client.get_webhook(request)

let request = new WebhookQuery
{
};

let response = await client.getWebhook(request);

var request = new WebhookQuery
{
};

var response = await client.GetWebhook(request);

WebhookQuery request = new WebhookQuery();

WebhookQueryResult response = client.getWebhook(request);

Successful response

{
  "data": {
    "url": "https://webhook.pliance.io",
    "secret": "031356FD-0686-4164-89F9-632882700679",
    "enabled": true
  },
  "status": "Success",
  "success": true,
  "message": null,
  "checkpoint": "0000000000000000000000000000000000000000000000000000000000000000"
}

Parameters

Name In Type Required Description

Response

Name Type Required Restrictions Description
Checkpoint string No None Latest recorded checksum on the block chain
Data Webhook query result data No None
Message string No None Error message
Status Response status No None
Success boolean No None True if call executed without errors

Search Options

Fuzziness

Simple

Names are compared using insensitive string comparison.

Metaphone

Names are compared using the phonetic algorithm Metaphone, allows for fuzzy matching on how the names sound.

Order

Any

The names can be found anywhere in the watch list name.

Any

Strict

The order of the names have to match the watch list name.

Strict

Exact

The amount of names and order have to exactly match the watch list name.

Exact

Schemas

Address

Name Type Required Restrictions Description
City string None
Country string None
PostalCode string None
Street1 string None
Street2 string None
StreetNo string None

Birthdate

Name Type Required Restrictions Description
Day int32 None
Month int32 None
Year int32 None

Birth match type

Value Description
Date
Range

Classification type

Value Description
Unknown
FalsePositive
Match

Company hit

Name Type Required Restrictions Description
AliasId string None
Classification Classification type None
IsSanction boolean None
MatchedName [Text match] None
MatchId string None
Name string None
Score number None

Company identity

Name Type Required Restrictions Description
Country string None
Identity string None

Company search response data

Name Type Required Restrictions Description
Result [Company search result] None

Company search result

Name Type Required Restrictions Description
Archived boolean None
CompanyReferenceId string None
Identity Company identity None
IsPep boolean None
IsRca boolean None
IsSanction boolean None
Name [Text match] None

Engagement model

Name Type Required Restrictions Description
Name string None
RegistrationNumber string None

Feed query item

Name Type Required Restrictions Description
Body object None
Checkpoint string None
Metadata object None
Type string None

Feed query result data

Name Type Required Restrictions Description
Items [Feed query item] None

Filter

Name Type Required Restrictions Description
IsPep boolean None
IsRca boolean None
IsSanction boolean None

Fuzziness

Value Description
Metaphone
Simple

Gender

Value Description
Unknown
Male
Female

Last changed

Name Type Required Restrictions Description
Checkpoint string None
TimestampUtc date-time None
Name Type Required Restrictions Description
Hits object None
Name string None

List address

Name Type Required Restrictions Description
City string None
Country string None
PostalCode string None
Street1 string None
Street2 string None
StreetNo string None

List birthdate

Name Type Required Restrictions Description
Circa boolean None
Day int32 None
FromYear int32 None
Month int32 None
ToYear int32 None
Type Birth match type None
Year int32 None

List company name view model

Name Type Required Restrictions Description
Name string None
SelectedName [Text match] None
Type string None

List company view model

Name Type Required Restrictions Description
IsSanction boolean None
ListId string None
Names [List company name view model] None
SanctionLists [string] None

List person name view model

Name Type Required Restrictions Description
FirstName string None
LastName string None
SelectedFirstName [Text match] None
SelectedLastName [Text match] None
Type string None

List person view model

Name Type Required Restrictions Description
Active boolean None
Addresses [List address] None
Birthdates [List birthdate] None
Countries [string] None
Deceased boolean None
Gender Gender None
Images [string] None List of URL:s to images of the induvidual
IsPep boolean None Is a political exposed person
IsRca boolean None Is a relatives and close associates of a PEP
IsSanction boolean None Typically a ban on trade
ListId string None
Lists [string] None
Names [List person name view model] None
NationalIdentificationNumber string None
Nationalities [string] None
Relations [List relation view model] None
Roles [List role] None

List relation view model

Name Type Required Restrictions Description
FirstName string None
IsPep boolean None
IsRca boolean None
IsSanction boolean None
LastName string None
RelationPersonId string None
RelationType string None

List role

Name Type Required Restrictions Description
Description string None
IsActive boolean None
SinceDay string None
SinceMonth string None
SinceYear string None
ToDay string None
ToMonth string None
ToYear string None

Order

Value Description
Any
Strict
Exact

Page

Name Type Required Restrictions Description
No int32 None
Size int32 None

Person details hit model

Name Type Required Restrictions Description
AliasId string None
Classification Classification type None
FirstName string None
IsPep boolean None
IsRca boolean None
IsSanction boolean None
LastName string None
MatchedFirstName [Text match] None
MatchedLastName [Text match] None
MatchId string None
ReferenceId string None
Score number None Score is a combination of fuzziness, and how different the matches are from each other. Currently how many add/remove/changes you have to make for one name to turn into the other, and then a progressive gradient. Range from 0.00-1.00.

Person identity

Name Type Required Restrictions Description
Country string None
Identity string None

Person report

Name Type Required Restrictions Description
Country string None
LegalPersons [Legal person] None
Persons object None

Person search response data

Name Type Required Restrictions Description
Result [Person search result] None

Person search result

Name Type Required Restrictions Description
Archived boolean None
FirstName [Text match] None
Identity Person identity None
IsPep boolean None
IsRca boolean None
IsSanction boolean None
LastName [Text match] None
PersonReferenceId string None

Register company options

Name Type Required Restrictions Description
Fuzziness Fuzziness None Fuzzy algorithm for the matching engine (default is 'Metaphone').
OmitResult boolean None Omits the screening result from the response (Performance optimization when importing).
Order Order None Order algorithm for the matching engine.

Register person options

Name Type Required Restrictions Description
Fuzziness Fuzziness None Fuzzy algorithm for the matching engine (default is 'Metaphone').
OmitResult boolean None Omits the screening result from the response (Performance optimization when importing).
Order Order None Order algorithm for the matching engine.
PepCountries [string] None Override the default country that is used to resolve the watch list with a list of countries. By default Pliance is using the country that is set in identity. Can be used to search in more countries watch lists.

Response status

Value Description
Success
Error

Text match

Name Type Required Restrictions Description
IsMatch boolean None
Text string None

View company response data

Name Type Required Restrictions Description
Archived boolean None
Beneficiaries [View person response data] None
CompanyReferenceId string None
CorporateForm string None
Description string None
HighRiskCountry boolean None
Hits [[Company hit]] None
Identity Company identity None
IsSanction boolean None
LastChanged Last changed None
Name string None
RegistrationDate date-time None
Representatives [View person response data] None

View person response data

Name Type Required Restrictions Description
Addresses [Address] None
Archived boolean None
Birth Birthdate None
Birthdate string None
Engagements [Engagement model] None
FirstName string None
Gender Gender None
HighRiskCountry boolean None The person is registered in a high risk country. According to EU/19/781.
Hits [[Person details hit model]] None List of PEP and Sanction hits (grouped by MatchId).
Identity Person identity None
IsPep boolean None
IsRca boolean None
IsSanction boolean None
LastChanged Last changed None
LastName string None
PersonReferenceId string None

Webhook query result data

Name Type Required Restrictions Description
Enabled boolean None
Secret string None
Url string None
C# cURL Java JavaScript Python