Introduction

Get started easily with our powerful, easy-to-use API! With the API your application can send and retrieve PEP and sanction data. There are several endpoints for different tasks:

• Person - Send and retrieve person data for PEP and Sanction screening.
• Company - Send and retrieve company data for PEP and Sanction screening.
• Watchlist - retrieve data from a PEP / Sanction list.

PEP/Sanction screening process

In Pliance the screening process consist of these steps:

1. Start by registering a Person or Company with the corresponding endpoint with your data.
2. Retrieve the PEP and Sanction matches with the endpoint.
3. Retrive the watchlist data from the endpoint and review the matches.
4. Classify all the matches, choose between Unknown, False Positive and Match.
5. Archive the person when the person is no longer a customer.
6. Delete the person from the service, for example if they stop being a customer or to comply with GDPR.

Installation

Pilance provides packages for several popular languages to ease the the development.

.NET

dotnet add package Pliance.NET-SDK

Java

Node.js

npm i @pliance/pliance.js.sdk

Python

pip install pliance.py.sdk

Authentication

Authentication in Pliance is done with JWT.

You will need to add the generated authorization token to the request header of all request.

Authorization : Bearer token

Generating JSON Web Token

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

{"typ":"JWT","alg":"HS256"}{"iat":1555495956,"nbf":1555495956,"exp":1555496256,"aud":"pliance.io","iss":"CUSTOMER_ID","given_name":"USERNAME","sub":"USER_ID"}

First request

Now its time to do the first request. We provide a simple Ping endpoint for testing the authentication.

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

usingSystem;usingSystem.Security.Cryptography.X509Certificates;usingPliance.SDK;usingPliance.SDK.Contract;namespaceExample{classProgram{staticasyncvoidMain(string[]args){varfactory=newPlianceClientFactory(secret:"2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b",issuer:"Test",url:"https://test-stage4.pliance.io/",certificate:newX509Certificate2("client-certificate.pfx"));varclient=factory.Create("givenname","sub");awaitclient.Ping();}}}

packagecom.pliance.app;importjava.io.File;importjava.io.FileInputStream;importpliance.sdk.IPlianceClient;importpliance.sdk.PlianceClientFactory;importpliance.sdk.contracts.*;publicclassApp{publicstaticvoidmain(String[]args){try{FileInputStreamcertificate=newFileInputStream(newFile("client-certificate.pfx"));PlianceClientFactoryfactory=newPlianceClientFactory("2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b","Test","https://test-stage4.pliance.io/",certificate);IPlianceClientclient=factory.create("givenname","subject");PingResponseresponse=client.ping();}catch(Exceptione){e.printStackTrace();}}}

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()

Examples

You can find code examples for implementations in various language on Github.

Pliance provides SDKs to the popular languages to boost your development.

Person

Register Person

Example register person:

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPUT https://test-stage3.pliance.io/api/PersonCommand -d '{ "PersonReferenceId": "person-reference-id", "Firstname": "John", "Lastname": "Doe" }'

varresult=awaitclient.RegisterPerson(newRegisterPersonCommand{PersonReferenceId="person-reference-id",FirstName="John",LastName="Doe"});

RegisterPersonCommandcommand=newRegisterPersonCommand();command.personReferenceId="person-reference-id";command.firstName="John";command.lastName="Doe";RegisterPersonResponseresponse=client.registerPerson(command);

letperson={firstName:'John',lastName:'Doe',personReferenceId:'person-reference-id'};letres=awaitclient.registerPerson(person);

person={'firstName':'John','lastName':'Doe','personReferenceId':'person-reference-id'}res=client.registerPerson(person)

The above command returns JSON structured like this:

{"hits":[[{"matchId":"list-13935","matchedFirstName":[{"text":"Vendela","isMatch":true}],"matchedLastName":[{"text":"Bogren","isMatch":true}],"isPep":true,"isRca":false,"isSanction":false,"classification":"Unknown","aliasId":"55601e25d6c885e8e7c549970315016196bb01c9ff22aa796d81ba5469c87a8c"}]],"status":"Success","success":true}

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.

HTTP Request

PUT /api/PersonCommand

Data Parameters

Types

PersonIdentity

Birthdate

Address

RegisterPersonOptions

Fuzziness: Simple

Simple case insensitive compare

Fuzziness: Diacritics

Smash diacritics before insensitive compare

Fuzziness: Metaphone

Phonetic compare (https://en.wikipedia.org/wiki/Metaphone)

Order: Any

Names can be matched in any order

Order: Strict

Names must appear in the same order

Order: Exact

All names must match, and appear in the same order

View Person

The view person is used to retrieve a person and all the matches.

Example view person:

curl -H "Authorization: Bearer $JWT" -XGET https://test-stage3.pliance.io/api/PersonQuery --data-urlencode "PersonReferenceId=reference-id"

varresult=awaitclient.ViewPerson(newViewPersonQuery{PersonReferenceId="person-reference-id"});

ViewPersonQueryquery=newViewPersonQuery();query.personReferenceId="person-reference-id";ViewPersonQueryResultresponse=client.viewPerson(query);

letres=awaitclient.viewPerson('person-reference-id');

person={'personReferenceId':'person-reference-id'}res=client.viewPerson(person)

The above command returns JSON structured like this:

{"status":"Success","success":true,"data":{"personReferenceId":"person-reference-id","identity":{"identity":"19600714-8841","country":"se"},"firstName":"Vendela","lastName":"Bogren","birthdate":"1960-07-14","gender":"Female","addresses":[{"street1":"Jaktstigen","street2":"","city":"ESKILSTUNA","streetNo":"12","postalCode":"632 31","country":"se"}],"hits":[[{"matchId":"list-13935","matchedFirstName":[{"text":"Vendela","isMatch":true}],"matchedLastName":[{"text":"Bogren","isMatch":true}],"gender":"Unknown","isPep":true,"isRca":false,"isSanction":false,"classification":"Unknown","aliasId":"55601e25d6c885e8e7c549970315016196bb01c9ff22aa796d81ba5469c87a8c"}]]}}

HTTP Request

GET /api/PersonQuery?PersonReferenceId=[string]

Query Parameters

Search Person

The Search Person endpoint is used to search persons by name and filter by matches.

Example search person:

curl -H "Authorization: Bearer $JWT" -XGET https://test-stage3.pliance.io/api/PersonQuery/Search --data-urlencode "query=john doe"

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

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

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

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

The above command returns JSON structured like this:

{"status":"Success","success":true,"data":{"result":[{"personReferenceId":"company-reference-id","identity":{"Identity":"600714-8841","Country":"se"},"firstName":[{"isMatch":false,"text":"Vendela"}],"lastName":[{"isMatch":true,"text":"Bogren"}],"isPep":false,"isRca":false,"isSanction":false}]}}

HTTP Request

GET /api/PersonQuery/Search?query=[string]&filter.isPep=[boolean]&filter.isRca=[boolean]&filter.isSanction=[boolean]&page.size=[number]&page.no=[number]

Query Parameters

Filter

Page

Classify Match

The Classify Match endpoint is used to classify PEP/Sanction matches for a person.

Example classify match:

curl -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -XPOST https://test-stage3.pliance.io/api/PersonCommand/Classify -d '{ "PersonReferenceId": "person-reference-id", "AliasId": "aliasId", "MatchId": "match1", "Classification": "Positive" }'

varresult=awaitclient.ClassifyPersonHit(newClassifyHitCommand{PersonReferenceId="person-reference-id",MatchId="match-id",AliasId="alias-id",Classification=ClassificationType.Positive});

ClassifyHitCommandcommand=newClassifyHitCommand();command.personReferenceId="person-reference-id";command.matchId="match-id",command.aliasId="alias-id",command.classification=ClassificationType.PositiveClassifyHitResponseresponse=client.classifyPersonHit(command)

letcommand={personReferenceId:'person-reference-id',matchId:'match-id',aliasId:'alias-id',classification:ClassificationType.FalsePositive};letres=awaitclient.classifyPersonHit(command);

person={'personReferenceId':'person-reference-id','matchId':'match-id','aliasId':'alias-id','classification':'FalsePositive'}res=client.classifyPersonMatch(person)

The above command returns JSON structured like this:

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

HTTP Request

POST /api/PersonCommand/Classify

Data Parameters

Archive a person

An archived person will no longer be daily monitored for PEP or sanction matches, also if the person has been archived for the entire billing month, it will be excluded from billing.

Example archive person:

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

varresult=awaitclient.ArchivePerson(newArchivePersonCommand{PersonReferenceId="person-reference-id"});

ArchivePersonCommandcommand=newArchivePersonCommand();command.personReferenceId="person-reference-id";ArchivePersonResponseresponse=client.archivePerson(command)

letcommand={personReferenceId:'person-reference-id'};letres=awaitclient.archivePerson(command);

person={'personReferenceId':'person-reference-id',}res=client.archivePerson(person)

The above command returns JSON structured like this:

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

HTTP Request

POST /api/PersonCommand/Unarchive

Data Parameters

Unarchive a person

To revert an archive operation, just call the unarchive endpoint and the person will once again be actively monitored for new PEP and sanction matches.

Example unarchive person:

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

varresult=awaitclient.UnarchivePerson(newUnarchivePersonCommand{PersonReferenceId="person-reference-id"});

UnarchivePersonCommandcommand=newUnarchivePersonCommand();command.personReferenceId="person-reference-id";UnarchivePersonResponseresponse=client.unarchivePerson(command)

letcommand={personReferenceId:'person-reference-id'};letres=awaitclient.unarchivePerson(command);

person={'personReferenceId':'person-reference-id',}res=client.unarchivePerson(person)

The above command returns JSON structured like this:

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

HTTP Request

POST /api/PersonCommand/Unarchive

Data Parameters

Delete Person

The delete person endpoint allows developers to delete a person completely from the system. For example this could be used for remove a person for GDPR compliance.

Example delete person:

curl -H "Authorization: Bearer $JWT" -XDELETE https://test-stage3.pliance.io/api/PersonCommand --data-urlencode "PersonReferenceId=reference-id"

varresult=awaitclient.DeletePerson(newDeletePersonCommand{PersonReferenceId="person-reference-id"});

DeletePersonCommandcommand=newDeletePersonCommand();command.personReferenceId="person-reference-id";DeletePersonResponseresponse=client.deletePerson(command)

letcommand={personReferenceId:'person-reference-id'};letres=awaitclient.deletePerson(command);

person={'personReferenceId':'person-reference-id',}res=client.deletePerson(person)

The above command returns JSON structured like this:

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

HTTP Request

Delete /api/PersonCommand?PersonReferenceId=[string]

Query Parameters

Company

Register Company

Example register company:

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

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

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

RegisterCompanyCommandcommand=newRegisterCompanyCommand();command.companyReferenceId="company-reference-id";command.name="Plisec AB";command.identity=newCompanyIdentity();command.identity.identity="559161-4275";command.identity.country="SWE";RegisterCompanyResponseresponse=client.registerCompany(command);

company={'name':'Plisec AB','companyReferenceId':'company-reference-id','identity':{'identity':'559161-4275','country':'SWE'}}res=client.registerCompany(company)

The above command returns JSON structured like this:

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

The register company endpoint is used to register a company for PEP screening of the company beneficiaries.

HTTP Request

PUT /api/CompanyCommand

Data Parameters

Types

CompanyIdentity

View Company

The view company endpoint is used to retrieve a company with all the beneficiaries and their PEP status.

Example view company:

curl -H "Authorization: Bearer $JWT" -XGET https://test-stage3.pliance.io/api/CompanyQuery --data-urlencode "CompanyReferenceId=company-reference-id"

varresult=awaitclient.ViewCompany(newViewCompanyQuery{CompanyReferenceId="company-reference-id"});

ViewCompanyQueryquery=newViewCompanyQuery();query.companyReferenceId="company-reference-id";ViewCompanyQueryResultresponse=client.viewCompany(query);

letres=awaitclient.viewCompany('company-reference-id');

company={'companyReferenceId':'company-reference-id'}res=client.viewCompany(company)

The above command returns JSON structured like this:

{"status":"Success","success":true,"data":{"companyReferenceId":"company-reference-id","identity":{"Identity":"559161-4275","Country":"se"},"name":"Pliance AB","graph":{"nodes":[{"id":0,"name":"Plisec AB","type":"Plisec AB","reference":"559161-4275","isPep":false},{"id":1,"name":"Jan Nelson","type":"Person","reference":"19630728-2571","isPep":false},{"id":2,"name":"We Go To Eleven AB","type":"Company","reference":"559118-2901","isPep":false},{"id":3,"name":"Jonas Holmén","type":"Person","reference":"19670812-1311","isPep":false},{"id":4,"name":"Jan-Olof Halvarsson","type":"Person","reference":"19800610-2837","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"}]},"beneficiaries":[{"nationIdentityNumber":"19630728-2571","firstName":"Jan","lastName":"Nelson","isPep":false,"engagements":[{"registrationNumber":"559118-2901","name":"We Go To Eleven AB"}]},{"nationIdentityNumber":"19670812-1311","firstName":"Jonas","lastName":"Holmén","isPep":false,"engagements":[{"registrationNumber":"559118-2901","name":"We Go To Eleven AB"}]},{"nationIdentityNumber":"19800610-2837","firstName":"Jan-Olof","lastName":"Halvarsson","isPep":false,"engagements":[]}]}}

HTTP Request

GET /api/CompanyQuery?companyReferenceId=[string]

Query Parameters

Search Company

The Search Company endpoint is used to search company by name and filter by matches.

Example search company:

curl -H "Authorization: Bearer $JWT" -XGET https://test-stage3.pliance.io/api/CompanyQuery/Search --data-urlencode "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)

The above command returns JSON structured like this:

{"status":"Success","success":true,"data":{"result":[{"companyReferenceId":"company-reference-id","identity":{"Identity":"559161-4275","Country":"se"},"names":[{"text":"Pliance AB","isMatch":true}],"isPep":false,"isRca":false,"isSanction":false}]}}

HTTP Request

GET api/CompanyQuery/Search?query=[string]&isPep=[boolean]&isRca=[boolean]&isSanction=[boolean]

Query Parameters

Filter

Page

Archive Company

The archive endpoint allows developers to archive a company. It will remain in the database but will no longer be billed or automatically updated.

Example archive company:

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

letcommand={companyReferenceId:'company-reference-id'};letres=awaitclient.archiveCompany(command);

varresult=awaitclient.ArchiveCompany(newArchiveCompanyCommand{CompanyReferenceId="company-reference-id"});

ArchiveCompanyCommandcommand=newArchiveCompanyCommand();command.companyReferenceId="company-reference-id";ArchiveCompanyResponseresponse=client.archiveCompany(command)

company={'companyReferenceId':'company-reference-id'}res=client.archiveCompany(company)

The above command returns JSON structured like this:

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

HTTP Request

POST /api/CompanyCommand/Archive

Data Parameters

Unarchive Company

To revert an archive operation, just call the unarchive endpoint and the person will once again be actively monitored for new PEP and sanction matches.

Example unarchive company:

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

letcommand={companyReferenceId:'company-reference-id'};letres=awaitclient.unarchiveCompany(command);

varresult=awaitclient.UnarchiveCompany(newUnarchiveCompanyCommand{CompanyReferenceId="company-reference-id"});

UnarchiveCompanyCommandcommand=newUnarchiveCompanyCommand();command.companyReferenceId="company-reference-id";UnarchiveCompanyResponseresponse=client.unarchiveCompany(command)

company={'companyReferenceId':'company-reference-id'}res=client.unarchiveCompany(company)

The above command returns JSON structured like this:

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

HTTP Request

POST /api/CompanyCommand/Unarchive

Data Parameters

Delete Company

The delete company endpoint allows developers to delete a company completely from the system.

Example delete company:

curl -H "Authorization: Bearer $JWT" -XDELETE https://test-stage3.pliance.io/api/CompanyCommand --data-urlencode "CompanyReferenceId=company-reference-id"

letcommand={companyReferenceId:'company-reference-id'};letres=awaitclient.deleteCompany(command);

varresult=awaitclient.DeleteCompany(newDeleteCompanyCommand{CompanyReferenceId="company-reference-id"});

DeleteCompanyCommandcommand=newDeleteCompanyCommand();command.personReferenceId="company-reference-id";DeleteCompanyResponseresponse=client.deleteCompany(command)

company={'companyReferenceId':'company-reference-id'}res=client.deleteCompany(company)

The above command returns JSON structured like this:

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

HTTP Request

Delete /api/CompanyCommand?companyReferenceId=[string]

Query Parameters

Watchlist

Retrieve Person

The above command returns JSON structured like this:

{"data":{"listId":"list-3954","NationalIdentificationNumber":"19960106-3143","gender":"Female","names":[{"firstName":"Selma","lastName":"Söderblom","selectedFirstName":[{"text":"Selma","isMatch":true}],"selectedLastName":[{"text":"Söderblom","isMatch":true}]},{"firstName":"Selma Anna","lastName":"Söderblom","selectedFirstName":[{"text":"Selma ","isMatch":true},{"text":" ","isMatch":false},{"text":"Selma","isMatch":true}],"selectedLastName":[{"text":"Söderblom","isMatch":true}]}],"birthdates":[{"circa":false,"year":1996,"month":01,"day":06}],"addresses":[],"countries":["se"],"isPep":false,"isRca":true,"isSanction":false,"nationalities":[],"images":[],"roles":[],"relations":[{"firstName":"Lena","lastName":"Söderblom","relationPersonId":"list-279","isPep":true,"isRca":false,"isSanction":false,"relationType":"Mor"}]},"status":"Success","success":true}

The Watchlist endpoint is used to retrieve data from PEP and sanctions lists by the matchId.

HTTP Request

GET /api/WatchlistQuery?id=[string]&FirstName=[string]&LastName=[string]

Query Parameters