Example Request
The Query item is a structure of type Address, where FirstName and LastName are needed.
DateOfBirth is optional, but if DateOfBirth is omitted in the query your hits will be classified as Questionable.
POST https://api.zignsec.com/v2/ekyc/watchlist HTTP/1.1
Content-Type: application/json; charset=UTF-8
Authorization: YOUR_KEY...
{
"Query":{
"FirstName":"Stefan",
"LastName":"Löfven",
"dateofbirth":"1957-07-21",
"countryCode":"se",
},
"DataSource":"DP04"
}
Response Example
{
"id": "f505bf74-beaa-43fd-8ed1-2d3268b15582",
"errors": [],
"HitCountTotal": 3,
"HitCountPEP": 3,
"HitCountSanctions": 0,
"PEPHits": [
"A match was made during a PEP check // PROP",
"A match was made during a CIA World Leader List check // CIA_WORLDLEADER",
"A match was made during a List of all National Legislature members check // NTL_LEGISLATOR"
],
"SanctionsHits": [],
"QuestionableHitCountTotal": 0,
"QuestionableHitCountPEP": 0,
"QuestionableHitCountSanctions": 0,
"QuestionablePEPHits": [],
"QuestionableSanctionsHits": [],
"DataProviderRequestId": "WS-7848986.2018.7.10.2.49.15.917"
}Response Description
id | Zignsec’s guid (globally unique identifier) for the request. |
errors | A JSON object that contains information on error conditions that might have resulted from the request, in an array of property-value pairs. If multiple errors occur, a pair of parameters is returned for each error. code Code for the error. List of codes is in table below. description A string that describes the type of error that occurred.If no errors occur, then this object is empty. errors : [] |
HitCountTotal | The total number of good/correct hits, always is HitCountPEP + HitCountSanctions |
HitCountPEP | The total number of good/correct PEP list hits, is the number of rows in the PEPHits[] field. |
HitCountSanctions | The total number of good/correct Sanctions list hits, is the number of rows in the SanctionsHits[] field. |
PEPHits | A description list of good/correct PEP-list hits. |
SanctionsHits | A description list of good/correct Sanctions-list hits. |
QuestionableHitCountTotal | The total number of hits that are less certain, always is QuestionableHitCountPEP + QuestionableHitCountSanctions |
QuestionableHitCountPEP | The total number of PEP list hits that are less certain, is the number of rows in the QuestionablePEPHits[] field. |
QuestionableHitCountSanctions | The total number of Sanctions list hits that are less certain, is the number of rows in the QuestionableSanctionsHits[] field. |
QuestionablePEPHits | A list of PEP-list hit descriptions that are less certain. |
QuestionableSanctionsHits | A list of Sanctions-list hit descriptions that are less certain. |
DataProviderRequestID | An internal identifier for tracking the request with our support. |
Data Sources Queried
PEP lists:
- PEP List (1.1 Million Individuals, spanning 233 countries)
- Canadian Office of the Superintendent of Financial Institutions Individual List
- CIA World Leader List
- National Legislature Members List
Sanction Lists
- United Nations Security Council Consolidated Sanctions List (UNSC)
- US Office of Foreign Assets Control – Treasury Department
- European Union Commission Consolidated List (EU)
- HM United Kingdom Treasury Consolidated List (UKT)
- Canadian Office of the Superintendent of Financial Institutions Entities List
