NAV Navbar
C#cURLJavaJavaScriptPython

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"}
PropertyMeaningDescription
iatIssued AtWhen the token was generated
nbfNot BeforeToken can't be used before
expExpiration TimeToken can't be used after
audAudienceThe recipient of the token, always pliance.io
issIssuerThe one who is issuing the token, your company name
given_nameUsernameName of the user or system consuming the service
subUserIdUserId of the user or system consuming the server

Ping

GET /api/Ping

Test the accessable of service without mutating the system.

Code samples

varfactory=newPlianceClientFactory(secret:"2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b",issuer:"Test",url:"https://test-stage4.pliance.io/",certificate:newX509Certificate2("client-certificate.pfx"));varclient=factory.Create("givenname","sub");awaitclient.Ping();

Successful response

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

Person

Register Person

PUT /api/PersonCommand

Create or update a person.

Code samples

varresult=awaitclient.RegisterPerson(newRegisterPersonCommand{PersonReferenceId="customer/2",FirstName="Osama",LastName="bin Laden"});

Successful response

{"hits":[[{"matchId":"listperson/1","matchedFirstName":[{"text":"Osama","isMatch":true},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Mohammed","isMatch":false},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Awad","isMatch":false}],"matchedLastName":[{"text":"bin","isMatch":true},{"text":" ","isMatch":false},{"text":"Laden","isMatch":true}],"isPep":false,"isRca":false,"isSanction":true,"firstName":"Osama bin Mohammed bin Awad","lastName":"bin Laden","classification":"Unknown","aliasId":"4ec8702f61e1b5d5d8edfb9d6fc84edb0ced4bbb01490a93e1636e4c546ab24a"}]],"data":{"personReferenceId":"customer/2","identity":null,"firstName":"Osama","lastName":"bin Laden","birthdate":"????-??-??","addresses":null,"hits":[[{"matchId":"EuSanction-833","matchedFirstName":[{"text":"Osama","isMatch":true},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Muhammad","isMatch":false},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Awad","isMatch":false}],"matchedLastName":[{"text":"bin","isMatch":true},{"text":" ","isMatch":false},{"text":"Ladin","isMatch":true}],"birthdate":null,"isPep":false,"isRca":false,"isSanction":true,"firstName":"Osama bin Muhammad bin Awad","lastName":"bin Ladin","classification":"Unknown","aliasId":"a1be37af314c0cc35c5f9f4124f5f6aa0c050fbe5846e020ae17c0fe02c8c55e"}]],"gender":"Unknown","archived":false,"engagements":null,"isPep":false,"isRca":false,"isSanction":true,"birth":null,"highRiskCountry":false,"lastChanged":{"timestampUtc":"2019-12-06T13:10:00.445Z","checkpoint":"63f3946136274e103e0439930acb234acb3e2f4a43b6092bde3a5b3a70162086"}},"status":"Success","success":true,"checkpoint":"281c38013e31ac86a96b20a3098647ebc42e02c17351009a663fdef0714ced36"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdbodystringYesNone
IdentitybodyPerson IdentityNoNone
FirstNamebodystringYesNone
LastNamebodystringYesNone
GenderbodyGenderNoNone
BirthdatebodyBirthdateNoNone
Addressesbody[Address]NoNone
OptionsbodyRegister Person OptionsNoNone

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
Hits[[Person Hit]]NoNone
DataView Person Response DataNoNone

The register person endpoint allows a person to be registered for PEP and Sanction screening, and automatic monitoring. This is the first step in the the process. It also returns all the hits.

View Person

GET /api/PersonQuery

View a specific person.

Code samples

varresult=awaitclient.ViewPerson(newViewPersonQuery{PersonReferenceId="customer/1"});

Successful response

{"data":{"personReferenceId":"customer/2","identity":null,"firstName":"Osama","lastName":"bin Laden","birthdate":"????-??-??","addresses":null,"hits":[[{"matchId":"EuSanction-833","matchedFirstName":[{"text":"Osama","isMatch":true},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Muhammad","isMatch":false},{"text":" ","isMatch":false},{"text":"bin","isMatch":false},{"text":" ","isMatch":false},{"text":"Awad","isMatch":false}],"matchedLastName":[{"text":"bin","isMatch":true},{"text":" ","isMatch":false},{"text":"Ladin","isMatch":true}],"birthdate":null,"isPep":false,"isRca":false,"isSanction":true,"firstName":"Osama bin Muhammad bin Awad","lastName":"bin Ladin","classification":"Unknown","aliasId":"a1be37af314c0cc35c5f9f4124f5f6aa0c050fbe5846e020ae17c0fe02c8c55e"}]],"gender":"Unknown","archived":false,"engagements":null,"isPep":false,"isRca":false,"isSanction":true,"birth":null,"highRiskCountry":false,"lastChanged":{"timestampUtc":"2019-12-06T13:10:00.445Z","checkpoint":"63f3946136274e103e0439930acb234acb3e2f4a43b6092bde3a5b3a70162086"}},"status":"Success","success":true,"message":null,"checkpoint":"63f3946136274e103e0439930acb234acb3e2f4a43b6092bde3a5b3a70162086"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataView Person Response DataNoNone

Search Person

GET /api/PersonQuery/Search

Search for persons matchings specified criterias.

Code samples

varresult=awaitclient.SearchPerson(newPersonSearchQuery{Query="Donald"});

Successful response

{"data":{"result":[{"personReferenceId":"customer/1","firstName":[{"text":"Donald","isMatch":true}],"lastName":[{"text":"Trump","isMatch":false}],"isPep":true,"isRca":false,"isSanction":false,"identity":{"identity":"ce2e5f62-0b2e-4337-b3e9-86b6d9aa72af","country":"us"},"archived":false}]},"status":"Success","success":true,"checkpoint":"d5fa033e8605a8dffa8ee60fd9e6c3740a570e59853c08e1efe1a4925fef0013"}

Parameters

NameInTypeRequiredDescription
QuerypathstringNo
PagepathPageNo
FilterpathFilterNo

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataSearch Person Response DataNoNone

Classify Match

POST /api/PersonCommand/Classify

Classify a match as either Unknown, Match or FalsePositive.

Code samples

varresult=awaitclient.ClassifyPersonHit(newClassifyPersonHitCommand{PersonReferenceId="customer/1",MatchId="listperson/2",AliasId="9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4",Classification=ClassificationType.Positive});

Successful response

{"status":"Success","success":true,"checkpoint":"d485f2df3233c21da4db73d1b10b23aca5f2c5e5077d22e2e573ec048f5a678b"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdbodystringYes
MatchIdbodystringYes
AliasIdbodystringYes
ClassificationbodystringYesUnknown/Match/FalsePositive

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Archive a person

POST /api/PersonCommand/Archive

Archive a person.

Code Samples

varresult=awaitclient.ArchivePerson(newArchivePersonCommand{PersonReferenceId="customer/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"c7076b02156ffa8a17be80bd28127d73f955508051f6423d71d37723fd87e80a"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdbodystringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Unarchive a person

POST /api/PersonCommand/Unarchive

Unarchive a person.

Code samples

varresult=awaitclient.UnarchivePerson(newUnarchivePersonCommand{PersonReferenceId="customer/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"ce83babdc590a2c2ded1c6096dd90cb0b1cac641831d8dda64c28aada095d0ef"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdbodystringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Delete Person

DELETE /api/PersonCommand

Delete a person.

Code samples

varresult=awaitclient.DeletePerson(newDeletePersonCommand{PersonReferenceId="customer/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"6c269818fcc8834b2fcf44e71b0757bdae0259f570078b95b2f7078e3ce9ecd6"}

Parameters

NameInTypeRequiredDescription
PersonReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Company

Register Company

PUT /api/CompanyCommand

Create or update a company.

Code samples

varresult=awaitclient.RegisterCompany(newRegisterCompanyCommand{CompanyReferenceId="company/1",Name="Plisec AB",Identity=newCompanyIdentity{Identity="559161-4275",Country="SE"}});

Successful response

{"data":{"companyReferenceId":"company/1","identity":{"identity":"559161-4275","country":"SE"},"name":"Plisec AB","graph":{"nodes":[],"links":[]},"beneficiaries":[],"archived":false},"status":"Success","success":true,"message":null,"checkpoint":"6c269818fcc8834b2fcf44e71b0757bdae0259f570078b95b2f7078e3ce9ecd6"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdbodystringYes
NamebodystringYes
IdentitybodyCompany IdentityYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataView Company Response DataNoNone

View Company

GET /api/CompanyQuery

View a specific company.

Code samples

varresult=awaitclient.ViewCompany(newViewCompanyQuery{CompanyReferenceId="company/1"});

Successful response

{"data":{"companyReferenceId":"company/1","identity":{"identity":"559161-4275","country":"SE"},"name":"Plisec AB","graph":{"nodes":[],"links":[]},"beneficiaries":[],"archived":false,"highRiskCountry":false,"lastChanged":{"timestampUtc":"2019-12-06T13:18:57.03Z","checkpoint":"6d6ade0ce1e55344b774702e4ac19ba87704a4f2c9725ba4ca2d2f65d4f80363"}},"status":"Success","success":true,"message":null,"checkpoint":"6d6ade0ce1e55344b774702e4ac19ba87704a4f2c9725ba4ca2d2f65d4f80363"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataView Company Response DataNoNone

Search Company

GET /api/CompanyQuery/Search

Search for companies matchings specified criterias.

Code samples

varresult=awaitclient.SearchCompany(newCompanySearchQuery{Query="Plisec"});

Successful response

{"data":{"result":[{"companyReferenceId":"company/1","name":[{"text":"Plisec","isMatch":false},{"text":" ","isMatch":false},{"text":"AB","isMatch":false}],"isPep":false,"isRca":false,"isSanction":false,"identity":{"identity":"559161-4275","country":"SE"},"archived":false}]},"status":"Success","success":true,"message":null,"checkpoint":"0000000000000000000000000000000000000000000000000000000000000000"}

Parameters

NameInTypeRequiredDescription
QuerypathstringNo
PagepathPageNo
FilterpathFilterNo

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataSearch Company Response DataNoNone

Classify Match

POST /api/CompanyCommand/Classify

Classify a match as either Unknown, Match or FalsePositive.

Code samples

varresult=awaitclient.ClassifyCompanyHit(newClassifyCompanyHitCommand{CompanyReferenceId="customer/1",MatchId="listperson/2",AliasId="9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4",Classification=ClassificationType.Positive});

Successful response

{"status":"Success","success":true,"checkpoint":"d485f2df3233c21da4db73d1b10b23aca5f2c5e5077d22e2e573ec048f5a678b"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdbodystringYes
MatchIdbodystringYes
AliasIdbodystringYes
ClassificationbodystringYesUnknown/Match/FalsePositive

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Archive Company

POST /api/CompanyCommand/Archive

Archive a company.

Code samples

varresult=awaitclient.ArchiveCompany(newArchiveCompanyCommand{CompanyReferenceId="company/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"6c269818fcc8834b2fcf44e71b0757bdae0259f570078b95b2f7078e3ce9ecd6"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdbodystringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Unarchive Company

POST /api/CompanyCommand/Unarchive

Unarchive a company.

Code samples

varresult=awaitclient.UnarchiveCompany(newUnarchiveCompanyCommand{CompanyReferenceId="company/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"6c269818fcc8834b2fcf44e71b0757bdae0259f570078b95b2f7078e3ce9ecd6"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdbodystringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Delete Company

DELETE /api/CompanyCommand

Delete a company.

Code samples

varresult=awaitclient.DeleteCompany(newDeleteCompanyCommand{CompanyReferenceId="company/1"});

Successful response

{"status":"Success","success":true,"checkpoint":"6c269818fcc8834b2fcf44e71b0757bdae0259f570078b95b2f7078e3ce9ecd6"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Beneficiaries Graph

GET /api/CompanyQuery/Graph/Beneficiaries

View a D3 graph of the company structure.

Code samples

Successful response

{"data":{"nodes":[{"id":0,"name":"Plisec AB","type":"Plisec AB","reference":"559161-4275","isPep":false},{"id":1,"name":"Isaks Erik Tomas Einarsson","type":"Person","reference":"19840626-****","isPep":false},{"id":2,"name":"We Go To Eleven AB","type":"Company","reference":"559118-2901","isPep":false},{"id":3,"name":"Adam Lars Sebastian Fürtenbach","type":"Person","reference":"19840525-****","isPep":false},{"id":4,"name":"Siam Rakib Choudhury","type":"Person","reference":"19840718-****","isPep":false}],"links":[{"source":1,"target":2,"type":"Huvudman"},{"source":0,"target":2,"type":"Moderbolag"},{"source":3,"target":2,"type":"Huvudman"},{"source":4,"target":0,"type":"Huvudman"}]},"status":"Success","success":true,"message":null,"checkpoint":"72f997cf7a59a70989d1afbcd255eff9df64efe4a62bf2d93dfb19edb44b2ebd"}

Parameters

NameInTypeRequiredDescription
CompanyReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
Data[Graph Beneficiaries]NoNone@todo

Watchlist

Retrieve Person

GET /api/WatchlistQuery

View detailed information about the PEP or sanction matches.

Code samples

Successful response

{}

Parameters

NameInTypeRequiredDescription
IdpathstringYes
FirstNamepathstringYes
LastNamepathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataWatchlist Response DataNoNone

Retrieve Person (v2)

GET /api/WatchlistQuery/v2

View detailed information about the PEP or sanction matches.

Code samples

Successful response

{}

Parameters

NameInTypeRequiredDescription
MatchIdpathstringYes
PersonReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataWatchlist Response DataNoNone

Retrieve Company

GET /api/WatchlistQuery/Company

View detailed information about the PEP or sanction matches.

Code samples

Successful response

{}

Parameters

NameInTypeRequiredDescription
MatchIdpathstringYes
CompanyReferenceIdpathstringYes

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataWatchlist Company Response DataNoNone

Webhook

Overview

Daily monitoring automatically matches your customers to PEP(Political Exposed Person) and sanction lists. When matches are found you can use webhooks to receive notification when changes have occured.

Change Settings

PUT /api/WebhookCommand

Change webhook settings.

Code samples

Successful response

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

Parameters

NameInTypeRequiredDescription
UrlbodystringNoNone
SecretbodystringNoNone
EnabledbodybooleanNoNone

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone

Query Settings

GET /api/WebhookQuery

View current webhook settings.

Code samples

Successful response

{"data":{"url":"https://secure.pliance.io/webhook","secret":"COMPANY_SECRET","enabled":true},"status":"Success","success":true,"message":null,"checkpoint":"0000000000000000000000000000000000000000000000000000000000000000"}

Parameters

None

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataWebhook ResponseNoNone

Feed

Overview

The feed endpoint lets you retreive all data from a certain checkpoint and a batch of the proceeding events. To fetch the next batch, use the latest value of data.items[].checkpoint. In the example below, you should use /api/FeedQuery/?From=05f1d630986abbb3fb11687e23defba5958b51fb01d5b68f2c3e07d37fb98270. Omiting the From parameter, selects data from the beginning.

Query Feed

GET /api/FeedQuery

View the feed from the given checkpoint.

Code samples

await_client.Feed(newFeedQuery());

Successful response

{"data":{"items":[{"checkpoint":"c0c8b882e5e0efae965f21b1a87ab640c2fa2b561ed90e9312213626cef8be11","type":"PersonSanctionMatched","body":{"aliasId":"b7f6645e75b1ebe84619a31efaea8c8802705e1fba382640d5a3c232f233a125","matchId":"listperson/1","personReferenceId":"customer/2","matchedFirstName":[{"text":"Osama","isMatch":true}],"matchedLastName":[{"text":"bin","isMatch":true},{"text":" ","isMatch":false},{"text":"Laden","isMatch":true}],"isPep":false,"isRca":false,"isSanction":true,"firstName":"Osama","lastName":"bin laden"},"metadata":{"subject":"-1","ip":"localhost","givenName":"SYSTEM","timestampUtc":"2019-12-06T07:16:50.1684424Z"}}]},"status":"Success","success":true,"message":null,"checkpoint":"0000000000000000000000000000000000000000000000000000000000000000"}

Parameters

NameInTypeRequiredDescription
FrompathstringNoNone

Responses

NameTypeRequiredRestrictionsDescription
StatusstringYesNoneSuccess/Error
SuccessbooleanYesNone
MessagestringNoNoneError message
CheckpointstringNoNone
DataFeed Response DataNoNone

Schemas

Person Identity

NameTypeRequiredRestrictionsDescription
IdentitystringNoNoneNational identity number
CountrystringNoNoneIssuing Country, ISO3166

Company Identity

NameTypeRequiredRestrictionsDescription
IdentitystringNoNoneNational identity number
CountrystringNoNoneIssuing Country, ISO3166

Address

NameTypeRequiredRestrictionsDescription
Street1stringNoNone
Street2stringNoNone
CitystringNoNone
StreetNostringNoNone
PostalCodestringNoNone
CountrystringNoNone

Birthdate

NameTypeRequiredRestrictionsDescription
YearintegerNoNoneBirth year
MonthintegerNoNoneBirth month
DayintegerNoNoneBirth day of month

Register Person Options

NameTypeRequiredRestrictionsDescription
OrderstringNoNoneAny/Strict/Exact
FuzzinessstringNoNoneSimple/Diacritics/Metaphone
OmitResultbooleanNoNone

Text Match

NameTypeRequiredRestrictionsDescription
TextstringYesNone
IsMatchbooleanYesNone

Person Hit

NameTypeRequiredRestrictionsDescription
MatchIdstringYesNone
MatchedFirstName[Text Match]NoNone
MatchedLastName[Text Match]NoNone
IsPepbooleanNoNone
IsRcabooleanNoNone
IsSanctionbooleanNoNone
FirstNamestringYesNone
LastNamestringYesNone
ClassificationstringYesNoneUnknown/FalsePositive/Match
AliasIdstringYesNone

View Person Response Data

NameTypeRequiredRestrictionsDescription
PersonReferenceIdstringYesNone
IdentityPerson IdentityNoNone
FirstNamestringYesNone
LastNamestringYesNone
BirthdatestringNoNoneyyyy-mm-dd
Addresses[Address]NoNone
Hits[[Person Hit]]NoNone
GenderGenderNoNoneFemale/Male/Unknown
ArchivedbooleanNoNone
Engagements[Engagement]NoNone
IsPepbooleanNoNone
IsRcabooleanNoNone
IsSanctionbooleanNoNone
BirthBirthdateNoNone
HighRiskCountrybooleanNoNone
LastChangedLast ChangedNoNone

Last Changed

NameTypeRequiredRestrictionsDescription
TimestampUtcdateYesNone
CheckpointstringYesNone

Engagements

NameTypeRequiredRestrictionsDescription
RegistrationNumberstringYesNone
NamestringYesNone

Page

NameTypeRequiredRestrictionsDescription
SizeintegerNoNone
NointegerNoNone

Filter

NameTypeRequiredRestrictionsDescription
IsPepintegerNoNone
IsRcaintegerNoNone
IsSanctionintegerNoNone

Search Person Response Data

NameTypeRequiredRestrictionsDescription
Result[Search Person Response Data Result]YesNone

Search Person Response Data Result

NameTypeRequiredRestrictionsDescription
PersonReferenceIdstringNoNone
FirstName[Text Match]NoNone
LastName[Text Match]NoNone
IsPepbooleanNoNone
IsRcabooleanNoNone
IsSanctionbooleanNoNone
IdentityPerson IdentityNoNone
ArchivedbooleanNoNone

Role

NameTypeRequiredRestrictionsDescription
DescriptionstringNoNone
IsActivebooleanNoNone
SinceYearstringNoNone
SinceMonthstringNoNone
SinceDaystringNoNone
ToYearstringNoNone
ToMonthstringNoNone
ToDaystringNoNone

Watchlist Response Data

NameTypeRequiredRestrictionsDescription
ListIdstringYesNone
NationalIdentificationNumberstringYesNone
Countries[string]YesNone
IsPepbooleanYesNone
IsRcabooleanYesNone
IsSanctionbooleanYesNone
GenderGenderNoNoneFemale/Male/Unknown
Nationalities[string]YesNone
Images[string]YesNone
Lists[string]YesNone
RolesRoleYesNone
Names[Names]NoNone@todo
Birthdates[Birthdate]NoNone@todo
Addresses[Address]NoNone@todo
Relations[Relation]NoNone@todo

Watchlist Company Response Data

NameTypeRequiredRestrictionsDescription
CompanyReferenceIdstringNoNone
IsSanctionbooleanNoNone
Names[Watchlist Company Name]YesNone
SanctionLists[string]NoNone

Watchlist Company Name

NameTypeRequiredRestrictionsDescription
TypestringNoNone
NamestringNoNone
SelectedName[TextMatch]YesNone

Webhook Response

NameTypeRequiredRestrictionsDescription
UrlstringNoNone
SecretstringNoNone
EnabledbooleanNoNone

Feed Response Data

NameTypeRequiredRestrictionsDescription
Items[Feed Response Data Item]YesNone

Feed Response Data Item

NameTypeRequiredRestrictionsDescription
CheckpointstringNoNone
TypestringNoNone
BodyobjectNoNone
Metadata[Metadata]YesNone

Metadata

NameTypeRequiredRestrictionsDescription
SubjectstringNoNone
IPstringNoNone
GivenNamestringNoNone
TimestampUtcdateNoNone

View Company Response Data

NameTypeRequiredRestrictionsDescription
CompanyReferenceIdstringNoNone
NamestringNoNone
IdentityCompany IdentityNoNone
ArchivedbooleanNoNone
HighRiskCountrybooleanNoNone
LastChangedLast ChangedNoNone
Beneficiaries[View Person Response Data]NoNone
Hits[Company Hit]NoNone

Company Hit

NameTypeRequiredRestrictionsDescription
MatchIdstringYesNone
Name[Text Match]NoNone
IsSanctionbooleanNoNone
NamestringYesNone
ClassificationstringYesNoneUnknown/FalsePositive/Match
AliasIdstringYesNone

Search Company Response Data

NameTypeRequiredRestrictionsDescription
Result[Search Company Response Data Result]YesNone

Search Company Response Data Result

NameTypeRequiredRestrictionsDescription
CompanyReferenceIdstringNoNone
Name[Text Match]NoNone
IdentityCompany IdentityNoNone
IsPepbooleanNoNone
IsRcabooleanNoNone
IsSanctionbooleanNoNone
ArchivedbooleanNoNone

Order

Any

All input words have to be present in the current match regardless of position.

Any

Strict

All input words have to be present in the current match, it must follow the same succession order.

Strict

Exact

Input has to match word by word to the current match.

Exact

Fuzziness

Simple

Simple incasesensitive matching.

Simple

Diacritics

Incasesensitive matching with diacritics removed.

Diacritics

Metaphone

Words that phoneticly sounds the same are treated as the same.

Metaphone