Default
search entity
AML
Country Data
Crypto
- Private
- Public
Customer
- 2FA
- AccessControl
- Active Session
- Customer
- Organization
IPG
- IPG Backoffice APIs
- IPG Payment APIs
KYC
Smart Contract
- Global Settings
Wallet
- Admin
- Allowed Operation
- Assets
- Currency
- Currency Pairs
- Dashboard
- Fee
- Limit
- Misc
- Operation Address
- Operation Destination
- Order
- Transactions
- Wallets
Default
search entity
Returns Screening of Risk and Compliance
POST
/
searchEntity
curl --request POST \
--url https://gateway.varchev.com/peps/searchEntity \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-token: <x-token>' \
--data '{
"data": {
"attributes": {
"filter_group_and": {
"group_operator": "AND",
"filters": {
"search_keyword": {
"scope": [
"Name"
],
"type": "Precise",
"text": "keyword to search"
},
"country_territory": {
"country_territory_types": {
"country_territory_types": [
"3"
],
"operator": "AND"
},
"countries_territories": {
"codes": [
"USA",
"GFR"
],
"exclude_codes": [],
"operator": "OR"
}
},
"date_of_birth": {
"date": {
"month": "1",
"year": "2020",
"is_strict_match": false,
"day": "1"
},
"year_range": {
"from": "1",
"to": "1"
},
"is_deceased_excluded": false
},
"record_types": [
"Person"
],
"content_set": [
"Watchlist",
"Locations",
"StateOwnedCompanies",
"AdverseMedia"
]
}
},
"filter_group_or": {
"group_operator": "OR",
"filters": {
"sanctions_list": {
"codes": [
"AE-CAE",
"AR-MOJDH"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"content_category": {
"special_interest": {
"codes": [
"1001",
"1002"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"adverse_media": {
"codes": [
"33",
"34"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"location": {
"codes": [
"121"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
}
},
"other_official_list": {
"codes": [
"ADB",
"AE-DFSA"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"other_exclusion_list": {
"codes": [
"AFDB",
"BR-CGU"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"state_ownership": {
"code": "5",
"is_unknown_excluded": false,
"is_all_excluded": false
},
"occupation_category": {
"codes": [
"18",
"6"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"hrf_category": {
"codes": [
"1011"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
}
}
},
"paging": {
"offset": 0,
"limit": 10
},
"sort": "PercentMatch"
}
}
}'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
authentication token from getAcessToken response
Body
Request's Attributes class
Available options:
Watchlist, AdverseMedia, StateOwnedCompanies, HighRiskFactors, Locations Available options:
Person, Entity Available options:
AND Filter to include or exclude codes from HighRiskFactor list
Filter to include or exclude codes from OccupationCategories list
Filter to include or exclude codes from OtherExclusionLists (OEL)
Filter to include or exclude codes from OtherOfficialLists (OOL)
Filter to include or exclude codes from SanctionLists (SAN)
Filter to include code from StateOwnerships (SOC)
Available options:
OR Available options:
Name, Country, Title, Subsidiary, PercentMatch Response
200 - application/json
curl --request POST \
--url https://gateway.varchev.com/peps/searchEntity \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-token: <x-token>' \
--data '{
"data": {
"attributes": {
"filter_group_and": {
"group_operator": "AND",
"filters": {
"search_keyword": {
"scope": [
"Name"
],
"type": "Precise",
"text": "keyword to search"
},
"country_territory": {
"country_territory_types": {
"country_territory_types": [
"3"
],
"operator": "AND"
},
"countries_territories": {
"codes": [
"USA",
"GFR"
],
"exclude_codes": [],
"operator": "OR"
}
},
"date_of_birth": {
"date": {
"month": "1",
"year": "2020",
"is_strict_match": false,
"day": "1"
},
"year_range": {
"from": "1",
"to": "1"
},
"is_deceased_excluded": false
},
"record_types": [
"Person"
],
"content_set": [
"Watchlist",
"Locations",
"StateOwnedCompanies",
"AdverseMedia"
]
}
},
"filter_group_or": {
"group_operator": "OR",
"filters": {
"sanctions_list": {
"codes": [
"AE-CAE",
"AR-MOJDH"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"content_category": {
"special_interest": {
"codes": [
"1001",
"1002"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"adverse_media": {
"codes": [
"33",
"34"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"location": {
"codes": [
"121"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
}
},
"other_official_list": {
"codes": [
"ADB",
"AE-DFSA"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"other_exclusion_list": {
"codes": [
"AFDB",
"BR-CGU"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"state_ownership": {
"code": "5",
"is_unknown_excluded": false,
"is_all_excluded": false
},
"occupation_category": {
"codes": [
"18",
"6"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
},
"hrf_category": {
"codes": [
"1011"
],
"last_review_date": {
"from": {
"month": "1",
"year": "2020",
"day": "1"
},
"to": {
"month": "1",
"year": "2020",
"day": "1"
}
},
"exclude_codes": [],
"is_all_excluded": false,
"operator": "AND"
}
}
},
"paging": {
"offset": 0,
"limit": 10
},
"sort": "PercentMatch"
}
}
}'