Get Customer
Fetch customer record for a given product and manufacturer combination
Path Parameters
- 200
- 422
Successful Response
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
data object
Unique id to identify customer record
First name of the customer
Customer middle name
Customer last name
Custome Father name
Custome Father name
Custome Father name
Customer Mother name
Customer Mother name
Customer Mother name
Customer date of birth
Customer PAN
Marital Status of the customer
Gender of the customer
Current status of the customer
Current Detailed status of the customer
Residential status of the customer
City of birth of the customer
Current occupation of the customer
Unique id to current occupation of the customer
Source of income of the customer
Whether customer is Politically exposed
Qualification of the customer
Networth of the customer
Networth of the customer
Networth of the customer
Tax residency other than India
Last date of customer modified
Name of the user who created the customer record
Customer Created or onboard date
Customer created by which source (cvlKra/ckyc)
Customer proof of identity document
Customer proof of identity document
Customer proof of identity document
customerAddress object[]
Unique id to identify address record
Type of address
Type of address
Address line 1 of the customer
Address line 2 of the customer
Address line 3 of the customer
Address city
Address state
Address country
Pincode
Flag if it is a preferred address
Proof of address document
poa url backside
aadhar front side poa url
aadhar back poa irl
is same as permanent
Identification Number
customerContactEmail object[]
Email Type
Email id the customer
Flag if it is default email id
customerContactNumber object[]
Contact type of customer
Contact number
customerFatca object
Birth Country of the customer
Flag if US citizen
Flag if no other tax is present
Country of residency other than India
Tax Id number of other country
Type of tax id
Country of birth
Country name if Tax residency other than India
Address of the country if Tax residency other than India
Address of the country if Tax residency other than India
Country - Address of the country if Tax residency other than India
State/County- Address of the country if Tax residency other than India
Zip code- Address of the country if Tax residency other than India
Flag if US resident
customerFactaTinDetails object[]
customerSourcedBy object[]
additionalDetails object
occupationDetails object
customerInvestmentProfile object
customerPreference object[]
customerDisclosure object[]
customerNegativeSector object[]
customerNegativeCompanies object[]
customerFees object[]
customerRiskProfile object[]
customerAccountDetail object
Unique id to identify customer account
accountState object[]
consentESignStatus object[]
{
"reqId": "string",
"errors": [
null
],
"data": {
"customerId": 0,
"customerFirstName": "string",
"customerMiddleName": "string",
"customerLastName": "string",
"customerNamePrefix": "string",
"identificationType": "string",
"identificationNumber": "string",
"identificationExpiryDate": "string",
"fatherNamePrefix": "string",
"motherNamePrefix": "string",
"motherMaidenNamePrefix": "string",
"motherMaidenFirstName": "string",
"motherMaidenMiddleName": "string",
"motherMaidenLastName": "string",
"spouseNamePrefix": "string",
"spouseFirstName": "string",
"spouseMiddleName": "string",
"spouseLastName": "string",
"customerFatherFirstName": "string",
"customerFatherMiddleName": "string",
"customerFatherLastName": "string",
"customerMotherFirstName": "string",
"customerMotherMiddleName": "string",
"customerMotherLastName": "string",
"customerDOB": "string",
"customerPAN": "string",
"customerMaritalStatus": "string",
"nameAsPerAadhar": "string",
"nameOnAadharStatus": true,
"customerGender": "string",
"status": "string",
"customerDetailedStatus": "string",
"customerResidentialStatus": "string",
"customerBirthPlace": "string",
"customerOccupation": "string",
"customerOccupationId": 0,
"customerWealthSource": "string",
"customerPEP": "string",
"customerQualification": "string",
"customerNetworth": "string",
"customerNetworthValueDt": "string",
"customerIncomeDtls": "string",
"customerTaxOthInd": "string",
"customerlastmodifydt": "string",
"customerCreatedBy": 0,
"customerCreatedOn": "string",
"customerSourcedKYC": 0,
"poiType": "string",
"poiMatchStatus": true,
"poiUrl": "string",
"photoUrl": "string",
"wetSignatureUrl": "string",
"customerAddress": [
{
"addressId": 0,
"customerAddressType": "string",
"customerAddressTypeId": 0,
"customerAddress1": "string",
"customerAddress2": "string",
"customerAddress3": "string",
"customerAddressCity": "string",
"customerAddressState": "string",
"customerAddressCountry": "string",
"customerAddressPincode": "string",
"customerAddressPreferred": true,
"customerProofOfAddressType": "string",
"poaUrl": "string",
"poaurlbackside": "string",
"aadharFrontSide": "string",
"aadharBackSide": "string",
"isSameAsPermanent": true,
"identificationNumber": "string"
}
],
"customerContactEmail": [
{
"customerEmailType": "string",
"customerContactEmail": "string",
"customerDefEmail": "string"
}
],
"customerContactNumber": [
{
"customerContactNoType": "string",
"customerContactNo": "string"
}
],
"customerFatca": {
"customerCitizenship": "string",
"customerBirthCountry": "string",
"greenCardHolder": "string",
"noTinOrFe": true,
"noTinOrFeCountry": "string",
"noTinOrFeNumber": "string",
"noTinTypeOfNumber": "string",
"otherCountryOfBirth": "string",
"taxResidentCountry": "string",
"trcAddress": "string",
"trcCity": "string",
"trcCountry": "string",
"trcState": "string",
"trcZipCode": "string",
"usPerson": "string",
"customerFactaTinDetails": [
{
"customerFATCACountry": "string",
"customerFATCAIDType": "string",
"customerFATCAIDNo": "string",
"customerFATCADtls": "string"
}
]
},
"customerSourcedBy": [
{
"rmType": "string",
"rmName": "string",
"rmMobile": "string",
"rmEmail": "string"
}
],
"additionalDetails": {
"occupationDetails": {
"employmentCity": "string",
"employmentCountry": "string",
"employeeDesignation": "string",
"employeeSince": "string",
"employerName": "string",
"establishmentID": "string",
"natureOfBusiness": "string",
"officeAddress": "string",
"otherOccupation": "string",
"pincode": "string",
"employmentState": "string"
}
},
"customerInvestmentProfile": {
"investInStockMarket": "string",
"investmentObjective": "string",
"investmentOrTradingExperience": "string",
"investmentTimePeriod": "string",
"portfolioPercentage": "string",
"riskTolerance": "string"
},
"customerPreference": [
{
"preferenceId": "string",
"preferenceTypeId": "string",
"preferenceTypeValue": "string",
"preferenceValueId": "string",
"preferenceValue": "string"
}
],
"customerDisclosure": [
{
"disclosureId": 0,
"interestedHolder": "string",
"natureOfInterest": "string",
"noOfSharesHeld": 0,
"paidUpCapital": 0,
"companyId": 0,
"isin": "string"
}
],
"customerNegativeSector": [
{
"id": 0,
"sector": "string",
"sectorId": "string"
}
],
"customerNegativeCompanies": [
{
"id": 0,
"company": "string",
"companyId": "string",
"isin": "string"
}
],
"customerFees": [
{
"strategyName": "string",
"manufacturerFeeCode": "string",
"manufacturerFeeName": "string",
"manufacturerFeeType": "string",
"manufacturerFeeRate": 0,
"manufacturerFeeDesc": "string"
}
],
"customerRiskProfile": [
{
"id": 0,
"questionId": 0,
"question": "string",
"answerId": 0,
"answer": "string"
}
],
"customerAccountDetail": {
"accountId": 0
},
"accountState": [
{
"statusName": "string",
"status": "string",
"createdDate": "string",
"createdTime": "string",
"emailId": "string"
}
],
"consentESignStatus": [
{
"customerName": "string",
"esign": "string",
"consent": "string",
"eSignDocName": "string",
"emailId": "string",
"eSignStatus": "string",
"eSignDocumentArray": [
null
]
}
]
}
}
Validation Error
Schema
- Array [
- Array [
- ]
- ]
detail object[]
loc object[] required
string
integer
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}