API Request & Response
We are currently migrating the API request method from GET to POST started from October 1st, 2024 to January 2nd, 2025. All client must now use the POST method. Failure to migrate the method by January 2nd, 2025 will make all the transactions failed due to the GET endpoint deprecation. Find more details here.
🎈Endpoint
Method | Endpoint |
---|---|
POST* | https://api.verihubs.com/watchlist-screening/verify |
*The previously used GET method will be deprecated by January 2nd, 2025.
🎈Headers
Key | Type | Description |
---|---|---|
App-ID | String | Application ID that generated from Application Menu in Verihubs Client Dashboard. To hit in Testing and Live mode you need a Production Application ID. |
API-Key | String | API-Key that generated from Application Menu in Verihubs Client Dashboard that related to specific Application ID. |
You can generate your Application ID and API-Key in the Application page in Verihubs Client Dashboard..
🎈Request
Request Parameter
Parameter | Type | Description | Example |
---|---|---|---|
full_name | String | Individual full name. We encourage you not to use academic title on the name for better search result. | Joko Widodo |
birth_date | String | Birthdate of the person in YYYY-MM-DD format. | 1969-10-30 |
birth_place | String | Birthplace of the person. | Surabaya |
country | String | Country where the person resides in. | Indonesia |
reference_id | String | This reference_id can be used to indicate your company’s transaction and must be unique for each transactions. If the reference_id value is empty, then Verihubs will auto-generate one for you. | Watchlist_123 |
🎈Response
Response Parameter
Field | Type | String |
---|---|---|
id | string | Auto generated Verihubs Transaction ID that can be used for reconciliation purpose (unique for every transaction). |
reference_id | string | |
full_name | string | Full name of the individual that matched the search criteria. |
birth_date | string | Birth date of the individual that matched the search criteria in YYYY-MM-DD format. |
risk_level | string | Risk level of the individual profile that matched the search criteria ["high", "medium", "low", "unknown"]. |
count | integer | Number of total matched profile based on the search criteria. |
pep_count | integer | Number of total matches profile in PEP case based on the search criteria. |
rca_count | integer | Number of total matches profile in RCA case based on the search criteria. |
sip_count | integer | Number of total matches profile in SIP case based on the search criteria. |
sanction_count | integer | Number of total matches profile in Sanction case based on the search criteria. |
watchlist_count | integer | Number of total matches profile in Watchlist case based on the search criteria. |
crime_count | integer | Number of total matches profile in Crime case based on the search criteria. |
max_similarity | float | Maximum similarity value between your query and matches profile. |
birth_place | string | Birthplace of the individual that matched the search criteria. |
death_date | string | Deathdate of the individual that matched the search criteria if the individual is deceased. |
description | string | Short description of the individual that matched the search criteria. |
detail_description | string | More details description of the individual that matched the search criteria. |
alias | string | Aliases/other names. of the individual that matched the search criteria. |
addresses | string | Home address of the individual that matched the search criteria. |
associates | string | Families & relatives of the individual that matched the search criteria. |
crimes | string | Detailed information regarding criminal acts committed by the individual that matched the search criteria. |
roles | string | Detailed information regarding the position held by the individual that matched the search criteria. |
sanctions | string | Detailed information regarding the sanctions imposed on the individual that matched the search criteria. |
sources | string | Links for any related sources. |
media | string | Links for any related media. |
images | string | Links for any related images. |
types | string | Types of profile ["PEP", "RCA", "SIP", "Sanction", "Watchlist", "Crime"] |
similarity | string | Similarity value between your query and matches profile. |
match_fields | string | The match fields on the information you’ve entered with the results. |
Updated about 2 months ago