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"
}
}
}
'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"type": "<string>",
"primary_name": "<string>",
"title": "<string>",
"country_territory_code": "<string>",
"country_territory_name": "<string>",
"gender": "<string>",
"is_subsidiary": false,
"score": "<string>",
"matched_criteria": {
"date_of_birth": {
"month": "1",
"year": "2020",
"day": "1"
},
"name": {
"name_type": "<string>",
"name": "<string>"
},
"type": {
"is_structural_variation": false,
"is_non_linguistic_variation": false,
"type": "<string>",
"is_linguistic_variation": false
}
},
"date_of_birth": [
{
"month": "1",
"year": "2020",
"day": "1"
}
],
"icon_hints": [
"<string>"
],
"countries_territories": [
{
"code": "<string>",
"type": "<string>"
}
]
}
}
],
"meta": {
"score_time_ms": "<string>",
"total": "<string>",
"last": "<string>",
"count": "<string>",
"screening_context": "<string>",
"overall_time_ms": "<string>",
"search_time_ms": "<string>",
"first": "<string>"
}
}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"
}
}
}
'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"type": "<string>",
"primary_name": "<string>",
"title": "<string>",
"country_territory_code": "<string>",
"country_territory_name": "<string>",
"gender": "<string>",
"is_subsidiary": false,
"score": "<string>",
"matched_criteria": {
"date_of_birth": {
"month": "1",
"year": "2020",
"day": "1"
},
"name": {
"name_type": "<string>",
"name": "<string>"
},
"type": {
"is_structural_variation": false,
"is_non_linguistic_variation": false,
"type": "<string>",
"is_linguistic_variation": false
}
},
"date_of_birth": [
{
"month": "1",
"year": "2020",
"day": "1"
}
],
"icon_hints": [
"<string>"
],
"countries_territories": [
{
"code": "<string>",
"type": "<string>"
}
]
}
}
],
"meta": {
"score_time_ms": "<string>",
"total": "<string>",
"last": "<string>",
"count": "<string>",
"screening_context": "<string>",
"overall_time_ms": "<string>",
"search_time_ms": "<string>",
"first": "<string>"
}
}Authorizations
bearerAuthdefault
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
authentication token from getAcessToken response
Body
application/jsonapplication/vnd.dowjones.dna.riskentities.v_1.1+jsonapplication/vnd.dowjones.dna.riskentities.v_1.0+json
Show child attributes
Show child attributes
⌘I