Default
search entity
- Documentation
- SEPA's API
- API Explore
- Community
- Welcome to FinHub
- GETGet document
- GETGet documents
- GETGet verification result
- POSTPost document upload
- PUTPut document status
- PUTPut document update
- GETGet card balance
- GETGet card pin
- GETGet card product config
- GETGet card product list
- GETGet card product
- GETGet card transactions
- GETGet card usage
- GETGet card
- GETGet cardholder
- GETGet EHIMode configuration
- GETGet issuer
- POSTPost card credit
- POSTPost card debit
- POSTPost card product setup
- POSTPost card product
- POSTPost card transfers
- POSTPost card usage
- POSTPost card
- POSTPost cardholder
- POSTPost EHIMode configuration
- POSTPost issuer
- PUTPut card account
- PUTPut card activate
- PUTPut card cardholder
- PUTPut card lost
- PUTPut card pin
- PUTPut card product config
- PUTPut card stolen
- PUTPut card suspend
- PUTPut cardholder
- PUTPut EHIMode configuration
- PUTPut issuer
Private
Public
2FA
AccessControl
Active Session
Credentials
Customer
Organization
- POSTPost send
- POSTGenerateToken
IPG Backoffice APIs
IPG Payment APIs
Company
EIN Verification
IBAN Verification
NIF Verification
Product
System
TIN Verification
VAT Verification
- POSTPost authorize
- POSTPost backgroundcheck
- POSTPost delete info
- POSTPost face
- POSTPost get info
- POSTPost scan documents
- POSTPost upload image
- PUTPut backgroundcheck
Global Settings
Rules
Smart Contract
Admin
Allowed Operation
Assets
Currency
Currency Pairs
Dashboard
Fee
Limit
Misc
Operation Address
Operation Destination
Order
Transactions
Wallets
Introduction
AML
CMS
Crypto
Customer
muse-openapi
IPG
KYB
KYC
Smart Contract
Wallet
Default
search entity
Returns Screening of Risk and Compliance
POST
/
searchEntity
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
X-token
string
*
X-token
Required
string
authentication token from getAcessToken response
object
*
data
object
data
object
attributes
object
attributes
object
Request's Attributes class
filter_group_and
object
filter_group_and
object
group_operator
enum<string>
group_operator
enum<string>
filters
object
filters
object
search_keyword
object
search_keyword
object
scope
array
scope
array
type
enum<string>
type
enum<string>
text
string
text
string
country_territory
object
country_territory
object
country_territory_types
object
country_territory_types
object
Filter to include or exclude codes from CountryTerritoryType list
country_territory_types
array
country_territory_types
array
Add Example Value
operator
enum<string>
operator
enum<string>
countries_territories
object
countries_territories
object
Filter to include or exclude codes from CountryTerritory list
codes
array
codes
array
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
operator
enum<string>
operator
enum<string>
identification
object
identification
object
number
string
number
string
type
integer
type
integer
One of the identification types. Check the IDTYPE list on taxonomy for values
entity_name
object
entity_name
object
full_name
string
full_name
string
search_type
enum<string>
search_type
enum<string>
date_of_birth
object
date_of_birth
object
date
object
date
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
is_strict_match
boolean
is_strict_match
boolean
day
string
day
string
Add Example Value
year_range
object
year_range
object
from
string
from
string
Add Example Value
to
string
to
string
Add Example Value
is_deceased_excluded
boolean
is_deceased_excluded
boolean
person_name
object
person_name
object
last_name
string
last_name
string
middle_name
string
middle_name
string
first_name
string
first_name
string
search_type
enum<string>
search_type
enum<string>
record_types
array
record_types
array
content_set
array
content_set
array
Add Example Value
filter_group_or
object
filter_group_or
object
group_operator
enum<string>
group_operator
enum<string>
filters
object
filters
object
sanctions_list
object
sanctions_list
object
Filter to include or exclude codes from SanctionLists (SAN)
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
content_category
object
content_category
object
special_interest
object
special_interest
object
Filter to include or exclude codes from SpecialInterestCategories list
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
adverse_media
object
adverse_media
object
Filter to include or exclude codes from AdverseMediaCategories list
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
location
object
location
object
Filter to include or exclude codes from Locations list
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
other_official_list
object
other_official_list
object
Filter to include or exclude codes from OtherOfficialLists (OOL)
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
other_exclusion_list
object
other_exclusion_list
object
Filter to include or exclude codes from OtherExclusionLists (OEL)
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
state_ownership
object
state_ownership
object
Filter to include code from StateOwnerships (SOC)
code
string
code
string
Add Example Value
is_unknown_excluded
boolean
is_unknown_excluded
boolean
is_all_excluded
boolean
is_all_excluded
boolean
occupation_category
object
occupation_category
object
Filter to include or exclude codes from OccupationCategories list
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
is_adsr_excluded
boolean
is_adsr_excluded
boolean
operator
enum<string>
operator
enum<string>
hrf_category
object
hrf_category
object
Filter to include or exclude codes from HighRiskFactor list
codes
array
codes
array
Add Example Value
last_review_date
object
last_review_date
object
from
object
from
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
to
object
to
object
month
string
month
string
Add Example Value
year
string
year
string
Add Example Value
day
string
day
string
Add Example Value
exclude_codes
array
exclude_codes
array
Add Example Value
is_all_excluded
boolean
is_all_excluded
boolean
operator
enum<string>
operator
enum<string>
paging
object
paging
object
offset
integer
offset
integer
limit
integer
limit
integer
Add Example Value
screening_context
string
screening_context
string
sort
enum<string>
sort
enum<string>
curl --request POST \
--url https://gateway.finhub.cloud/peps/1.0.0/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": true,
"score": "<string>",
"matched_criteria": {
"date_of_birth": {
"month": "1",
"year": "2020",
"day": "1"
},
"name": {
"name_type": "<string>",
"name": "<string>"
},
"type": {
"is_structural_variation": true,
"is_non_linguistic_variation": true,
"type": "<string>",
"is_linguistic_variation": true
}
},
"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
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
X-token
string
requiredauthentication token from getAcessToken response
Body
data
object
data.attributes
object
Request's Attributes class
data.attributes.filter_group_and
object
data.attributes.filter_group_and.group_operator
enum<string>
Available options:
AND data.attributes.filter_group_and.filters
object
data.attributes.filter_group_and.filters.search_keyword
object
data.attributes.filter_group_and.filters.search_keyword.scope
enum<string>[]
Available options:
Name, ProfileNotes, OccupationTitle data.attributes.filter_group_and.filters.search_keyword.type
enum<string>
Available options:
Precise, Near, Broad data.attributes.filter_group_and.filters.search_keyword.text
string
data.attributes.filter_group_and.filters.country_territory
object
data.attributes.filter_group_and.filters.country_territory.country_territory_types
object
Filter to include or exclude codes from CountryTerritoryType list
data.attributes.filter_group_and.filters.country_territory.country_territory_types.country_territory_types
string[]
data.attributes.filter_group_and.filters.country_territory.country_territory_types.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_and.filters.country_territory.countries_territories
object
Filter to include or exclude codes from CountryTerritory list
data.attributes.filter_group_and.filters.country_territory.countries_territories.codes
string[]
data.attributes.filter_group_and.filters.country_territory.countries_territories.exclude_codes
string[]
data.attributes.filter_group_and.filters.country_territory.countries_territories.operator
enum<string>
Available options:
OR data.attributes.filter_group_and.filters.identification
object
data.attributes.filter_group_and.filters.identification.number
string
data.attributes.filter_group_and.filters.identification.type
integer
One of the identification types. Check the IDTYPE list on taxonomy for values
data.attributes.filter_group_and.filters.entity_name
object
data.attributes.filter_group_and.filters.entity_name.full_name
string
data.attributes.filter_group_and.filters.entity_name.search_type
enum<string>
Available options:
Precise, Near, Broad data.attributes.filter_group_and.filters.date_of_birth
object
data.attributes.filter_group_and.filters.date_of_birth.date
object
data.attributes.filter_group_and.filters.date_of_birth.date.month
string
data.attributes.filter_group_and.filters.date_of_birth.date.year
string
data.attributes.filter_group_and.filters.date_of_birth.date.is_strict_match
boolean
default: falsedata.attributes.filter_group_and.filters.date_of_birth.date.day
string
data.attributes.filter_group_and.filters.date_of_birth.year_range
object
data.attributes.filter_group_and.filters.date_of_birth.year_range.from
string
data.attributes.filter_group_and.filters.date_of_birth.year_range.to
string
data.attributes.filter_group_and.filters.date_of_birth.is_deceased_excluded
boolean
default: falsedata.attributes.filter_group_and.filters.person_name
object
data.attributes.filter_group_and.filters.person_name.last_name
string
data.attributes.filter_group_and.filters.person_name.middle_name
string
data.attributes.filter_group_and.filters.person_name.first_name
string
data.attributes.filter_group_and.filters.person_name.search_type
enum<string>
Available options:
Precise, Near, Broad data.attributes.filter_group_and.filters.record_types
enum<string>[]
Available options:
Person, Entity data.attributes.filter_group_and.filters.content_set
enum<string>[]
Available options:
Watchlist, AdverseMedia, StateOwnedCompanies, HighRiskFactors, Locations data.attributes.filter_group_or
object
data.attributes.filter_group_or.group_operator
enum<string>
Available options:
OR data.attributes.filter_group_or.filters
object
data.attributes.filter_group_or.filters.sanctions_list
object
Filter to include or exclude codes from SanctionLists (SAN)
data.attributes.filter_group_or.filters.sanctions_list.codes
string[]
data.attributes.filter_group_or.filters.sanctions_list.last_review_date
object
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.from
object
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.from.month
string
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.from.year
string
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.from.day
string
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.to
object
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.to.month
string
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.to.year
string
data.attributes.filter_group_or.filters.sanctions_list.last_review_date.to.day
string
data.attributes.filter_group_or.filters.sanctions_list.exclude_codes
string[]
data.attributes.filter_group_or.filters.sanctions_list.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.sanctions_list.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.content_category
object
data.attributes.filter_group_or.filters.content_category.special_interest
object
Filter to include or exclude codes from SpecialInterestCategories list
data.attributes.filter_group_or.filters.content_category.special_interest.codes
string[]
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date
object
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.from
object
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.from.month
string
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.from.year
string
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.from.day
string
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.to
object
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.to.month
string
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.to.year
string
data.attributes.filter_group_or.filters.content_category.special_interest.last_review_date.to.day
string
data.attributes.filter_group_or.filters.content_category.special_interest.exclude_codes
string[]
data.attributes.filter_group_or.filters.content_category.special_interest.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.content_category.special_interest.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.content_category.adverse_media
object
Filter to include or exclude codes from AdverseMediaCategories list
data.attributes.filter_group_or.filters.content_category.adverse_media.codes
string[]
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date
object
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.from
object
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.from.month
string
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.from.year
string
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.from.day
string
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.to
object
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.to.month
string
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.to.year
string
data.attributes.filter_group_or.filters.content_category.adverse_media.last_review_date.to.day
string
data.attributes.filter_group_or.filters.content_category.adverse_media.exclude_codes
string[]
data.attributes.filter_group_or.filters.content_category.adverse_media.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.content_category.adverse_media.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.content_category.location
object
Filter to include or exclude codes from Locations list
data.attributes.filter_group_or.filters.content_category.location.codes
string[]
data.attributes.filter_group_or.filters.content_category.location.last_review_date
object
data.attributes.filter_group_or.filters.content_category.location.last_review_date.from
object
data.attributes.filter_group_or.filters.content_category.location.last_review_date.from.month
string
data.attributes.filter_group_or.filters.content_category.location.last_review_date.from.year
string
data.attributes.filter_group_or.filters.content_category.location.last_review_date.from.day
string
data.attributes.filter_group_or.filters.content_category.location.last_review_date.to
object
data.attributes.filter_group_or.filters.content_category.location.last_review_date.to.month
string
data.attributes.filter_group_or.filters.content_category.location.last_review_date.to.year
string
data.attributes.filter_group_or.filters.content_category.location.last_review_date.to.day
string
data.attributes.filter_group_or.filters.content_category.location.exclude_codes
string[]
data.attributes.filter_group_or.filters.content_category.location.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.content_category.location.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.other_official_list
object
Filter to include or exclude codes from OtherOfficialLists (OOL)
data.attributes.filter_group_or.filters.other_official_list.codes
string[]
data.attributes.filter_group_or.filters.other_official_list.last_review_date
object
data.attributes.filter_group_or.filters.other_official_list.last_review_date.from
object
data.attributes.filter_group_or.filters.other_official_list.last_review_date.from.month
string
data.attributes.filter_group_or.filters.other_official_list.last_review_date.from.year
string
data.attributes.filter_group_or.filters.other_official_list.last_review_date.from.day
string
data.attributes.filter_group_or.filters.other_official_list.last_review_date.to
object
data.attributes.filter_group_or.filters.other_official_list.last_review_date.to.month
string
data.attributes.filter_group_or.filters.other_official_list.last_review_date.to.year
string
data.attributes.filter_group_or.filters.other_official_list.last_review_date.to.day
string
data.attributes.filter_group_or.filters.other_official_list.exclude_codes
string[]
data.attributes.filter_group_or.filters.other_official_list.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.other_official_list.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.other_exclusion_list
object
Filter to include or exclude codes from OtherExclusionLists (OEL)
data.attributes.filter_group_or.filters.other_exclusion_list.codes
string[]
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date
object
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.from
object
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.from.month
string
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.from.year
string
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.from.day
string
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.to
object
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.to.month
string
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.to.year
string
data.attributes.filter_group_or.filters.other_exclusion_list.last_review_date.to.day
string
data.attributes.filter_group_or.filters.other_exclusion_list.exclude_codes
string[]
data.attributes.filter_group_or.filters.other_exclusion_list.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.other_exclusion_list.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.state_ownership
object
Filter to include code from StateOwnerships (SOC)
data.attributes.filter_group_or.filters.state_ownership.code
string
data.attributes.filter_group_or.filters.state_ownership.is_unknown_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.state_ownership.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.occupation_category
object
Filter to include or exclude codes from OccupationCategories list
data.attributes.filter_group_or.filters.occupation_category.codes
string[]
data.attributes.filter_group_or.filters.occupation_category.last_review_date
object
data.attributes.filter_group_or.filters.occupation_category.last_review_date.from
object
data.attributes.filter_group_or.filters.occupation_category.last_review_date.from.month
string
data.attributes.filter_group_or.filters.occupation_category.last_review_date.from.year
string
data.attributes.filter_group_or.filters.occupation_category.last_review_date.from.day
string
data.attributes.filter_group_or.filters.occupation_category.last_review_date.to
object
data.attributes.filter_group_or.filters.occupation_category.last_review_date.to.month
string
data.attributes.filter_group_or.filters.occupation_category.last_review_date.to.year
string
data.attributes.filter_group_or.filters.occupation_category.last_review_date.to.day
string
data.attributes.filter_group_or.filters.occupation_category.exclude_codes
string[]
data.attributes.filter_group_or.filters.occupation_category.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.occupation_category.is_adsr_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.occupation_category.operator
enum<string>
Available options:
AND, OR data.attributes.filter_group_or.filters.hrf_category
object
Filter to include or exclude codes from HighRiskFactor list
data.attributes.filter_group_or.filters.hrf_category.codes
string[]
data.attributes.filter_group_or.filters.hrf_category.last_review_date
object
data.attributes.filter_group_or.filters.hrf_category.last_review_date.from
object
data.attributes.filter_group_or.filters.hrf_category.last_review_date.from.month
string
data.attributes.filter_group_or.filters.hrf_category.last_review_date.from.year
string
data.attributes.filter_group_or.filters.hrf_category.last_review_date.from.day
string
data.attributes.filter_group_or.filters.hrf_category.last_review_date.to
object
data.attributes.filter_group_or.filters.hrf_category.last_review_date.to.month
string
data.attributes.filter_group_or.filters.hrf_category.last_review_date.to.year
string
data.attributes.filter_group_or.filters.hrf_category.last_review_date.to.day
string
data.attributes.filter_group_or.filters.hrf_category.exclude_codes
string[]
data.attributes.filter_group_or.filters.hrf_category.is_all_excluded
boolean
default: falsedata.attributes.filter_group_or.filters.hrf_category.operator
enum<string>
Available options:
AND, OR data.attributes.paging
object
data.attributes.paging.offset
integer
data.attributes.paging.limit
integer
data.attributes.screening_context
string
data.attributes.sort
enum<string>
Available options:
Name, Country, Title, Subsidiary, PercentMatch Response
200 - application/json
data
object[]
data.id
string
data.type
string
data.attributes
object
data.attributes.type
string
data.attributes.primary_name
string
data.attributes.title
string
data.attributes.country_territory_code
string
data.attributes.country_territory_name
string
data.attributes.gender
string
data.attributes.is_subsidiary
boolean
default: falsedata.attributes.score
string
data.attributes.matched_criteria
object
data.attributes.matched_criteria.date_of_birth
object
data.attributes.matched_criteria.date_of_birth.month
string
data.attributes.matched_criteria.date_of_birth.year
string
data.attributes.matched_criteria.date_of_birth.day
string
data.attributes.matched_criteria.name
object
data.attributes.matched_criteria.name.name_type
string
data.attributes.matched_criteria.name.name
string
data.attributes.matched_criteria.type
object
data.attributes.matched_criteria.type.is_structural_variation
boolean
default: falsedata.attributes.matched_criteria.type.is_non_linguistic_variation
boolean
default: falsedata.attributes.matched_criteria.type.type
string
data.attributes.matched_criteria.type.is_linguistic_variation
boolean
default: falsedata.attributes.date_of_birth
object[]
data.attributes.date_of_birth.month
string
data.attributes.date_of_birth.year
string
data.attributes.date_of_birth.day
string
data.attributes.icon_hints
string[]
data.attributes.countries_territories
object[]
data.attributes.countries_territories.code
string
data.attributes.countries_territories.type
string
meta
object
meta.score_time_ms
string
meta.total
string
meta.last
string
meta.count
string
meta.screening_context
string
meta.overall_time_ms
string
meta.search_time_ms
string
meta.first
string
curl --request POST \
--url https://gateway.finhub.cloud/peps/1.0.0/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": true,
"score": "<string>",
"matched_criteria": {
"date_of_birth": {
"month": "1",
"year": "2020",
"day": "1"
},
"name": {
"name_type": "<string>",
"name": "<string>"
},
"type": {
"is_structural_variation": true,
"is_non_linguistic_variation": true,
"type": "<string>",
"is_linguistic_variation": true
}
},
"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>"
}
}