API Reference
...
API Endpoints
PEP Searches
Create PEP Search Request
2min
GET
AUTHENTICATION
Authorization
Bearer
Bearer
QUERY PARAMETERS
name
string
*Example: Barack Hussein, OBAMA
Name of person
fuzziness
number
integer; Level of fuzziness (100=fuzzy, 1=exact). We recommend a fuzziness setting between 10 and 30 (default 15).
delta
string
string; daily
, monthly
or full
, defines whether the search will search only for changes in the last day, last month or the complete history in the database. (Only support from API version 2.1 onwards)
RESPONSES
200
OK
PepSearchResponse
count
integer
total number or records in the result
next
string
url to fetch the next page of results if any
previous
string
url to fetch the previous page of results if any
results
PepSearchResultEntity[]
401
Error message when there is no token provided.
Error401
detail
string
Error reason
403
Error message when you don't have the appropriate plan.
Error403
detail
string
Error reason
4XX
When there are are form errors the response structure will be like this. In the case provided there was a problem in the field "name".
FormError
field_name
string
array