4.8 Add Customer to Case
This service will allow customers to be added to an existing case.
The following topics explain how to add Customers to an existing Case.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/ECMService/CaseManagementService/addCustomer
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-15 Request Parameter Details
| First Level | Second Level | Third Level | Details |
|---|---|---|---|
| caseId | - | - | This accepts the case internal identifier. |
| customers | customerId | - | This accepts the customer internal identifier. |
| customers | businessAdd | - | This identifies whether customer addition needs to be done from business or not. Y states customer needs to be added from business. N states customer needs to be manually added. |
| customers | customerTypeCode | - | This accepts the customer type code value. |
| customers | firstName | - | This accepts the customer’s first name. |
| customers | middleName | - | This accepts the customer’s middle name. |
| customers | lastName | - | This accepts the customer’s last name. |
| customers | customerOrganizationName | - | This accepts the customer organization name. |
| customers | taxIdFormatCode | - | This accepts the customer tax identifier format code value. |
| customers | taxId | - | This accepts the customer tax identifier. |
| customers | dateOfBirth | - | This accepts the customer date of birth. This needs to be specified in ISO format YYYY-MM-DD. |
| customers | genderCode | - | This accepts the customer gender code value. |
| customers | maritalStatusCode | - | This accepts the customer marital status code value. |
| customers | jurisdictionCode | - | This accepts the customer jurisdiction code value. |
| customers | businessDomainCode | - | This accepts the customer business domain code value. |
| customers | primaryCitizenshipCode | - | This accepts the customer primary citizenship country code value. |
| customers | secondaryCitizenshipCode | - | This accepts the customer secondary citizenship country code value. |
| customers | legalStructure | - | This accepts the customer legal structure. |
| customers | residenceCode | - | This accepts the customer residence country code value. |
| customers | addedOn | - | This accepts the customer added date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. |
| customers | citizenshipStatus | - | This accepts the customer citizenship status. |
| customers | estimatedNetWorth | - | This accepts the customer estimated net worth. |
| customers | estimatedAnnualIncome | - | This accepts the customer estimated annual income. |
| customers | estimatedLiquidNetWorth | - | This accepts the customer estimated liquid net worth. |
| customers | sourceOfWealth | - | This accepts the customer source of wealth. |
| customers | creditRating | - | This accepts the customer credit rating. |
| customers | creditRatingSource | - | This accepts the customer credit rating source. |
| customers | creditScore | - | This accepts the customer credit score. |
| customers | assetsOutsideOfUSCode | - | This identifies if customer has assets outside of US. Y states customer has assets outside of US and N states customer does not have assets outside of US. |
| customers | isEmployeeCode | - | This identifies if customer is an employee or not. Y states customer is an employee and N states customer is not an employee. |
| customers | worksForFinancialInstitutionCode | - | This identifies if customer works for financial institution or not. Y states customer works for financial institution and N states customer does not works for financial institution. |
| customers | employer | - | This accepts the customer employer. |
| customers | isBrokerDealerCode | - | This identifies if customer is a Broker/Dealer or not. Y states customer is a Broker/ Dealer and N states customer is not a Broker/Dealer. |
| customers | occupationCode | - | This accepts the customer occupation code value. |
| customers | customerStatusCode | - | This accepts the customer status code value. |
| customers | pepFlagCode | - | This identifies if customer is a PEP(Politically Exposed Person) or not. Y states customer is a PEP (Politically Exposed Person) and N states customer is not a PEP (Politically Exposed Person). |
| customers | effectiveRisk | - | This accepts the customer effective risk value. |
| customers | businessRisk | - | This accepts the customer business risk value. |
| customers | listRisk | - | This accepts the customer list risk value. |
| customers | geoRisk | - | This accepts the customer geography risk value. |
| customers | kycRisk | - | This accepts the customer KYC risk value. |
| customers | addresses | addressLine1 | This accepts the address line1 for customer address. |
| customers | addresses | addressLine2 | This accepts the address line2 for customer address. |
| customers | addresses | addressLine3 | This accepts the address line3 for customer address. |
| customers | addresses | addressLine4 | This accepts the address line4 for customer address. |
| customers | addresses | addressLine5 | This accepts the address line5 for customer address. |
| customers | addresses | addressLine6 | This accepts the address line6 for customer address. |
| customers | addresses | city | This accepts the city for customer address. |
| customers | addresses | state | This accepts the state for customer address. |
| customers | addresses | postalCode | This accepts the postal code for customer address. |
| customers | addresses | countryCode | This accepts the country code value for customer address. |
| customers | addresses | regionName | This accepts the region name for customer address. |
| customers | addresses | addressUsageCode | This accepts the usage code value for customer address. |
| customers | phones | phoneNumber | This accepts the customer phone number. |
| customers | phones | extensionNumber | This accepts the extension number for customer phone number. |
| customers | phones | phoneUsageCode | This accepts the usage code value for customer phone number. |
| customers | emails | emailId | This accepts the customer email address. |
| customers | accounts | accountId | This accepts the customer account identifier. |
| customers | accounts | accountRoleCode | This accepts the role code value for the customer account. |
| customers | onlineAccounts | onlineAccountId | This accepts the customer online account identifier. |
| customers | onlineAccounts | onlineAccountUserId | This accepts the customer online account user identifier. |
| customers | onlineAccounts | accountId | This accepts the customer account identifier for the customer online account. |
| customers | onlineAccounts | relationshipDate | This accepts the relationship date time for the customer online account. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. |
| customers | anticipatoryProfiles | profileMetricCode | This accepts the profile metric code value for the customer anticipatory profile. |
| customers | anticipatoryProfiles | averageTransactionAm ount | This accepts the average transaction amount for the customer anticipatory profile. |
| customers | anticipatoryProfiles | debitOrCreditCode | This accepts the Debit/Credit code value for the customer anticipatory profile. |
| customers | anticipatoryProfiles | totalAmount | This accepts the total amount for the customer anticipatory profile. |
| customers | anticipatoryProfiles | periodTypeCode | This accepts the period type code value for the customer anticipatory profile. |
| customers | anticipatoryProfiles | sourceOfFundCountry Code | This accepts the source of fund country code value for the customer anticipatory profile. |
| customers | anticipatoryProfiles | averageTransactionCount | This accepts the average transaction count for the customer anticipatory profile. |
| customers | anticipatoryProfiles | sourceOfFundInstitutionId | This accepts the source of fund institution identifier for the customer anticipatory profile. |
| customers | genericInformation | - | This accepts generic information about the customer. |
Request JSON Sample
This section contains a request JSON sample to add customers to a case. It will accept multiple caseIds and customer information to be added to the case. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100",
"customers": [
{
"customerId": "CUST123",
"businessAdd": "N",
"customerTypeCode": "IND",
"firstName": "Rahul",
"middleName": "Sharad",
"lastName": "Dravid",
"customerOrganizationName": "ABC",
"taxIdFormatCode": "S",
"taxId": "TX123",
"dateOfBirth": "1990-12-01",
"genderCode": "A",
"maritalStatusCode": "M",
"jurisdictionCode": "AMEA",
"businessDomainCode": "A",
"primaryCitizenshipCode": "UK",
"secondaryCitizenshipCode": "IND",
"legalStructure": "TRU",
"residenceCode": "UK",
"addedOn": "2012-12-01 10:30:00",
"citizenshipStatus": "RAL",
"estimatedNetWorth": 1000000,
"estimatedAnnualIncome": 200000,
"estimatedLiquidNetWorth": 300000,
"sourceOfWealth": "INCOME",
"creditRating": "A",
"creditRatingSource": "SYS",
"creditScore": 10,
"assetsOutsideOfUSCode": "Y",
"isEmployeeCode": "Y",
"worksForFinancialInstitutionCode": "Y",
"employer": "ORACLE",
"isBrokerDealerCode": "Y",
"occupationCode": "AFF",
"customerStatusCode": "A",
"pepFlagCode": "Y",
"effectiveRisk": 10,
"businessRisk": 10,
"listRisk": 10,
"geoRisk": 10,
"kycRisk": 10,
"addresses": [
{
"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",
"addressUsageCode": "B"
}
],
"phones": [
{
"phoneNumber": 1234567890,
"extensionNumber": 12345,
"phoneUsageCode": "P"
}
],
"emails": [
{
"emailId": "a@a.com"
}
],
"accounts": [
{
"accountId": "ACDPGTOTACTAC-002",
"accountRoleCode": "OWNER"
}
],
"onlineAccounts": [
{
"onlineAccountId": "TR1",
"onlineAccountUserId": "UTR1",
"accountId": "ACDPGTOTACTAC-002",
"relationshipDate": "2013-12-01 10:30:00"
}
],
"anticipatoryProfiles": [
{
"profileMetricCode": "CASH-EQ-MI",
"averageTransactionAmount": 12345,
"debitOrCreditCode": "D",
"totalAmount": 54321,
"periodTypeCode": "N",
"sourceOfFundCountryCode": "USA",
"averageTransactionCount": 23,
"sourceOfFundInstitutionId": "ABC"
}
],
"genericInformation": {
"Customer Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234"
}
}
}
}Response Parameters
The following table describes the details of the response
parameters.
Table 4-16 Response Parameters Details
| First Level | Second Level | Third Level | Details |
|---|---|---|---|
| MESSAGE | - | - | Displays the overall response message from the API. |
| STATUS | - | - | Displays the 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. |
| RESPONSEARRAY | MESSAGE | - | Displays the response message from the API for the respective case. |
| RESPONSEARRAY | 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. |
| RESPONSEARRAY | caseId | - | Displays the case internal identifier on which the API was called. |
| RESPONSEARRAY | customers | MESSAGE | Displays the response message from the API for the respective customer under the respective case. |
| RESPONSEARRAY | customers | STATUS | Displays the status of the API call for the respective customer 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. |
| RESPONSEARRAY | customers | customerid | Displays the customer internal identifier under the respective case on which the API was called. |
Response JSON Sample
This section contains a response JSON sample for when customer 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. The entries in this sample are only for reference
purposes.
{
"MESSAGE": "Customers addition was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Customers addition was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"customers": [
{
"MESSAGE": "Customer added successfully.",
"STATUS": "SUCCESS",
"customerId": "CUST5"
},
{
"MESSAGE": "Customer added successfully.",
"STATUS": "SUCCESS",
"customerId": "CUST6"
}
]
}