4.1 Using iHUB Case Creation Feedback Request
The REST API is used to execute the iHUB Request. API to create Transaction Monitoring (TM), Customer Screening (CS), Know Your Customer (KYC) and Transaction Filtering (TF) cases.
End Point Details
- HTTP Link - https://{hostname}/{instance-name}/event
- Method - POST
- Content Type - Application/JSON
Executing iHUB Case Feedback Request
To create case Feedback Request, see Getting Authentication.
Request JSON Parameters
Table 4-1 Parameters and their values for Event Group
Parameter | Value Type | Description |
---|---|---|
CaseID | Number | Unique CaseID |
Promotion Flag | String | The string decides case has to be created or not. If the value is N the generation will be stooped at event level and if the value Y the event generated will be promoted to case. The expected value is Y or N. |
Table 4-2 Parameters and their values for Event List
Parameter | Value Type | Description |
---|---|---|
Event Code | Number | Unique Event code associated. |
Event Type | String | The type of the event. |
Data Origin | String | Captures source system details responsible for case creation requests. |
Status Code | String | The status of the event. |
MIS Date | Date | Note: Applicable for CS cases. |
Event Date | Date | |
Jurisdiction Code | String | The jurisdiction of the case. |
Business Domain | String | The corresponding business domain of the case. |
Event Priority | String | The Priority of the event. |
Event Reason | String | The reason for the event. |
Scenario Id | Number | ID corresponding to the scenario associated to the event. |
Table 4-3 Parameters and their values for Event Score
Parameter | Value Type | Description |
---|---|---|
Score | Number | Score generated for the event. |
Score Code | String | Score code on which Event score has been generated. |
Table 4-4 Parameters and their values for Entity Map
Parameter | Value Type | Description |
---|---|---|
Entity Type | String | Type of the entity associated. |
Focus Flag | String | Flag to determine the primary focus associated. |
DirectEntity Flag | String | Flag of the entity type for direct relation with event. |
Entity Name | String | Name of the entity associated. |
Entity Code | String | Identity code of entity associated. |
Entity ID | Number | Identity value of entity associated. |
Table 4-5 Parameters and their values for Event Group Attributes
Parameter | Value Type | Description |
---|---|---|
Process Flag | String | Flag for the process the entry in the pre-case table to case table. |
Promotion Flag | String | The string decides case has to be created or not. If the value is N the generation will be stooped at event level and if the value Y the event generated will be promoted to case. The expected value is Y or N. |
Case Type | String | Type of the case. |
Confidential Flag | String | The string decides if the event is confidential or not. |
Processing Complete Flag | String | The Flag to update after the case creation is completed. |
Case Description | String | Case description for the case generated. |
Case Resolution | String | The conclusion of the event. |
Case Comments | String | Comments on the case creation. |
Case Summary | String | More information about case creation. |
Case Title Name | String | Title of the case that to be generated. |
Case Type Code | String | Type of the case. |
Created By | String | User who created the case. |
Last Action Code | String | The last action taken on this case. |
Priority Status Code | String | Priority status of the case. |
Priority Code | String | Priority of the case. |
Status Code | String | The status of the event. |
Scenario Class Code | String | Scenario on which the case has to be generated. |
Case Due Date | String | Format -YYYY-MM-DD
Date on which case will be due. |
Case Assignee | String | Name of the assignee for the case. |
Jurisdiction Code | String | The jurisdiction of the case. |
Business Domain Code | String | The corresponding business domain of the case. |
Table 4-6 Parameters and their values for Entity List
Parameter | Value Type | Description |
---|---|---|
Type | String | Type of the entity associated. |
riskAssesment | String | List all the risk types you want to filter. |
Business Persistence | String | Flag value to save the entity values. |
Entity ID | Number | Identity value of entity associated. |
Data Origin | String | Captures source system details responsible for case creation. |
Focus Flag | String | Flag to determine the primary focus associated. |
Table 4-7 Parameters and their values for Primary Entity
Parameter | Value Type | Description |
---|---|---|
Entity ID | Number | Identity value of entity associated. |
Entity Type | String | Type of the entity associated. |
Table 4-8 Parameters and their values for Event Screening Matches
Parameter | Value Type | Description |
---|---|---|
Alert ID | Number | Unique code for alert. |
TimeStamp | Number | Time when the event was created. |
Column Score | Numeric | Score of the event. |
Overall Score | Numeric | Overall score of the case. |
Rule Id | Numeric | Id of the rule. |
Business Domain | String | The corresponding business domain of the event. |
Jurisdiction Code | String | The jurisdiction of the event. |
Matched Value | String | Match the value to entity name. |
Result Id | Numeric | Unique id of the result. |
RuleSet Id | Numeric | Unique is of the rule. |
Scoring Method | String | Provide the scoring method. |
Search String | String | Search for an entry. |
Search Type | String | Search based on type. |
Source Entity | String | Type of entity. |
Source Index Name | String | Index name of the source. |
Source Key | String | Source of the key. |
Target Index Name | String | Index name of the target. |
Target Key | Numeric | Key of the target. |
Watchlist Key Id | Numeric | Id of the watchlist key. |
Table 4-9 Parameters and their values for Event Watchlist Map for CS cases
Parameter | Value Type | Description |
---|---|---|
Watchlist Skey | Numeric | Skey of the watchlist. |
Event Code | Number | Unique Event code associated. |
Event Type | String | The type of the event. |
Table 4-10 Parameters and their values for Event Entity Map for CS Cases
Parameter | Value Type | Description |
---|---|---|
Score | Number | Score generated for the event. |
Score Code | String | Score code on which Event score has been generated. |
Score Type | String | Type of score. |
Note:
Ensure that the Event Code is unique and the Event Entity Map and Entity List values are valid.Response JSON Parameters
Response will contain a result array that contains case status for each case.
Table 4-11 Parameters and their values
Parameter | Value Type | Description |
---|---|---|
Case InternalId | String | Unidque caseID generated with a prefix CA. |
CaseID | Number | Unique CaseID |
EventCode | Number | Unique Event code associated. |
Request and Response JSON Samples
Request Sample for AML Case:{
"Event Group": [
{
"caseId": null,
"Promotion Flag": "Y",
"Event List": [
{
"Event": {
"eventScore": 0,
"Event Code": "7755",
"Event Type": "AML",
"Data Origin": "CMCSMAN",
"Status Code": "NEW",
"Event Date": "2025-02-28",
"Jurisdiction Code": "AMEA",
"Business Domain": "a",
"Event Priority": null,
"Event Reason": "2=abcgscbh acbhsu",
"Scenario Id": 59,
"Scenario Class": "AM"
},
"Event Score": {
"Score": 0,
"Score Code": "INIT_SCORE",
"Score Type": null
},
"Event Entity Map": [
{
"Entity Type": "EXTERNAL_ENTITY",
"Focus Flag": "Y",
"DirectEntity Flag": "Y",
"Entity Name": "Jhon",
"Entity Code": "8590",
"Entity ID": null
}
]
}
],
"Event Group Attributes": {
"Process Flag": "Y",
"Promotion Flag": "Y",
"Run Skey": null,
"Confidential Flag": "Y",
"Processing Complete Flag": "Y",
"Case Description": "case created for alert",
"Case Resolution": "case created",
"Case Comments": "case created",
"Case Summary": "verified and created",
"Case Title": "case:-apisave",
"Case Type Code": "AML_SURV",
"Last Action Code": null,
"Priority Status Code": "NW",
"Priority Code": "Low",
"Scenario Class Code": null,
"Case Due Date": "2023-07-14",
"Case Assignee": "appuser",
"Jurisdiction Code": "AMEA",
"Business Domain": "GEN"
}
}
],
"Entity List": [
{
"Type": "EXTERNAL_ENTITY",
"Business Persisitance": "Y",
"Entity Id": "8590",
"Data Origin": "MAN",
"Focus Flag": "Y"
}
],
"Primary Entity": {
"Entity Id": "8590",
"Entity Type": "EXTERNAL_ENTITY"
}
}
Request
Sample for KYC
Case:{
"Event Group": [
{
"caseId": null,
"Promotion Flag": "Y",
"Event List": [
{
"Event": {
"Event Code": "113100010003512",
"Event Type": "KYC_OB",
"Data Origin": "KYC Onboarding DEV",
"Status Code": "NEW",
"Event Date": "2025-03-04T08:57:57",
"Jurisdiction Code": "APAC",
"Business Domain": "GEN",
"Event Priority": "LOW",
"Event Reason": "",
"Scenario Id": null,
"Scenario Class": null
},
"Event Score": {
"Score": 40,
"Score Code": "INIT_SCORE",
"Score Type": null
},
"Event Entity Map": [
{
"Entity Type": "Prospect",
"Focus Flag": "N",
"DirectEntity Flag": "Y",
"Entity Name": "Prospect",
"Entity Code": "45"
},
{
"Entity Type": "Risk_Assessment",
"Focus Flag": "Y",
"DirectEntity Flag": "Y",
"Entity Name": "Risk_Assessment",
"Entity Code": "45"
}
],
"Event Watchlist Map": {
"Watchlist Skey": "901",
"Event Code": "SAN",
"Event Type": "PRV_WL1-SAN"
},
"Event Screening Matches": [
{
"Alert Id": "122",
"TimeStamp": "2020-07-27T00:00:00Z",
"Column Score": "86.9047622680664",
"Overall Score": "64.7619068622589",
"Rule Id": "1594378741513",
"Business Domain": "a",
"Coulmn Name": "v_full_name",
"Juridiction Code": "AMEA",
"Matched Value": "MARK smith",
"Result Id": "2007270553541000005",
"RuleSet Id": "1589970611175C0",
"Scoring Method": "jarowinkler",
"Search String": "fuzzy",
"Search Type": "fuzzy",
"Source Entity": "Customer",
"Source Index Name": "fcc_idx_privatelist",
"Source Key": "CUUNOPTITMSAC-001",
"Target Index Name": "fcc_idx_privatelist",
"Target Key": "94",
"Watchlist Key Id": "93",
"Ui Json": "{\"srcEntFilter\":[],\"trgtEntFilter\":[{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"I\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":21,\"status\":\"Y\"},{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"SAN\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":23,\"status\":\"Y\"}],\"ruleSetName\":\"Customer to SAN Watchlist Individual Match\",\"ruleSetThreshold\":\"0.6\",\"description\":\"Match Customer to Watchlist based on Individual Attributes\",\"aggregation\":1,\"rules\":[{\"indexCols\":[{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_full_name,\"v_aliases\",\"v_original_script_name\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.4,\"threshold\":0.5,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_alias_nm,\"v_concatenate_name\",\"v_full_nm\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_date_of_births,\"n_yob\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.16,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"d_date_birth\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_city\",\"matchRuleAttrId\":1594378741513,\"weight\":0.15,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_city\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_country,\"v_nationality\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cntry_of_birth,\"v_res_cntry_cd\",\"v_ctzshp_cntry1_cd\",\"v_ctzshp_cntry2_cd\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_address,\"v_residence\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":0.41,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_address\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_title\",\"matchRuleAttrId\":1594378741513,\"weight\":0.04,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_titl_nm\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_gender,\"v_title\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.05,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cust_gndr_cd\",\"status\":\"Y\"}],\"overallThreshold\":0.4,\"ruleName\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"description\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"ruleId\":1594378741513,\"status\":\"Y\"}],\"nTargetEntId\":1,\"version\":25,\"nSourceEntId\":2,\"ruleSetId\":\"1589970611175C0\"}"
}
]
}
],
"Event Group Attributes": {
"Process Flag": "Y",
"Promotion Flag": null,
"Run Skey": null,
"Case Type": "KYC_OB,",
"Busines Domain Code": null,
"Jurisdiction Code": null,
"Case Description": null,
"Case Resolution": null,
"Case Comments": null,
"Case SRC Code": null,
"Case Summary": null,
"Case Title Name": null,
"Case Type Code": "KYC_OB",
"Created By": null,
"Last Action Code": null,
"Priority Code": null,
"Status Code": "NW"
}
}
],
"Entity List": [
{
"Type": "Prospect",
"prospect": "{\"Name Suffix\":\"Jr\",\"Address\":[{\"Street Line 5\":\"ABDUD NASIR RD.\",\"Street Line 6\":\"JAMAL NASIR RD.\",\"Street Line 3\":\"NASIR RD.\",\"Street Line 4\":\"JAMAL ABDUD RD.\",\"Postal Code\":\"560066\",\"Address Sequence Number\":45,\"Street Line 1\":\"JAMAL RD.\",\"Street Line 2\":\"ABDUD RD.\",\"Building Name\":\"ATLAS TOWER\",\"City\":\"Bangalore\",\"Building Number\":\"123\",\"Area\":\"North\",\"State\":\"Karnataka\",\"Street\":\"JAMAL ABDUD NASIR RD HJ\",\"Region\":\"Karnataka\",\"Country\":\"BM\",\"Address Purpose Code\":\"B\"}],\"Credit Rating\":[{\"Credit Rating Source\":\"MOODY\",\"Credit Rating\":\"AAA\",\"Credit Rating Sequence Number\":45}],\"Product\":[{\"Product Offer Initiation Date\":\"07/23/2021\",\"dateRangeCorrect\":true,\"Product Sequence Number\":45,\"Product Offered\":\"string\",\"Product Offer Expiration Date\":\"07/23/2031\"}],\"Region Company Is Licensed To Operate In\":[\"\"],\"Gender\":\"M\",\"Job Title\":\"CEO\",\"Is Linked to related party who is PEP\":\"\",\"City of Residence\":null,\"Existing Internal ID\":\"\",\"Website URL\":null,\"Organization Name\":null,\"Public Or Private\":null,\"Custom String Array 1\":null,\"Custom String Array 2\":null,\"Country\":[{\"Relationship Type\":\"C\",\"Country List\":null,\"Country\":\"AE\",\"Country Sequence Number\":45}],\"isLinkdToRelatdPartyPep\":\"\",\"Last Name\":\"Ahmed\",\"Custom String Array 5\":null,\"Custom String Array 3\":null,\"Custom String Array 4\":null,\"PEP Flag\":null,\"Custom String 1\":null,\"Custom String 3\":null,\"Custom Numeric 1\":null,\"Custom String 2\":null,\"Custom String 5\":null,\"Custom String 4\":null,\"Applicant ID\":\"MAYPROVMIG1D\",\"Type Of Account Opening\":[\"OFF\",\"ON\"],\"Custom Numeric 3\":null,\"Custom Numeric 2\":null,\"Custom Numeric 5\":null,\"Custom Numeric 4\":null,\"Financials\":{\"Stated Monthly Txn Count\":null,\"Stated Total Annual Income Base\":null,\"Stated Total Liquid Net Worth Base\":1222,\"Income Currency\":\"USD\",\"Stated Total Net Worth Base\":1222.098,\"Financial Sequence Number\":45,\"Stated Annual Proportion of Cash Transaction\":null,\"Stated Total Annual Turnover\":null,\"Stated Monthly Txn Amount in Local Currency\":null},\"Employment Status\":\"EMP\",\"Expected to Transact with High Risk Countries List\":null,\"Custom Flag 2\":null,\"Custom Flag 1\":null,\"Custom Flag 4\":null,\"Custom Flag 3\":null,\"Request ID\":45,\"SSN/TIN\":\"123456789\",\"Occupation\":[\"AGR\"],\"Country Of Residence\":[\"TO\",\"USA\"],\"Custom Flag 5\":null,\"Relationship\":null,\"Source Of Wealth\":[\"KD\",\"MA\"],\"Assessment Mode\":\"FULL_KYC\",\"Employer Industry\":\"Casino\",\"First Name\":\"MAHRI\",\"Employer Name\":\"Jeni Inc\",\"Industry\":[\"INS\",\"OG\",\"APR\"],\"Prospect Id\":45,\"Country Of Incorporation\":\"TO\",\"Employment Type\":\"Official\",\"Retirement Year\":null,\"Country Of Birth\":\"Spn\",\"Number Of Dependents\":5,\"Organization Legal Structure\":null,\"Customer Segment\":null,\"Date Of Birth\":\"02/02/2020\",\"Expected to transact in foreign Currency Flag\":null,\"Custom Date 2\":null,\"Custom Date 1\":null,\"CIP Verified Flag\":\"A\",\"Data Origin\":\"KYC Onboarding DEV\",\"Prospect Type\":\"FIN\",\"Marital Status\":\"MA\",\"Date Of Incorporation\":null,\"Custom Date 4\":null,\"Custom Date 3\":null,\"NAICS Code\":null,\"Primary Prospect Flag\":\"Y\",\"Custom Date 5\":null,\"Email Address\":[{\"Email Sequence Number\":1,\"Email Purpose\":\"P\",\"Email Address\":\"jamal@yahoo.co.in\"}],\"Expected to Transact with High Risk Country\":\"\",\"Is National of Sanctioned Country Flag\":\"\",\"CIP Exempt Flag\":\"N\",\"CIP Verified Status\":\"CIPV\",\"Middle Name\":\"Mohamed Ben\",\"Phone\":[{\"Phone Purpose\":\"B\",\"Phone Sequence Number\":1,\"Country Code Of Phone Number\":\"001\",\"Phone Extension\":\"621\",\"Phone Number\":\"9878798-9877-9876\"}],\"Age\":0,\"Account Type\":null,\"Display Name\":\"Funding Circle USA\",\"Market Served\":[{\"Market Served\":\"string\",\"dateRangeCorrect\":true,\"Market Served Sequence Number\":45,\"Service Effective Date\":\"07/23/2020\",\"Service Expiration Date\":\"07/23/2030\"}],\"Identification Document\":[{\"Issuing Date\":\"01/01/2020\",\"Issuing District\":\"Phil\",\"Document Name\":\"1234\",\"Document Purpose\":\"CID\",\"Issuing County\":\"Texas\",\"dateRangeCorrect\":true,\"Issuing State\":\"Kansas\",\"Issuing City\":\"California\",\"Machine Readable Zone 1\":\"P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<\",\"Document Number\":\"12\",\"Machine Readable Zone 2\":\"L898902C<3UTO6908061F9406236ZE184226B<<<<<14\",\"Issuing Country\":\"USA\",\"Document Sequence Number\":45,\"Issuing Authority\":\"Passport Office\",\"Expiry Date\":\"01/01/2099\",\"Issuing Province\":\"North\"}],\"Prospect Jurisdiction\":[\"APAC\"],\"Citizenship Status\":\"C\",\"Length Of Relationship\":50,\"Onboarding Branch Code\":null,\"Title\":\"Mr\",\"Family PEP Flag\":\"Y\",\"Primary Citizenship\":\"USA\",\"Alias\":[\"My laden Company\"],\"Country Of Taxation\":[\"USA\"],\"Secondary Citizenship\":[\"TO\",\"USA\"]}",
"riskAssesment": null,
"Business Persisitance": null,
"Entity Id": 45,
"Data Origin": null,
"Focus Flag": null
},
{
"Type": "Risk_Assessment",
"prospect": null,
"riskAssesment": "{\"Business Check\":\"{\\\"Rule Details\\\":[{\\\"Rule Score\\\":20,\\\"Rule Code\\\":\\\"RALSAO\\\",\\\"Rule Value\\\":[\\\"--\\\"]}],\\\"Score\\\":20,\\\"Prospect ID\\\":\\\"45\\\"}\",\"prospectMap\":[{\"Prospect Id\":45,\"Assessment Mode\":\"FULL_KYC\"}],\"Risk Assessment ID\":45,\"Application ID\":\"3\",\"Risk Assessment Category\":\"L\",\"Data Origin\":\"KYC Onboarding DEV\",\"Request ID\":45,\"Prospect Type\":\"FIN\",\"Business Domain\":\"GEN\",\"Risk Assessment Score\":20,\"Jurisdiction\":\"APAC\",\"Prospect ID\":45,\"Threshold Breached Flag\":\"Y\",\"KYC Scoring\":\"{\\\"Score\\\":15,\\\"Prospect ID\\\":\\\"45\\\",\\\"Rule Category\\\":[{\\\"Rule Category Name\\\":\\\"RCFI1\\\",\\\"Rule Details\\\":[{\\\"Rule Score\\\":5,\\\"Rule Code\\\":\\\"RALSAO\\\",\\\"Rule Weightage\\\":50,\\\"Conf Rule Score\\\":10,\\\"Rule Value\\\":[\\\"--\\\"],\\\"Category Weighed Rule Score\\\":5},{\\\"Rule Score\\\":10,\\\"Rule Code\\\":\\\"GR_COO\\\",\\\"Rule Weightage\\\":50,\\\"Conf Rule Score\\\":20,\\\"Rule Value\\\":[\\\"USA\\\"],\\\"Category Weighed Rule Score\\\":10}],\\\"Rule Category Weightage\\\":100,\\\"Rule Category Score\\\":15}]}\",\"watchlistMatches\":\"\",\"Primary Prospect Flag\":\"Y\"}",
"Business Persisitance": null,
"Entity Id": 45,
"Data Origin": null,
"Focus Flag": null
}
],
"Primary Entity": {
"Entity Id": 45,
"Entity Type": "PROSPECT"
}
}
Request
Sample for CS
Case:{
"Event Group": [
{
"caseId": null,
"Promotion Flag": "Y",
"Event Group Attributes": {
"Process Flag": "Y",
"Promotion Flag": "Y",
"Processing Complete Flag": "Y",
"Run Skey": null,
"Case Type Code": "CS_RT_SAN",
"Busines Domain Code": "GEN",
"Jurisdiction Code": null,
"Case Description": "RT Case",
"Case Resolution": "RT Case",
"Case Comments": "RT Case",
"Case Summary": "RT Case",
"Status Code": "NW",
"Priority Code": "High",
"Case Title": "RTCase Creation1",
"Case SRC Code": null
},
"Event List": [
{
"Event": {
"Event Code": "4000",
"Event Type": "CS_RT_SAN",
"Data Origin": "MAN",
"Status Code": "NEW",
"Mis Date": "2020-07-27T00:00:00Z",
"Jurisdiction Code": "AMEA",
"Business Domain": "GEN",
"Event Priority": "HIGH",
"Event Reason": "new customer"
},
"Event Score": {
"Score": 20,
"Score Code": "INIT_SCORE",
"Score Type": null
},
"Event Screening Matches": [
{
"Alert Id": "122",
"TimeStamp": "2020-07-27T00:00:00Z",
"Column Score": "86.9047622680664",
"Overall Score": "64.7619068622589",
"Rule Id": "1594378741513",
"Business Domain": "a",
"Coulmn Name": "v_full_name",
"Juridiction Code": "AMEA",
"Matched Value": "MARK smith",
"Result Id": "2007270553541000005",
"RuleSet Id": "1589970611175C0",
"Scoring Method": "jarowinkler",
"Search String": "fuzzy",
"Search Type": "fuzzy",
"Source Entity": "Customer",
"Source Index Name": "fcc_idx_privatelist",
"Source Key": "CUUNOPTITMSAC-001",
"Target Index Name": "fcc_idx_privatelist",
"Target Key": "94",
"Watchlist Key Id": "93",
"Ui Json": "{\"srcEntFilter\":[],\"trgtEntFilter\":[{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"I\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":21,\"status\":\"Y\"},{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"SAN\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":23,\"status\":\"Y\"}],\"ruleSetName\":\"Customer to SAN Watchlist Individual Match\",\"ruleSetThreshold\":\"0.6\",\"description\":\"Match Customer to Watchlist based on Individual Attributes\",\"aggregation\":1,\"rules\":[{\"indexCols\":[{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_full_name,\"v_aliases\",\"v_original_script_name\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.4,\"threshold\":0.5,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_alias_nm,\"v_concatenate_name\",\"v_full_nm\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_date_of_births,\"n_yob\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.16,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"d_date_birth\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_city\",\"matchRuleAttrId\":1594378741513,\"weight\":0.15,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_city\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_country,\"v_nationality\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cntry_of_birth,\"v_res_cntry_cd\",\"v_ctzshp_cntry1_cd\",\"v_ctzshp_cntry2_cd\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_address,\"v_residence\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":0.41,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_address\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_title\",\"matchRuleAttrId\":1594378741513,\"weight\":0.04,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_titl_nm\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_gender,\"v_title\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.05,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cust_gndr_cd\",\"status\":\"Y\"}],\"overallThreshold\":0.4,\"ruleName\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"description\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"ruleId\":1594378741513,\"status\":\"Y\"}],\"nTargetEntId\":1,\"version\":25,\"nSourceEntId\":2,\"ruleSetId\":\"1589970611175C0\"}"
}
],
"Event Watchlist Map": {
"Watchlist Skey": "901",
"Event Code": "SAN",
"Event Type": "PRV_WL1-SAN"
},
"Event Entity Map": [
{
"Focus Flag": "Y",
"DirectEntity Flag": "Y",
"Entity Type": "WATCHLIST",
"Entity Name": "Amanda",
"Entity Code": "CSRT_10",
"Entity ID": null
}
]
},
{
"Event": {
"Event Code": "4001",
"Event Type": "CS_RT_SAN",
"Data Origin": "MAN",
"Status Code": "NEW",
"Mis Date": "2020-07-27T00:00:00Z",
"Jurisdiction Code": "AMEA",
"Business Domain": "GEN",
"Event Priority": "HIGH",
"Event Reason": "new customer"
},
"Event Score": {
"Score": 20,
"Score Code": "INIT_SCORE",
"Score Type": null
},
"Event Screening Matches": [
{
"Alert Id": "122",
"TimeStamp": "2020-07-27T00:00:00Z",
"Column Score": "86.9047622680664",
"Overall Score": "64.7619068622589",
"Rule Id": "1594378741513",
"Business Domain": "a",
"Coulmn Name": "v_full_name",
"Juridiction Code": "AMEA",
"Matched Value": "MARK smith",
"Result Id": "2007270553541000005",
"RuleSet Id": "1589970611175C0",
"Scoring Method": "jarowinkler",
"Search String": "fuzzy",
"Search Type": "fuzzy",
"Source Entity": "Customer",
"Source Index Name": "fcc_idx_privatelist",
"Source Key": "CUUNOPTITMSAC-001",
"Target Index Name": "fcc_idx_privatelist",
"Target Key": "94",
"Watchlist Key Id": "93",
"Ui Json": "{\"srcEntFilter\":[],\"trgtEntFilter\":[{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"I\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":21,\"status\":\"Y\"},{\"trgtFilterOptr\":\"like\",\"trgtFilterValue\":\"SAN\",\"trgtFilterId\":1594378741513,\"trgtFilterAttr\":23,\"status\":\"Y\"}],\"ruleSetName\":\"Customer to SAN Watchlist Individual Match\",\"ruleSetThreshold\":\"0.6\",\"description\":\"Match Customer to Watchlist based on Individual Attributes\",\"aggregation\":1,\"rules\":[{\"indexCols\":[{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_full_name,\"v_aliases\",\"v_original_script_name\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.4,\"threshold\":0.5,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_alias_nm,\"v_concatenate_name\",\"v_full_nm\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_date_of_births,\"n_yob\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.16,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"d_date_birth\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_city\",\"matchRuleAttrId\":1594378741513,\"weight\":0.15,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_city\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_country,\"v_nationality\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cntry_of_birth,\"v_res_cntry_cd\",\"v_ctzshp_cntry1_cd\",\"v_ctzshp_cntry2_cd\"\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":2,\"targetAttribute\":\"v_address,\"v_residence\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.1,\"threshold\":0.41,\"window\":\"\",\"scoringMethod\":2,\"srcAttribute\":\"v_address\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_title\",\"matchRuleAttrId\":1594378741513,\"weight\":0.04,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_titl_nm\",\"status\":\"Y\"},{\"condition\":\"or\",\"searchString\":[],\"searchType\":1,\"targetAttribute\":\"v_gender,\"v_title\"\",\"matchRuleAttrId\":1594378741513,\"weight\":0.05,\"threshold\":1,\"window\":\"\",\"scoringMethod\":null,\"srcAttribute\":\"v_cust_gndr_cd\",\"status\":\"Y\"}],\"overallThreshold\":0.4,\"ruleName\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"description\":\"Name ,\"DOB\", \"Gender\" and Address match\",\"ruleId\":1594378741513,\"status\":\"Y\"}],\"nTargetEntId\":1,\"version\":25,\"nSourceEntId\":2,\"ruleSetId\":\"1589970611175C0\"}"
}
],
"Event Watchlist Map": {
"Watchlist Skey": "901",
"Event Code": "SAN",
"Event Type": "PRV_WL1-SAN"
},
"Event Entity Map": [
{
"Focus Flag": "N",
"DirectEntity Flag": "Y",
"Entity Type": "candidate",
"Entity Name": "CS",
"Entity Code": "CSRT_10",
"Entity ID": null
}
]
}
]
}
],
"Entity List": [
{
"Type": "WATCHLIST",
"Watchlist Matched": {
"Run Skey": null,
"Watchlist Skey": 486,
"Json Text": "{\"v_title\":\" \",\"v_full_name\":\"Amanda Milne\",\"v_citi_country\":\" \",\"v_alias_middle_name\":\" \",\"v_address_country_code\":\" \",\"n_entity_registration_number\":\"0\",\"v_aliases_family_name\":\" \",\"v_identification_type\":\" \",\"watchlist_name_type\":\" \",\"v_alias_title\":\" \",\"v_identification_numbers\":\" \",\"v_address\":\"16528 Kim Parkway\",\"f_is_active\":\"Y\",\"n_tracking_number\":\" \",\"v_national_id\":\" \",\"v_nationality\":\"US\",\"v_jurisdiction_cd\":\"AMEA\",\"v_entity_name\":\" \",\"v_aliases\":\" \",\"d_load_date\":\"2023-05-12 12:57:21.199\",\"v_original_script_name\":\" \",\"v_other_party_name\":\" \",\"v_description\":\" \",\"v_wl_sub_type\":\"SAN\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\" \",\"d_lastupdateddate\":\"2025-02-14 05:10:06.452\",\"v_entity_sub_type\":\" \",\"v_occupation\":\" \",\"v_entity_registration_country_code\":\" \",\"v_passports_country\":\"US\",\"v_incorporated\":\" \",\"d_fincen_notification_date\":\" \",\"n_uid\":486,\"v_wl_type\":\"PRV_WL1\",\"v_middle_name\":\" \",\"v_aliases_given_name\":\" \",\"v_state\":\"Colorado\",\"v_citizenship\":\" \",\"v_place_of_birth\":\" \",\"v_city\":\"Colorado Springs\",\"v_further_information\":\" \",\"v_given_name\":\"Amanda\",\"v_entity_operating_country_codes\":\" \",\"f_fincen_uploaded_list\":\"N\",\"n_wl_skey\":486,\"v_date_of_births\":\"1975-04-07\",\"v_street\":\" \",\"v_identification_country\":\"US\",\"v_yob\":\" \",\"n_run_skey\":\" \",\"v_gender\":\" \",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"Milne\",\"v_town_of_birth\":\" \",\"n_riskscore\":0,\"v_phone\":\" \",\"v_postal_code\":\"80915\",\"v_entity_type\":\"I\",\"v_alias_city_of_birth\":\" \",\"v_country\":\"US\"}"
},
"Candidate Ev": {
"Json Text": null,
"Applicant ID": null,
"Candidate Skey": null,
"Run Skey": null,
"Data Origin": null
}
},
{
"Type": "WATCHLIST",
"Watchlist Matched": {
"Run Skey": null,
"Watchlist Skey": 696,
"Json Text": "{\"v_title\":\" \",\"v_full_name\":\"Amanda Milne\",\"v_citi_country\":\" \",\"v_alias_middle_name\":\" \",\"v_address_country_code\":\" \",\"n_entity_registration_number\":\"0\",\"v_aliases_family_name\":\" \",\"v_identification_type\":\" \",\"watchlist_name_type\":\" \",\"v_alias_title\":\" \",\"v_identification_numbers\":\" \",\"v_address\":\"16528 Kim Parkway\",\"f_is_active\":\"Y\",\"n_tracking_number\":\" \",\"v_national_id\":\" \",\"v_nationality\":\"US\",\"v_jurisdiction_cd\":\"AMEA\",\"v_entity_name\":\" \",\"v_aliases\":\" \",\"d_load_date\":\"2023-05-12 12:57:21.199\",\"v_original_script_name\":\" \",\"v_other_party_name\":\" \",\"v_description\":\" \",\"v_wl_sub_type\":\"SAN\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\" \",\"d_lastupdateddate\":\"2025-02-14 05:10:07.597\",\"v_entity_sub_type\":\" \",\"v_occupation\":\" \",\"v_entity_registration_country_code\":\" \",\"v_passports_country\":\"US\",\"v_incorporated\":\" \",\"d_fincen_notification_date\":\" \",\"n_uid\":696,\"v_wl_type\":\"PRV_WL1\",\"v_middle_name\":\" \",\"v_aliases_given_name\":\" \",\"v_state\":\"Colorado\",\"v_citizenship\":\" \",\"v_place_of_birth\":\" \",\"v_city\":\"Colorado Springs\",\"v_further_information\":\" \",\"v_given_name\":\"Amanda\",\"v_entity_operating_country_codes\":\" \",\"f_fincen_uploaded_list\":\"N\",\"n_wl_skey\":696,\"v_date_of_births\":\"1975-04-07\",\"v_street\":\" \",\"v_identification_country\":\"US\",\"v_yob\":\" \",\"n_run_skey\":\" \",\"v_gender\":\" \",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"Milne\",\"v_town_of_birth\":\" \",\"n_riskscore\":0,\"v_phone\":\" \",\"v_postal_code\":\"80915\",\"v_entity_type\":\"I\",\"v_alias_city_of_birth\":\" \",\"v_country\":\"US\"}"
},
"Candidate Ev": {
"Json Text": null,
"Applicant ID": null,
"Candidate Skey": null,
"Run Skey": null,
"Data Origin": null
}
},
{
"Type": "WATCHLIST",
"Watchlist Matched": null,
"Run Skey": null,
"Watchlist Skey": 315,
"Json Text": "{\"v_title\":\" \",\"v_full_name\":\"Amanda Milne\",\"v_citi_country\":\" \",\"v_alias_middle_name\":\" \",\"v_address_country_code\":\" \",\"n_entity_registration_number\":\"0\",\"v_aliases_family_name\":\" \",\"v_identification_type\":\" \",\"watchlist_name_type\":\" \",\"v_alias_title\":\" \",\"v_identification_numbers\":\" \",\"v_address\":\"16528 Kim Parkway\",\"f_is_active\":\"Y\",\"n_tracking_number\":\" \",\"v_national_id\":\" \",\"v_nationality\":\"US\",\"v_jurisdiction_cd\":\"AMEA\",\"v_entity_name\":\" \",\"v_aliases\":\" \",\"d_load_date\":\"2023-05-12 12:57:21.199\",\"v_original_script_name\":\" \",\"v_other_party_name\":\" \",\"v_description\":\" \",\"v_wl_sub_type\":\"SAN\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\" \",\"d_lastupdateddate\":\"2025-02-14 05:10:05.456\",\"v_entity_sub_type\":\" \",\"v_occupation\":\" \",\"v_entity_registration_country_code\":\" \",\"v_passports_country\":\"US\",\"v_incorporated\":\" \",\"d_fincen_notification_date\":\" \",\"n_uid\":315,\"v_wl_type\":\"PRV_WL1\",\"v_middle_name\":\" \",\"v_aliases_given_name\":\" \",\"v_state\":\"Colorado\",\"v_citizenship\":\" \",\"v_place_of_birth\":\" \",\"v_city\":\"Colorado Springs\",\"v_further_information\":\" \",\"v_given_name\":\"Amanda\",\"v_entity_operating_country_codes\":\" \",\"f_fincen_uploaded_list\":\"N\",\"n_wl_skey\":315,\"v_date_of_births\":\"1975-04-07\",\"v_street\":\" \",\"v_identification_country\":\"US\",\"v_yob\":\" \",\"n_run_skey\":\" \",\"v_gender\":\" \",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"Milne\",\"v_town_of_birth\":\" \",\"n_riskscore\":0,\"v_phone\":\" \",\"v_postal_code\":\"80915\",\"v_entity_type\":\"I\",\"v_alias_city_of_birth\":\" \",\"v_country\":\"US\"}",
"Candidate Ev": {
"Json Text": null,
"Applicant ID": null,
"Candidate Skey": null,
"Run Skey": null,
"Data Origin": null
}
},
{
"Type": "CANDIDATE",
"Watchlist Matched": {
"Run Skey": null,
"Watchlist Skey": null,
"Json Text": null
},
"Candidate Ev": {
"Json Text": "{\"Identification Document\":[{\"Document Number\":\"\",\"Document Type\":\"\",\"Issuing Country\":\"\",\"seqid\":1}],\"Address\":[{\"Address Type\":\"\",\"Postal Code\":\"\",\"Street Line 1\":\"\",\"State\":\"\",\"Country\":\"\",\"City\":\"\",\"seqid\":1}],\"First Name\":\"Amanda\",\"Full Name\":\"Amanda\",\"Title\":\"\",\"Candidate ID\":10,\"Middle Name\":\"\",\"Gender\":\"\",\"Source Request ID\":\"\",\"Year Of Birth\":\"1978\",\"Applicant ID\":\"CSRT_10\",\"Business Domain\":\"GEN\",\"searchWithCase\":true,\"SSN/TIN\":\"\",\"Primary Citizenship\":\"\",\"Country Of Residence\":\"\",\"Policy ID\":\"\",\"Customer ID\":\"\",\"Candidate Type\":\"IND\",\"Existing Internal ID\":\"\",\"Candidate Jurisdiction\":\"AMEA\",\"Last Name\":\"Milne\",\"Country Of Birth\":\"\",\"Secondary Citizenship\":\"\"}",
"Applicant ID": "CSRT_10",
"Candidate Skey": null,
"Run Skey": null,
"Data Origin": "MAN"
}
}
],
"Primary Entity": null
}
Response
Sample:{
"CaseList": [
{
"Case InternalId": "CA17140",
"CaseId": 17140,
"EventCode": [
10661
]
}
],
"RunSkey": 1460
}
Table 4-12 Status codes and their status
Case_Status_Code | Case_Status |
---|---|
CCFP | Closed False Positive |
CCTMEC | Closed True Match Exit Completed |
CCTMER | Closed True Match Exit Required |
CCTMM | Closed True Match Monitored |
CCTNM | Closed True Match Not Monitored |
CLS_AE | Closed Auto Eliminated |
INV | Investigation |
NW | New |
PNDR | Pending Review |
RNPR | Review in Progress |
Note:
When the API request encounters an error, it generates a 400 Bad Request response with "STATUS": "ERROR".
This status code typically indicates that the request could not be processed due to invalid syntax, incorrect parameters, or other client-side issues.
Sample error message: (400 Bad Request)
{
"STATUS": "ERROR", "message": "ERROR in Executing Query, Please check you Filter and Join
Conditions" }