4.9 Add Customer Identification Documents

You can load external events into ECM system via the Add Customer to Case API. It includes details like - Passport ID, Issued By and Other Identity Details of the Customer. These details are displayed under the Customer Identification Document tab in the UI. It includes adding one or multiple Customer Identification Documents records with the History table populated for audit.

HTTP Link

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

Service Type

The service type is POST.

Request Parameters

Table 4-17 Request Parameter Details

First Level	Second Level		Details
caseId			This accepts the case internal identifier.
customers
customers	customerId		This accepts the customer internal identifier.
customers	businessAdd
customers	customerTypeCode
customers	firstName
customers	middleName
customers	lastName
customers	customerOrganizationName
customers	taxIdFormatCode
customers	taxId
customers	dateOfBirth
customers	genderCode
customers	maritalStatusCode
customers	jurisdictionCode
customers	businessDomainCode
customers	primaryCitizenshipCode
customers	secondaryCitizenshipCode
customers	legalStructure
customers	residenceCode
customers	addedOn
customers	citizenshipStatus
customers	estimatedNetWorth
customers	estimatedAnnualIncome
customers	estimatedLiquidNetWorth
customers	sourceOfWealth
customers	creditRating
customers	creditRatingSource
customers	creditScore
customers	assetsOutsideOfUSCode
customers	isEmployeeCode
customers	worksForFinancialInstitutionCode
customers	employer
customers	isBrokerDealerCode
customers	occupationCode
customers	customerStatusCode
customers	pepFlagCode
customers	effectiveRisk
customers	businessRisk
customers	listRisk
customers	geoRisk
customers	kycRisk
customers	addresses	addressLine1
customers	addresses	addressLine2
customers	addresses	addressLine3
customers	addresses	addressLine4
customers	addresses	addressLine5
customers	addresses	addressLine6
customers	addresses	city
customers	addresses	state
customers	addresses	postalCode
customers	addresses	countryCode
customers	addresses	regionName
customers	addresses	addressUsageCode
customers	phones	phoneNumber
customers	phones	extensionNumber
customers	phones	phoneUsageCode
customers	documents	docId
	documents	docPurposeCode
customers	documents	docName
customers	documents	docReferenceNum
customers	documents	docTypeCode
customers	documents	acctId
customers	documents	assesTypeCode
customers	documents	jurisCode
customers	documents	docIssueDate
customers	documents	docExpiryDate
customers	documents	issuedBy
customers	documents	expiredFlag
customers	documents	govtDocFlag
customers	documents	cipVerifiedBy
customers	documents	cipStatus
customers	documents	cipMode
customers	documents	cntryCode
customers	documents	docState
customers	documents
genericInformation	Customer Details		This accepts generic information about the customer.

Request JSON Sample

[
	{
	"caseId": "CA1003","customers": 
	[
	{
	"customerId": "CUSTOMER WITH MULTIPLE ID DOC1","businessAdd": "N","customerTypeCode": "IND","firstName": "Raghul","middleName": "Dravid","lastName": "John","customerOrganizationName": "ABC","taxIdFormatCode": "S","taxId": "TX123","dateOfBirth": "1990-12-01","genderCode": "M","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": 12345678903,"extensionNumber": 12345,"phoneUsageCode": "P"
		},
		{
			"phoneNumber": 123456789302,"extensionNumber": 12345,"phoneUsageCode": "P"
		}
	],
	"documents": 
			[
			{
			"docId": "P01234567", 
			"docPurposeCode": "TRAVEL", 
			"docName": "PASSPORT",
			"docReferenceNum": "P01234567", 
			"docTypeCode": "PASSPORT", 
			"acctId": "ACC9876543212", 
			"assesTypeCode": "IDENTITY", 
			"jurisCode": "US", 
			"docIssueDate": "2012-12-01 10:30:00", 
			"docExpiryDate": "2012-12-01 10:30:00", 
			"issuedBy": "US Department of State", 
			"expiredFlag": "N", 
			"govtDocFlag": "Y", 
			"cipVerifiedBy": "BANK_OFFICER_001", 
			"cipStatus": "VERIFIED", 
			"cipMode": "ONLINE", 
			"cntryCode": "AF", 
			"docState": "KABUL" 
			},
				{ 
					"docId": "P01234567", "docPurposeCode": "TRAVEL", "docName": "PASSPORT",
					"docReferenceNum": "P01234567", "docTypeCode": "PASSPORT", "acctId":
					"ACC9876543212", "assesTypeCode": "IDENTITY", "jurisCode": "US", "docIssueDate":
					"2012-12-01 10:30:00", "docExpiryDate": "2012-12-01 10:30:00", "issuedBy": 
					"US Department of State", "expiredFlag": "N", "govtDocFlag": "Y", "cipVerifiedBy":
					"BANK_OFFICER_001", "cipStatus": "VERIFIED", "cipMode": "ONLINE", "cntryCode":
					"AF", "docState": "KABUL" 
				}
			],
	  "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-18 Response Parameters

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.
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	Customers	Message	Displays the response message from the API for the respective customer under the respective case.
Resultarray	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.
Resultarray	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 customer identification documents.

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": "CA1003",
"customers": [

{ 
  "MESSAGE": "Customer added successfully.", 
  "STATUS": "SUCCESS", 
  "customerId": "CUSTOMER WITH MULTIPLE ID DOC1" 
}
]
}
]
}