website logo
⌘K
Getting Started
Overview
Creating Your Account
Testing sanctions.io
Implementation
Implementation Guide
Best Practices
API Reference
Authorization & API Version
API Endpoints
Solutions
Manual Batch Screening
Sanctions Screening for SAP®
Sanctions Screening for BigID®
Integrating with your CRM
Changelog
Resources
FAQs
Sanctions & Watchlists
Legal Documents
Customer Support
Docs powered by archbee 
0min

Create PEP Search Request

GET
This endpoint allows searches against our PEP database.
QUERY PARAMETERS
namestring*
Name of person
fuzzinessnumber

integer; Level of fuzziness (100=fuzzy, 1=exact). We recommend a fuzziness setting between 10 and 30 (default 15).

deltastring

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
countinteger
total number or records in the result
nextstring
url to fetch the next page of results if any
previousstring
url to fetch the previous page of results if any
results
PepSearchResultEntity[]
401
Error message if no token provided.
Error401
detailstring
Error reason
403
Error message when you don't have the appropriate plan.
Error403
detailstring
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_namestring
array
Updated 08 Nov 2022
UP NEXT
List Data Sources
Docs powered by archbee