4.11 Add Account to Case

This service will allow addition of accounts to an existing ECM case.

The following topics explain how to add accounts to an existing case.

HTTP Link

http:// <Application URL>/rest-api/ECMService/CaseManagementService/addAccount

Service Type

The service type is POST.

Request Parameters

The following table describes the details of the parameters.

Table 4-21 Request Parameter Details

First Level Second Level Third Level Details
caseId - - This accepts the case internal identifier.
accounts accountId - This accepts the account internal identifier.
accounts businessAdd - This identifies whether account addition needs to be done from business or not. Y states account needs to be added from business. N states account needs to be manually added.
accounts accountName - This accepts the account name.
accounts type1 - This accepts the account type1.
accounts type2 - This accepts the account type2.
accounts registrationType - This accepts the account registration type.
accounts ownerTypeCode - This accepts the account owner type Code value.
accounts taxIdFormatCode - This accepts the account tax identifier format code value.
accounts taxId - This accepts the account tax identifier.
accounts firmId - This accepts the account firm identifier.
accounts taxWithHoldCode - This identifies whether firm withhold taxes or not. Y states firm is to Withhold Taxes. N states firm is not to Withhold Taxes.
accounts jurisdictionCode - This accepts the account jurisdiction code value.
accounts businessDomainCode - This accepts the account business domain code value.
accounts houseHoldGroupId - This accepts the account household group identifier.
accounts legalEntity - This accepts the account legal entity value.
accounts openDate - This accepts the account open date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts closeDate - This accepts the account close date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts accountStatusCode - This accepts the account status code value.
accounts statusEffectiveDate - This accepts the account status effective date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts branch - This accepts the branch code value.
accounts businessUnit - This accepts the account business unit value.
accounts discretionFlag - This identifies whether the investment advisor associated with this account has discretion to execute trades on behalf of its account owner. Y states investment advisor has discretion. N states does not have discretion.
accounts lastActivityDate - This accepts the account last activity date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts primeBrokerFlag - This identifies whether this account is affiliated with a prime broker or not. Y states account is affiliated with a prime broker. N states account is not affiliated with a prime broker
accounts oracleAccountPurposeCode - This accepts the Oracle account purpose code value.
accounts oracleBusinessTypeCode - This accepts the Oracle business type code value.
accounts effectiveRisk - This accepts the account effective risk value.
accounts businessRisk - This accepts the account business risk value.
accounts listRisk - This accepts the account list risk value.
accounts geoRisk - This accepts the account geography risk value.
accounts kycRisk - This accepts the account KYC risk value.
accounts contactInformation addressLine1 This accepts the address line1 for account contact information.
accounts contactInformation addressLine2 This accepts the address line2 for account contact information.
accounts contactInformation addressLine3 This accepts the address line3 for account contact information.
accounts contactInformation addressLine4 This accepts the address line4 for account contact information.
accounts contactInformation addressLine5 This accepts the address line5 for account contact information.
accounts contactInformation addressLine6 This accepts the address line6 for account contact information.
accounts contactInformation city This accepts the city for account contact information.
accounts contactInformation state This accepts the state for account contact information.
accounts contactInformation postalCode This accepts the postal code for account contact information.
accounts contactInformation countryCode This accepts the country code value for account contact information.
accounts contactInformation regionName This accepts the region name for account contact information.
accounts contactInformation addressTypeCode This accepts the type code value for account contact information.
accounts riskListMembership riskSource This accepts the risk list membership risk source value for the account.
accounts riskListMembership addedDate This accepts the risk list membership added date time for the account. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts riskListMembership removedDate This accepts the risk list membership removed date time for the account. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts riskListMembership entryDescription This accepts the risk list membership entry description for the account.
accounts accountRestriction restrictionCode This accepts the account restriction code value for the account.
accounts accountRestriction addedDate This accepts added date time for the account restriction. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS.
accounts accountRestriction removedDate This accepts the removed date time for the account restriction. This needs to be specified in ISO format YYYY- MM-DD HH24:MM:SS.
accounts accountManagement employeeId This accepts the employee identifier of the account.
accounts accountManagement role This accepts the role code value for the account.
accounts genericInformation description This accepts generic information about the account.

Request JSON Sample

This section contains a request JSON sample to add account to an existing case. The API will accept multiple caseIds and accounts information to be added to the case. The entries in this sample are only for reference purposes.

[
{
"caseId": "CA100",
"accounts": [
{
"accountId": "ACCIDIOSRMAC-001",
"businessAdd": "N",
"accountName": "RAMPEE",
"type1": "INV",
"type2": "INV",
"registrationType": "IND",
"ownerTypeCode": "CUST",
"taxIdFormatCode": "S",
"taxId": "TX123",
"firmId": "CUIDIOSRMAC-001",
"taxWithHoldCode": "Y",
"jurisdictionCode": "AMEA",
"businessDomainCode": "A",
"houseHoldGroupId": "HHSAMPLE00",
"legalEntity": "BGMC_ACCT_001",
"openDate": "2021-06-24 11:00:48",
"closeDate": "2021-06-24 11:00:48",
"accountStatusCode": "A",
"statusEffectiveDate": "2021-06-24 11:00:48",
"branch": "ORGTRUNAPPTRGAC-001",
"businessUnit": "TestOrgA",
"discretionFlag": "Y",
"lastActivityDate": "2021-06-24 11:00:48",
"primeBrokerFlag": "N",
"oracleAccountPurposeCode": "O",
"oracleBusinessTypeCode": "RBR",
"effectiveRisk": 10,
"businessRisk": 10,
"listRisk": 10,
"geoRisk": 10,
"kycRisk": 10,
"contactInformation": [
{
"addressLine1": "Wall Street 101",
"addressLine2": "College Road",
"addressLine3": "Near Bentley Showroom",
"addressLine4": "Next to Rod Stadium",
"addressLine5": "Max Lab Division",
"addressLine6": "Power Lane",
"city": "New York",
"state": "North",
"postalCode": "12345-123",
"countryCode": "US",
"regionName": "AMERICA",
"addressTypeCode": "B"
}
],
"riskListMembership": [
{
"riskSource": "P8C",
"addedDate": "2022-06-15 10:00:00",
"removedDate": "2022-06-20 10:00:48",
"entryDescription": "P8C"
}
],
"accountRestriction": [
{
"restrictionCode": "NC",
"addedDate": "2022-06-15 10:02:00",
"removedDate": "2022-06-15 10:02:00"
}
],
"accountManagement": [
{
"employeeId": "EMPTRUNAPPTRGAC-002",
"role": "OWNER"
}
],
"genericInformation": {
"Account Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234",
"Account No": "AD1234567"
},
"Enterprise Account Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fraudulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}
]
}
]

Response Parameters

The following table describes the details of the response parameters.

Table 4-22 Parameter Details

First Level Second Level Third Level Details
MESSAGE Displays the overall response message from the API.
STATUS Displays the overall status of the API call whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED and in case of partial success it will be represented by PARTIALSUCCESS.
RESULTARRAY MESSAGE Displays the response message from the API for the respective case.
RESULTARRAY STATUS Displays the status of the API call for the respective case whether it was successful or failed. In case of success it will be represented by SUCCESS and in case of failure it will be represented by FAILED and in case of partial success it will be represented by PARTIALSUCCESS.
RESULTARRAY caseId Displays the case internal identifier on which the API was called.
RESULTARRAY accounts MESSAGE Displays the response message from the API for the respective account under the respective case.
RESULTARRAY accounts STATUS Displays the status of the API call for the respective account under the respective case whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED.
RESULTARRAY accounts accountId Displays the account internal identifier under the respective case on which the API was called.

Response JSON Sample

This section contains a response JSON sample for when account addition to an existing case is successful. The entries in this sample are only for reference purposes. Refer to Improvements in Real Time Event Creation APIs for additional Response JSON samples.
"MESSAGE": "Accounts addition was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Accounts addition was successful.",
"STATUS": "SUCCESS",
"caseId": "CA120",
"accounts": [
{
"MESSAGE": "Account added successfully.",
"STATUS": "SUCCESS",
"accountId": "ACCT1"
},
{
"MESSAGE": "Account added successfully.",
"STATUS": "SUCCESS",
"accountId": "ACCIDIOSRMAC-001"
}
]
}
]
}