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

Source code

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

Java

Installation

Source code

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

Node.js

Installation

npm i @pliance/pliance.js.sdk

Source code

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

Python

Installation

pip install pliance.py.sdk

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"}

Ping

GET /api/Ping

Test the accessable of service without mutating the system.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET /api/ping 

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

FileInputStreamcertificate=newFileInputStream(newFile("client-certificate.pfx"));PlianceClientFactoryfactory=newPlianceClientFactory("2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b","Test","https://test-stage4.pliance.io/",certificate);IPlianceClientclient=factory.create("givenname","subject");PingResponseresponse=client.ping();

const{ClientFactory}=require("@pliance/pliance.js.sdk");consthttps=require('https');constfs=require('fs');letagent=newhttps.Agent({pfx:fs.readFileSync('client-certificate.pfx'),passphrase:''});letclientFactory=newClientFactory('2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b','Test','https://test-stage4.pliance.io/',agent);letclient=clientFactory.create('givenname','sub');letres=awaitclient.ping();

frompliance_py_sdkimportClientFactoryclientFactory=ClientFactory('2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b','Test','https://test-stage4.pliance.io/',cert='client-certificate.pem')client=clientFactory.create('givenname','sub')res=client.ping()

Successful response

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

Person

Register Person

PUT /api/PersonCommand

Create or update a person.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPUT "https://test-stage3.pliance.io/api/PersonCommand" -d '{ "PersonReferenceId": "customer/2", "Firstname": "Osama", "Lastname": "bin Laden" }'

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

RegisterPersonCommandcommand=newRegisterPersonCommand();command.personReferenceId="customer/2";command.firstName="Osama";command.lastName="bin Laden";RegisterPersonResponseresponse=client.registerPerson(command);

letperson={firstName:'Osama',lastName:'bin Laden',personReferenceId:'customer/2'};letres=awaitclient.registerPerson(person);

person={'firstName':'Osama','lastName':'bin Laden','personReferenceId':'customer/2'}res=client.registerPerson(person)

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

Responses

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

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/PersonQuery/?PersonReferenceId=customer/1"

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

ViewPersonQueryquery=newViewPersonQuery();query.personReferenceId="customer/1";ViewPersonQueryResultresponse=client.viewPerson(query);

letres=awaitclient.viewPerson('customer/1');

person={'personReferenceId':'customer/1'}res=client.viewPerson(person)

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

Responses

Search Person

GET /api/PersonQuery/Search

Search for persons matchings specified criterias.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/PersonQuery/Search?Query=Donald"

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

PersonSearchQueryquery=newPersonSearchQuery();query.query="person-reference-id";PersonSearchQueryResultresponse=client.searchPerson(query)

letquery={query:'Donald',filter:{isSanction:null,isPep:null,isRca:null}};letres=awaitclient.searchPerson(query);

query={'query':'Donald','page':{'size':10,'no':1},'filter':{'isSanction':True}}res=client.searchPerson(query)

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

Responses

Classify Match

POST /api/PersonCommand/Classify

Classify a match as either Unknown, Match or FalsePositive.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST "https://test-stage3.pliance.io/api/PersonCommand/Classify" -d '{ "PersonReferenceId": "customer/1", "AliasId": "9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4", "MatchId": "listperson/2", "Classification": "Positive" }'

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

ClassifyHitCommandcommand=newClassifyHitCommand();command.personReferenceId="customer/1";command.matchId="listperson/2",command.aliasId="9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4",command.classification=ClassificationType.PositiveClassifyHitResponseresponse=client.classifyPersonHit(command)

letcommand={personReferenceId:'customer/1',matchId:'listperson/2',aliasId:'9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4',classification:ClassificationType.FalsePositive};letres=awaitclient.classifyPersonHit(command);

person={'personReferenceId':'customer/1','matchId':'listperson/2','aliasId':'9097bb697f1c923a953bffe9cbee2cc553984dca5a7a35ff16eee4b8ca9b20f4','classification':'FalsePositive'}res=client.classifyPersonMatch(person)

Successful response

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

Parameters

Responses

Archive a person

POST /api/PersonCommand/Archive

Archive a person.

Code Samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST "https://test-stage3.pliance.io/api/PersonCommand/Archive" -d '{ "PersonReferenceId": "customer/1" }'

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

ArchivePersonCommandcommand=newArchivePersonCommand();command.personReferenceId="customer/1";ArchivePersonResponseresponse=client.archivePerson(command)

letcommand={personReferenceId:'customer/1'};letres=awaitclient.archivePerson(command);

person={'personReferenceId':'customer/1',}res=client.archivePerson(person)

Successful response

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

Parameters

Responses

Unarchive a person

POST /api/PersonCommand/Unarchive

Unarchive a person.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST "https://test-stage3.pliance.io/api/PersonCommand/Unarchive" -d '{ "PersonReferenceId": "customer/1" }'

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

UnarchivePersonCommandcommand=newUnarchivePersonCommand();command.personReferenceId="customer/1";UnarchivePersonResponseresponse=client.unarchivePerson(command)

letcommand={personReferenceId:'customer/1'};letres=awaitclient.unarchivePerson(command);

person={'personReferenceId':'customer/1',}res=client.unarchivePerson(person)

Successful response

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

Parameters

Responses

Delete Person

DELETE /api/PersonCommand

Delete a person.

Code samples

curl -H "Authorization: Bearer $JWT" -XDELETE "https://test-stage3.pliance.io/api/PersonCommand/?PersonReferenceId=customer/1"

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

DeletePersonCommandcommand=newDeletePersonCommand();command.personReferenceId="customer/1";DeletePersonResponseresponse=client.deletePerson(command)

letcommand={personReferenceId:'customer/1'};letres=awaitclient.deletePerson(command);

person={'personReferenceId':'customer/1',}res=client.deletePerson(person)

Successful response

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

Parameters

Responses

Company

Register Company

PUT /api/CompanyCommand

Create or update a company.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPUT "https://test-stage3.pliance.io/api/CompanyCommand" -d '{ "CompanyReferenceId": "company/1", "Name": "Plisec AB", "Identity": { "Identity": "559161-4275", "Country": "SE" } }'

letcompany={name:'Plisec AB',companyReferenceId:'company/1',identity:{identity:'559161-4275',country:'SE'}};letres=awaitclient.registerCompany(company);

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

RegisterCompanyCommandcommand=newRegisterCompanyCommand();command.companyReferenceId="company/1";command.name="Plisec AB";command.identity=newCompanyIdentity();command.identity.identity="559161-4275";command.identity.country="SE";RegisterCompanyResponseresponse=client.registerCompany(command);

company={'name':'Plisec AB','companyReferenceId':'company/1','identity':{'identity':'559161-4275','country':'SE'}}res=client.registerCompany(company)

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

Responses

View Company

GET /api/CompanyQuery

View a specific company.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/CompanyQuery/?CompanyReferenceId=company/1"

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

ViewCompanyQueryquery=newViewCompanyQuery();query.companyReferenceId="company/1";ViewCompanyQueryResultresponse=client.viewCompany(query);

letres=awaitclient.viewCompany('company/1');

company={'companyReferenceId':'company/1'}res=client.viewCompany(company)

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

Responses

Search Company

GET /api/CompanyQuery/Search

Search for companies matchings specified criterias.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/CompanyQuery/Search/?Query=Plisec"

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

CompanySearchQueryquery=newCompanySearchQuery();query.query="Plisec";PersonSearchQueryResultresponse=client.searchCompany(query)

letquery={query:'Plisec',filter:{isSanction:true,isPep:null,isRca:null}};letres=awaitclient.searchCompany(query);

query={'query':'Pliesec','page':{'size':10,'no':1},'filter':{'isSanction':True}}res=client.searchCompany(query)

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

Responses

Archive Company

POST /api/CompanyCommand/Archive

Archive a company.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST "https://test-stage3.pliance.io/api/CompanyCommand/Archive" -d '{ "CompanyReferenceId": "company/1" }'

letcommand={companyReferenceId:'company/1'};letres=awaitclient.archiveCompany(command);

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

ArchiveCompanyCommandcommand=newArchiveCompanyCommand();command.companyReferenceId="company/1";ArchiveCompanyResponseresponse=client.archiveCompany(command)

company={'companyReferenceId':'company/1'}res=client.archiveCompany(company)

Successful response

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

Parameters

Responses

Unarchive Company

POST /api/CompanyCommand/Unarchive

Unarchive a company.

Code samples

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST "https://test-stage3.pliance.io/api/CompanyCommand/Unarchive" -d '{ "CompanyReferenceId": "company/1" }'

letcommand={companyReferenceId:'company/1'};letres=awaitclient.unarchiveCompany(command);

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

UnarchiveCompanyCommandcommand=newUnarchiveCompanyCommand();command.companyReferenceId="company/1";UnarchiveCompanyResponseresponse=client.unarchiveCompany(command)

company={'companyReferenceId':'company/1'}res=client.unarchiveCompany(company)

Successful response

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

Parameters

Responses

Delete Company

DELETE /api/CompanyCommand

Delete a company.

Code samples

curl -H "Authorization: Bearer $JWT" -XDELETE "https://test-stage3.pliance.io/api/CompanyCommand/?CompanyReferenceId=company/1"

letcommand={companyReferenceId:'company/1'};letres=awaitclient.deleteCompany(command);

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

DeleteCompanyCommandcommand=newDeleteCompanyCommand();command.personReferenceId="company/1";DeleteCompanyResponseresponse=client.deleteCompany(command)

company={'companyReferenceId':'company/1'}res=client.deleteCompany(company)

Successful response

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

Parameters

Responses

Beneficiaries Graph

GET /api/CompanyQuery/Graph/Beneficiaries

View a D3 graph of the company structure.

Code samples

curl -H "Authorization: Bearer $JWT""https://test-stage3.pliance.io/api/CompanyQuery/Graph/Beneficiaries/?CompanyReferenceId=company/1"

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

Responses

Watchlist

Retrieve Person

GET /api/WatchlistQuery

View detailed information about the PEP or sanction matches.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/WatchlistQuery/?Id=ab74a89sd32&FirstName=John&LastName=Doe"

Successful response

{"data":{"listId":"Bogard-13935","nationalIdentificationNumber":"19870211-****","names":[{"firstName":"Ebba","lastName":"Busch Thor","selectedFirstName":[{"text":"Ebba","isMatch":false}],"selectedLastName":[{"text":"Busch","isMatch":false},{"text":" ","isMatch":false},{"text":"Thor*","isMatch":false}],"type":"Primärt namn"},{"firstName":"Ebba-Elisabeth","lastName":"Busch","selectedFirstName":[{"text":"Ebba","isMatch":true},{"text":"-","isMatch":false},{"text":"Elisabeth","isMatch":true}],"selectedLastName":[{"text":"Busch","isMatch":true}],"type":"Folkbokföringsnamn"}],"birthdates":[{"circa":false,"year":1987,"month":2,"day":11}],"addresses":[],"countries":["se"],"isPep":true,"isRca":false,"isSanction":false,"nationalities":[],"images":["https://data.riksdagen.se/filarkiv/bilder/ledamot/611fcc9d-0e12-4628-86c6-b8452fda4171_320.jpg"],"roles":[{"description":"Ordförande i Kristemokraternas partistyrelse","isActive":true,"sinceYear":"25","sinceMonth":"4","sinceDay":"25"},{"description":"Riksdagsledamot","isActive":true,"sinceYear":"24","sinceMonth":"9","sinceDay":"24"}],"relations":[{"firstName":"*****","lastName":"*****-***********","relationPersonId":"Bogard-13936","isPep":false,"isRca":true,"isSanction":false,"relationType":"Far"},{"firstName":"******","lastName":"*****-***********","relationPersonId":"Bogard-13937","isPep":false,"isRca":true,"isSanction":false,"relationType":"Mor"},{"firstName":"****** *******","lastName":"***** ****","relationPersonId":"Bogard-13938","isPep":false,"isRca":true,"isSanction":false,"relationType":"Son"},{"firstName":"******","lastName":"***** ****","relationPersonId":"Bogard-13939","isPep":false,"isRca":true,"isSanction":false,"relationType":"Partner"},{"firstName":"***** ******","lastName":"***** ****","relationPersonId":"Bogard-14369","isPep":false,"isRca":true,"isSanction":false,"relationType":"Dotter"}],"gender":"Female","lists":["Bogard's Nordic PEP List"]},"status":"Success","success":true,"checkpoint":"0000000000000000000000000000000000000000000000000000000000000000"}

Parameters

Responses

Retrieve Person (v2)

GET /api/WatchlistQuery/v2

View detailed information about the PEP or sanction matches.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/WatchlistQuery/v2/?MatchId=ab74a89sd32&PersonReferenceId=person-reference-id"

Successful response

{"data":{"listId":"Bogard-13935","nationalIdentificationNumber":"19870211-****","names":[{"firstName":"Ebba","lastName":"Busch Thor","selectedFirstName":[{"text":"Ebba","isMatch":false}],"selectedLastName":[{"text":"Busch","isMatch":false},{"text":" ","isMatch":false},{"text":"Thor*","isMatch":false}],"type":"Primärt namn"},{"firstName":"Ebba-Elisabeth","lastName":"Busch","selectedFirstName":[{"text":"Ebba","isMatch":true},{"text":"-","isMatch":false},{"text":"Elisabeth","isMatch":true}],"selectedLastName":[{"text":"Busch","isMatch":true}],"type":"Folkbokföringsnamn"}],"birthdates":[{"circa":false,"year":1987,"month":2,"day":11}],"addresses":[],"countries":["se"],"isPep":true,"isRca":false,"isSanction":false,"nationalities":[],"images":["https://data.riksdagen.se/filarkiv/bilder/ledamot/611fcc9d-0e12-4628-86c6-b8452fda4171_320.jpg"],"roles":[{"description":"Ordförande i Kristemokraternas partistyrelse","isActive":true,"sinceYear":"25","sinceMonth":"4","sinceDay":"25"},{"description":"Riksdagsledamot","isActive":true,"sinceYear":"24","sinceMonth":"9","sinceDay":"24"}],"relations":[{"firstName":"*****","lastName":"*****-***********","relationPersonId":"Bogard-13936","isPep":false,"isRca":true,"isSanction":false,"relationType":"Far"},{"firstName":"******","lastName":"*****-***********","relationPersonId":"Bogard-13937","isPep":false,"isRca":true,"isSanction":false,"relationType":"Mor"},{"firstName":"****** *******","lastName":"***** ****","relationPersonId":"Bogard-13938","isPep":false,"isRca":true,"isSanction":false,"relationType":"Son"},{"firstName":"******","lastName":"***** ****","relationPersonId":"Bogard-13939","isPep":false,"isRca":true,"isSanction":false,"relationType":"Partner"},{"firstName":"***** ******","lastName":"***** ****","relationPersonId":"Bogard-14369","isPep":false,"isRca":true,"isSanction":false,"relationType":"Dotter"}],"gender":"Female","lists":["Bogard's Nordic PEP List"]},"status":"Success","success":true,"checkpoint":"0000000000000000000000000000000000000000000000000000000000000000"}

Parameters

Responses

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

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPUT "https://test-stage3.pliance.io/api/WebhookCommand" -d '{ "url": "https://COMPANY/WEBHOOK", "enabled": "true", "secret": "COMPANY_SECRET" }'

Successful response

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

Parameters

Responses

Query Settings

GET /api/WebhookQuery

View current webhook settings.

Code samples

curl -H "Authorization: Bearer $JWT" -XGET "https://test-stage3.pliance.io/api/WebhookQuery"

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

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

curl -H "Authorization: Bearer $JWT""https://test-stage3.pliance.io/api/FeedQuery/?From=3acd81cf042e98dd60ae6547d39156ea300e19d802e5b8b5723365151cfd9b0f"

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

Responses

Schemas

Person Identity

Company Identity

Address

Birthdate

Register Person Options

Text Match

Person Hit

View Person Response Data

Last Changed

Engagements

Page

Filter

Search Person Response Data

Search Person Response Data Result

Role

Watchlist Response Data

Webhook Response

Feed Response Data

Feed Response Data Item

Metadata

Register Company Response Data

View Company Response Data

Search Company Response Data

Search Company Response Data Result

Order

Any

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

Strict

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

Exact

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

Fuzziness

Simple

Simple incasesensitive matching.

Diacritics

Incasesensitive matching with diacritics removed.

Metaphone

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