- 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
search entity
Returns Screening of Risk and Compliance
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
authentication token from getAcessToken response
Request's Attributes class
Filter to include or exclude codes from CountryTerritoryType list
Filter to include or exclude codes from CountryTerritory list
One of the identification types. Check the IDTYPE list on taxonomy for values
Filter to include or exclude codes from SanctionLists (SAN)
Filter to include or exclude codes from SpecialInterestCategories list
Filter to include or exclude codes from AdverseMediaCategories list
Filter to include or exclude codes from Locations list
Filter to include or exclude codes from OtherOfficialLists (OOL)
Filter to include or exclude codes from OtherExclusionLists (OEL)
Filter to include code from StateOwnerships (SOC)
Filter to include or exclude codes from OccupationCategories list
Filter to include or exclude codes from HighRiskFactor list
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"
}
}
}'
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
AND
Name
, ProfileNotes
, OccupationTitle
Precise
, Near
, Broad
Filter to include or exclude codes from CountryTerritoryType list
AND
, OR
Filter to include or exclude codes from CountryTerritory list
OR
One of the identification types. Check the IDTYPE list on taxonomy for values
Precise
, Near
, Broad
Precise
, Near
, Broad
Person
, Entity
Watchlist
, AdverseMedia
, StateOwnedCompanies
, HighRiskFactors
, Locations
OR
Filter to include or exclude codes from SanctionLists (SAN)
AND
, OR
Filter to include or exclude codes from SpecialInterestCategories list
AND
, OR
Filter to include or exclude codes from AdverseMediaCategories list
AND
, OR
Filter to include or exclude codes from Locations list
AND
, OR
Filter to include or exclude codes from OtherOfficialLists (OOL)
AND
, OR
Filter to include or exclude codes from OtherExclusionLists (OEL)
AND
, OR
Filter to include code from StateOwnerships (SOC)
Filter to include or exclude codes from OccupationCategories list
AND
, OR
Filter to include or exclude codes from HighRiskFactor list
AND
, OR
Name
, Country
, Title
, Subsidiary
, PercentMatch
Response
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"
}
}
}'