Using Case Creation using saveEvents API

End Point Details

This REST API is used to execute Real-time KYC Risk Assessment.

HTTP Link - http://<hostname>:<port>//event/saveEvents
Method – POST
Content-Type - Application/JSON

Executing Casecreation API

To execute the save events API, follow the steps mentioned in Executing iHUB Case Status Feedback Request section.

Request JSON Parameters

Note:

Parameters marked with * Asterisks are mandatory.

Table 5-1 Parameters and their values

Parameter	Value Type	Description
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.
Event Code	String	Unique Event code on which the event gets generated.
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.
Jurisdiction Code	String	The jurisdiction of the event.
Business Domain	String	The corresponding business domain of the event.
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.
Score	Number	Score generated for the event.
Score Code	String	Score code on which Event score has been generated.
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.
Process Flag	String	Flag for the process the entry in the pre-case table to case table.
Processing Complete Flag	String	The Flag to update after the case creation is completed.
Case Description	String	Case description for the case generated.
Case Comments	String	Comments on the case creation.
Case Summary	String	More information about case creation.
Case Title	String	Title of the case that to be generated.
Case Type Code	String	Type of the case.
Priority Status Code	String	Priority status of the case.
Priority Code	String	Priority of the case.
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	String	The corresponding business domain of the case.
Type	String	Type of the entity associated.
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.
Entity Id	Number	Identity value of entity associated.
Entity Type	String	Type of the entity associated.

Response JSON Parameters

response will contain result array that contains case status for each case.

Table 5-2 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.
RunSkey	Number	Unique number generated for the entire case creation process.

Request and Response JSON Sample

This section contains a request JSON sample for the onboarding JSON. The entries in this sample are only for reference purposes.

Request JSON Sample

{

  "Event Group": [

    {

      "Promotion Flag": "Y",

      "Event List": [

        {

          "Event": {

            "Event Code": "4503",

            "Event Type": "AML",

            "Data Origin": "CMCSMAN",

            "Status Code": "NEW",

            "Jurisdiction Code": "AMEA",

            "Business Domain": "GEN",

            "Event Priority": null,

            "Event Reason": "trans amt=3000",

            "Scenario Id": 132

          },

          "Event Score": {

            "Score": 0,

            "Score Code": ""

          },

          "Event Entity Map": [

            {

              "Entity Type": "CUSTOMER",

              "Focus Flag": "Y",

              "DirectEntity Flag": "Y",

              "Entity Name": "",

              "Entity Code": "4340"

            }

          ]

        }

      ],

      "Event Group Attributes": {

        "Process Flag": "Y",

        "Processing Complete Flag": "Y",

        "Case Description": "test desc",

        "Case Comments": "",

        "Case Summary": "",

        "Case Title": "Test AML Surv Case ",

        "Case Type Code": "AML_SURV",

        "Priority Status Code": "NW",

        "Priority Code": "High",

        "Scenario Class Code": null,

        "Case Due Date": "2023-06-15",

        "Case Assignee": "",

        "Jurisdiction Code": "AMEA",

        "Business Domain": "GEN"

      }

    }

  ],

  "Entity List": [{

      "Type": "CUSTOMER",

      "Business Persisitance": "Y",

      "Entity Id": "4340",

      "Data Origin": "MAN",

      "Focus Flag": "Y"

    }

  ],

  "Primary Entity": {

    "Entity Id": "4340",

    "Entity Type": "CUSTOMER"

  }

}

Response JSON Sample

{

    "CaseList": [

        {

            "Case InternalId": "CA7940",

            "CaseId": 7940,

            "EventCode": [

                4503

            ]

        }

    ],

    "RunSkey": 1220

}