WatchList is a PEP and Sanction list lookup for due diligence checks. The service sees if a person is listed on any PEP or Sanction lists.
PEP (Politically Exposed Person) means “in a prominent public position or a close relative of someone who is.”
Note that a PEP match can be a “PEPs by relation”, also known as RCA (Relatives or Close Associates).
Content:
API Calls
POST to https://env.zignsec.com/api/v3/ekyc/watchlist/global
env is api or test
| Parameter | Description | Required |
|---|---|---|
matchType | Used to determine how closely a watchlist entity must match a member before being considered a match. The options are Exact, ExactMidName or Close. Default is Exact. | No |
closeMatchRateThreshold | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 99). This is only applicable if matchType is “Close”. Default value is 80. | No |
firstName | First name | Yes |
lastName | Last name | Yes |
middleName | Middle name if available. Multiple middle names must be separated by spaces only and contain no commas (,) | No |
gender | Gender. Can be “Male” or “Female”. Short version “M” or “F” is also supported. | No |
birthDate | Date of birth (YYYY-MM-DD or YYYYMMDD) | No |
residencePolicy | Used for eliminating match results where the member and matching entity have a different Country of Residence. The options are: Ignore, ApplyPEP, ApplyAll, ApplySIP, ApplyRCA | No |
address | Address – there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. | No |
1.2 Request example
{
"query": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"firstName": "Stefan",
"middleName": "",
"lastName": "Löfven",
"gender": "M",
"birthDate": "1957-07-21"
}
}
{
"id": "f39e57f5-9607-4ec3-a83a-0784e5d5732b",
"date": "2020-10-01T13:42:06.0452429Z",
"state": "Finished",
"errors": [],
"numberOfMatches": 1,
"persons": [
{
"resultId": 105571,
"category": "PEP",
"matchRate": 100,
"person": {
"uniqueId": 14385865,
"categories": "Politically Exposed Person (PEP)",
"gender": "Male",
"deceased": "NO",
"primaryFirstName": "Stefan",
"primaryLastName": "Lofven",
"dateOfBirth": "21 Jul 1957",
"placeOfBirth": "",
"primaryLocation": "Stockholm, Sweden",
"image": "https://secure.c6-intelligence.com/c6images/0024490000/0024485022.jpg",
"generalInfo": {
"nationality": "Swedish"
},
"furtherInformation": "PEP Tier 1\r\n",
"xmlFurtherInformation": {
"#cdata-section": "PEP Tier 1\r\n"
},
"enterDate": "2014-09-23",
"descriptions": [
{
"description1": "Politically Exposed Person (PEP)",
"description2": "",
"description3": ""
}
],
"nameDetails": [
{
"nameType": "Also Known As",
"firstName": "Stefan",
"lastName": "Löfven"
},
{
"nameType": "Also Known As",
"firstName": "Lofven",
"lastName": "Stefan"
}
],
"originalScriptNames": [],
"roles": [
{
"title": "Prime Minister (2nd Term)",
"country": "Sweden",
"from": "21 January 2019"
},
{
"title": "Member of Parliament (Riksdag) for Vasternorrland County",
"country": "Sweden",
"from": "24 September 2018"
},
{
"title": "Former Prime Minister (1st Term)",
"country": "Sweden",
"from": "September 2014",
"to": "September 2018"
},
{
"title": "Leader of the Swedish Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Sweden",
"from": "2012"
},
{
"title": "Former Chairperson of the Welfare Policy Review Group of the Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Japan",
"from": "2007",
"to": "2009"
},
{
"title": "Former Member of the Board of Directors of the Swedish Trade Union Confederation",
"country": "Sweden",
"from": "2006",
"to": "2012"
},
{
"title": "Former Chairperson of IF Metall (State Owned Enterprise)",
"country": "Sweden",
"from": "2006",
"to": "2012"
},
{
"title": "Former Deputy Chairperson of the Swedish Trade Council",
"country": "Sweden",
"from": "2004",
"to": "2012"
},
{
"title": "Member of the Swedish Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Sweden"
}
],
"importantDates": [
{
"dateType": "Date of Birth",
"dateValue": "21 Jul 1957"
}
],
"locations": [
{
"country": "Sweden",
"city": "Stockholm",
"address": ""
}
],
"countries": [],
"officialLists": [],
"idNumbers": [],
"sources": [
{
"url": "https://www.svd.se/lofvens-goda-hjarta-kan-vara-en-nackdel",
"categories": "PEP",
"dates": "2020-02-19"
},
{
"url": "https://www.government.se/government-of-sweden/prime-ministers-office/stefan-lofven/cv-stefan-lofven/",
"categories": "Corporate/Business, ID/V, PEP",
"dates": "2019-01-28"
},
{
"url": "https://www.government.se/government-of-sweden/prime-ministers-office/stefan-lofven/state-secretaries-to-stefan-lofven/",
"categories": "PEP",
"dates": "2019-01-28"
},
{
"url": "https://www.government.se/press-releases/2019/01/swedens-new-government/",
"categories": "PEP",
"dates": "2019-01-24"
},
{
"url": "https://www.riksdagen.se/sv/ledamoter-partier/invalda-ledamoter-2018/ledamoter-i-partiordning/",
"categories": "ID/V, PEP",
"dates": "2018-09-24"
},
{
"url": "http://www.expressen.se/nyheter/stefan-lofven-avslojar-frun-ullas-jobb-byte/",
"categories": "ID/V, PEP",
"dates": "2017-06-19"
},
{
"url": "http://www.aftonbladet.se/nyheter/article19636781.ab",
"categories": "ID/V, PEP",
"dates": "2017-06-19"
},
{
"url": "http://www.thelocal.se/20160129/swedish-pm-reported-for-slow-refugee-response",
"categories": "PEP",
"dates": "2016-02-01"
},
{
"url": "http://www.thelocal.se/20151011/bjrklund-throw-out-the-greens-and-well-talk",
"categories": "PEP",
"dates": "2015-10-12"
},
{
"url": "https://www.cia.gov/library/publications/world-leaders-1/SW.html",
"categories": "PEP",
"dates": "2015-06-15, 2015-03-02, 2015-01-15"
},
{
"url": "http://www.thelocal.se/20150415/live-swedens-spring-budget-announcement",
"categories": "PEP",
"dates": "2015-04-15"
},
{
"url": "http://www.government.se/sb/d/576",
"categories": "PEP",
"dates": "2015-04-14"
},
{
"url": "http://www.thelocal.se/20140915/five-big-headaches-for-stefan-lfven",
"categories": "PEP",
"dates": "2014-09-23"
}
],
"linkedIndividuals": [
{
"firstName": "Oscar",
"lastName": "Stenstrom",
"otherCategories": "PEP",
"description": "Oscar Stenstrom is an associate of Stefan Lofven."
},
{
"firstName": "Nils",
"lastName": "Vikmang",
"otherCategories": "PEP",
"description": "Nils Vikmang is an associate of Stefan Lofven"
},
{
"firstName": "Madeleine",
"middleName": "Harby",
"lastName": "Samuelsson",
"otherCategories": "PEP",
"description": "Madeleine Samuelsson is an associate of Stefan Lofven"
},
{
"firstName": "Iris",
"lastName": "Melander",
"otherCategories": "RCA",
"description": "Iris Melander is the mother of Stefan Lofven."
},
{
"firstName": "Karin",
"middleName": "Lovisa",
"lastName": "Wallensteen",
"otherCategories": "PEP",
"description": "Karin Wallensteen is an associate of Stefan Lofven"
},
{
"firstName": "Ulla",
"middleName": "Margareta",
"lastName": "Lofven",
"otherCategories": "PEP",
"description": "Ulla Lofven is the spouse of Stefan Lofven."
},
{
"firstName": "Ture",
"lastName": "Melander",
"otherCategories": "RCA",
"description": "Ture Melander is the father of Stefan Lofven."
}
],
"linkedCompanies": [
{
"name": "IF Metall",
"categories": "SIE",
"description": "Former Chairperson (2006-2012)"
},
{
"name": "Swedish Trade Union Confederation",
"categories": "SIE",
"description": "Former Member of the Board of Directors (2006-2012)"
}
]
}
}
]
}
2. Get session result
GET https://env.zignsec.com/api/v3/ekyc/watchlist/global/sessionid
Endpoint can be used to retrieve session result. Response example.
2.1 Response parameters
| Parameter | Description |
|---|---|
id | Session ID |
date | Session start date |
state | Session state. Can be: Created, Finished, Failed |
errors | A JSON array of error conditions, see error handling. |
numberOfMatches | Number of matches |
persons | List of person details |
| Parameter | Description |
|---|---|
resultId | The unique identifier of the single person result. |
category | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, SIP, RCA. |
matchRate | For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close). |
person | Person entity |
| Parameter | Description |
|---|---|
uniqueId | Unique identifier of the person |
categories | Category of the person |
subcategory | Subcategory of the person |
gender | Gender of the person |
deceased | Deceased status of the person, if applicable |
primaryFirstName | Primary first name of the person |
primaryMiddleName | Primary middle name of the person |
primaryLastName | Primary last name of the person |
title | Title of the person, if available |
position | Position of the person, if available |
dateOfBirth | Date of birth of the person |
deceasedDate | Deceased date of the person, if applicable |
placeOfBirth | Birth place of the person |
primaryLocation | Person’s primary location |
image | Person’s picture |
generalInfo | Person’s general information |
furtherInformation | Further information of the person (availability dependent on your region and subscription) |
enterDate | Date the profile was initially created in data source |
lastReviewed | Last reviewed date of the record |
descriptions | Person’s description list |
nameDetails | Person’s name detail list |
originalScriptNames | List of original script names of the person |
roles | List of roles of the PEP profile |
importantDates | List of important dates for the person |
locations | List of locations for the person |
countries | List of countries where the person has been located |
officialLists | List of official lists where the person is found |
sources | List of all public sources, including both government and media sources, used to build the full profile |
linkedIndividuals | List of individuals associated with the person (availability dependent on your region and subscription) |
linkedCompanies | List of companies associated with the person (availability dependent on your region and subscription) |
API documentation
API calls
Add person to monitoring: POST to https://env.zignsec.com/api/v3/ekyc/watchlist/global/monitoring
Result: GET from https://env.zignsec.com/api/v3/ekyc/watchlist/global/monitoring/sessionId
Monitoring list: GET from https://env.zignsec.com/api/v3/ekyc/watchlist/global/monitoring
Enable monitoring: POST to https://env.zignsec.com/api/v3/ekyc/watchlist/global/monitoring/sessionId/enable
Disable monitoring: POST to https://env.zignsec.com/api/v3/ekyc/watchlist/global/monitoring/sessionId/disable
where env is api or test sessionId is the session identifier retrieved from the setup call, named id in the response.
| Parameter | Description | Required |
|---|---|---|
memberNumber | A Member Number is a unique identifier, which identifies the individual being scanned and is determined by your organisation | Yes |
matchType | Used to determine how closely a watchlist entity must match a member before being considered a match. The options are Exact, ExactMidName or Close. Default is Exact. | No |
closeMatchRateThreshold | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 99). This is only applicable if matchType is “Close”. Default value is 80. | No |
firstName | First name | Yes |
lastName | Last name | Yes |
middleName | Middle name if available. Multiple middle names must be separated by spaces only and contain no commas (,) | No |
gender | Gender. Can be “Male” or “Female”. Short version “M” or “F” is also supported. | No |
birthDate | Date of birth (YYYY-MM-DD or YYYYMMDD) | No |
residencePolicy | Used for eliminating match results where the member and matching entity have a different Country of Residence. The options are: Ignore, ApplyPEP, ApplyAll, ApplySIP, ApplyRCA | No |
address | Address – there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. | No |
webhook | A URL where monitoring updates will automatically be POST:ed |
{
"query": {
"memberNumber": "1",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"firstName": "Stefan",
"middleName": "",
"lastName": "Löfven",
"gender": "M",
"birthDate": "1957-07-21"
},
"webhook": "https://site.com/webhook"
}
{
"id": "9becff11-7401-43a0-ab38-7491cb31116d",
"state": "MonitoringEnabled",
"errors": [],
"startDate": "2021-02-18T13:10:16.0581156",
"monitoringStatus": "NoChanges",
"lastUpdateDate": "2021-02-18T16:33:07.1742606Z",
"numberOfMatches": 1,
"memberNumber": "unique_identifier",
"persons": [
{
"resultId": 130544,
"category": "PEP",
"person": {
"uniqueId": 14385865,
"categories": "Politically Exposed Person (PEP)",
"gender": "Male",
"deceased": "NO",
"primaryFirstName": "Stefan",
"primaryLastName": "Lofven",
"dateOfBirth": "21 Jul 1957",
"placeOfBirth": "",
"primaryLocation": "Stockholm, Sweden",
"image": "https://secure.c6-intelligence.com/c6images/0024490000/0024485022.jpg",
"generalInfo": {
"nationality": "Swedish"
},
"furtherInformation": "PEP Tier 1\r\n",
"xmlFurtherInformation": {
"#cdata-section": "PEP Tier 1\r\n"
},
"enterDate": "2014-09-23",
"descriptions": [
{
"description1": "Politically Exposed Person (PEP)",
"description2": "PEP Tier 1",
"description3": ""
}
],
"nameDetails": [
{
"nameType": "Also Known As",
"firstName": "Stefan",
"lastName": "Löfven"
},
{
"nameType": "Also Known As",
"firstName": "Lofven",
"lastName": "Stefan"
}
],
"originalScriptNames": [],
"roles": [
{
"title": "Prime Minister (2nd Term)",
"country": "Sweden",
"from": "21 January 2019"
},
{
"title": "Member of Parliament (Riksdag) for Vasternorrland County",
"country": "Sweden",
"from": "24 September 2018"
},
{
"title": "Former Prime Minister (1st Term)",
"country": "Sweden",
"from": "September 2014",
"to": "September 2018"
},
{
"title": "Leader of the Swedish Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Sweden",
"from": "2012"
},
{
"title": "Former Chairperson of the Welfare Policy Review Group of the Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Japan",
"from": "2007",
"to": "2009"
},
{
"title": "Former Member of the Board of Directors of the Swedish Trade Union Confederation",
"country": "Sweden",
"from": "2006",
"to": "2012"
},
{
"title": "Former Chairperson of IF Metall (State Owned Enterprise)",
"country": "Sweden",
"from": "2006",
"to": "2012"
},
{
"title": "Former Deputy Chairperson of the Swedish Trade Council",
"country": "Sweden",
"from": "2004",
"to": "2012"
},
{
"title": "Member of the Swedish Social Democratic Party (Sveriges Socialdemokratiska Arbetarparti, SAP, S)",
"country": "Sweden"
}
],
"importantDates": [
{
"dateType": "Date of Birth",
"dateValue": "21 Jul 1957"
}
],
"locations": [
{
"country": "Sweden",
"city": "Stockholm",
"address": ""
}
],
"countries": [],
"officialLists": [],
"idNumbers": [],
"sources": [
{
"url": "https://www.svd.se/lofvens-goda-hjarta-kan-vara-en-nackdel",
"categories": "PEP",
"dates": "2020-02-19"
},
{
"url": "https://www.government.se/government-of-sweden/prime-ministers-office/stefan-lofven/cv-stefan-lofven/",
"categories": "Corporate/Business, ID/V, PEP",
"dates": "2019-01-28"
},
{
"url": "https://www.government.se/government-of-sweden/prime-ministers-office/stefan-lofven/state-secretaries-to-stefan-lofven/",
"categories": "PEP",
"dates": "2019-01-28"
},
{
"url": "https://www.government.se/press-releases/2019/01/swedens-new-government/",
"categories": "PEP",
"dates": "2019-01-24"
},
{
"url": "https://www.riksdagen.se/sv/ledamoter-partier/invalda-ledamoter-2018/ledamoter-i-partiordning/",
"categories": "ID/V, PEP",
"dates": "2018-09-24"
},
{
"url": "http://www.expressen.se/nyheter/stefan-lofven-avslojar-frun-ullas-jobb-byte/",
"categories": "ID/V, PEP",
"dates": "2017-06-19"
},
{
"url": "http://www.aftonbladet.se/nyheter/article19636781.ab",
"categories": "ID/V, PEP",
"dates": "2017-06-19"
},
{
"url": "http://www.thelocal.se/20160129/swedish-pm-reported-for-slow-refugee-response",
"categories": "PEP",
"dates": "2016-02-01"
},
{
"url": "http://www.thelocal.se/20151011/bjrklund-throw-out-the-greens-and-well-talk",
"categories": "PEP",
"dates": "2015-10-12"
},
{
"url": "https://www.cia.gov/library/publications/world-leaders-1/SW.html",
"categories": "PEP",
"dates": "2015-06-15, 2015-03-02, 2015-01-15"
},
{
"url": "http://www.thelocal.se/20150415/live-swedens-spring-budget-announcement",
"categories": "PEP",
"dates": "2015-04-15"
},
{
"url": "http://www.government.se/sb/d/576",
"categories": "PEP",
"dates": "2015-04-14"
},
{
"url": "http://www.thelocal.se/20140915/five-big-headaches-for-stefan-lfven",
"categories": "PEP",
"dates": "2014-09-23"
}
],
"linkedIndividuals": [
{
"firstName": "Oscar",
"lastName": "Stenstrom",
"otherCategories": "PEP",
"description": "Oscar Stenstrom is an associate of Stefan Lofven."
},
{
"firstName": "Nils",
"lastName": "Vikmang",
"otherCategories": "PEP",
"description": "Nils Vikmang is an associate of Stefan Lofven"
},
{
"firstName": "Madeleine",
"middleName": "Harby",
"lastName": "Samuelsson",
"otherCategories": "PEP",
"description": "Madeleine Samuelsson is an associate of Stefan Lofven"
},
{
"firstName": "Iris",
"lastName": "Melander",
"otherCategories": "RCA",
"description": "Iris Melander is the mother of Stefan Lofven."
},
{
"firstName": "Karin",
"middleName": "Lovisa",
"lastName": "Wallensteen",
"otherCategories": "PEP",
"description": "Karin Wallensteen is an associate of Stefan Lofven"
},
{
"firstName": "Ulla",
"middleName": "Margareta",
"lastName": "Lofven",
"otherCategories": "PEP",
"description": "Ulla Lofven is the spouse of Stefan Lofven."
},
{
"firstName": "Ture",
"lastName": "Melander",
"otherCategories": "RCA",
"description": "Ture Melander is the father of Stefan Lofven."
}
],
"linkedCompanies": [
{
"name": "IF Metall",
"categories": "SIE",
"description": "Former Chairperson (2006-2012)"
},
{
"name": "Swedish Trade Union Confederation",
"categories": "SIE",
"description": "Former Member of the Board of Directors (2006-2012)"
}
]
}
}
]
}
2.1 Response parameters
| Parameter | Description |
|---|---|
id | Session ID |
state | Session state. Can be: Created, MonitoringEnabled, MonitoringDisabled, Failed |
startDate | Session start date |
monitoringStatus | Monitoring status. Can be: NoChanges, NewMatches, UpdatedMatches, RemovedMatches |
memberNumber | A Member Number is a unique identifier, which identifies the individual being scanned and is determined by your organization |
lastUpdateDate | The last date when the session was updated |
errors | A JSON array of error conditions, see error handling. |
numberOfMatches | Number of matches |
persons | List of person details |
| Parameter | Description | Type |
|---|---|---|
pageIndex | The page index of results | query |
pageSize | The number of items or results per page | query |
3.2 Response example
{
"total": 3,
"items": [
{
"id": "098e1911-bc1b-46f8-bdc5-0760d5ed0458",
"monitoringStatus": "UpdatedMatches",
"lastUpdateDate": "2021-02-18T13:09:53.9292889",
"memberNumber": "unique_identifier_1",
"monitoringEnabled": true
},
{
"id": "865b8ff3-7ab7-406a-b8b1-8ce7ee6508cb",
"monitoringStatus": "NewMatches",
"lastUpdateDate": "2021-02-18T13:09:58.79627",
"memberNumber": "unique_identifier_2",
"monitoringEnabled": true
},
{
"id": "9becff11-7401-43a0-ab38-7491cb31116d",
"monitoringStatus": "NoChanges",
"lastUpdateDate": "2021-02-18T13:10:17.6578399",
"memberNumber": "unique_identifier_3",
"monitoringEnabled": false
}
]
}
