eKYC Calls
ClientPANCheck
Endpoint : ClientPANCheck
Method : POST or GET | Send raw Json data in Body
Checks whether the given Client PAN exists or not
Data | UAT Sample |
---|---|
JSon Request: | |
|
|
JSon Response: | |
|
|
ClientUCCCheck
Endpoint : ClientUCCCheck
Method : POST or GET | Send raw Json data in Body
Checks whether the given Client UCC exists or not
Data | UAT Sample |
---|---|
JSon Data: | |
|
|
Return Data:
|
|
NewClientRegistration
Endpoint : NewClientRegistration
Method : POST or GET | Send raw Json data in Body
Creates a new Client in Sharepro
- Request Data
API Parameter | Data Type | Explanation |
---|---|---|
*key | varchar(100) | REST API Key |
cUcc | char(10) | UCC need to be unique for each client |
*cClientName | varchar(75) | Client Name is compulsory |
cFatherNm | varchar(38) | |
cMotherNm | char(40) | |
dBirth_Date | datetime | |
*cGender | char(1) | M : Male F : Female N : None |
*cMaritalStatus | varchar(2) | 01 : Married 02 : Single 03 : Widow / Widower |
dMarriageAniv | datetime | Marriage anniversary date |
cNationality | char(2) | 01 : Indian 02 : Others |
cResIndStatus | varchar(1) | Residential Status R : Resident Individual N : Non Resident P : Foreign National |
cOccupation | char(25) | Business Employed Professional Student Self Employed House Wife Others |
cAnnualIncome | char(30) | Annual income(This parameter also use as PMLA Annual income) Below Rs. 100000 Rs. 100000 - 500000 Rs. 500000 - 1000000 Rs. 1000000 - 2500000 Above Rs. 2500000 |
ClRiskProfile | char(30) | RiskProfile Low Risk High Risk Medium Risk |
cBranchID | char(4) | SharePro Branchid. If not passed, the client is created in “HO”. Please refer to getBranchesList call to get a list of branches with the |
*cPan_No | char(30) | PAN Number is compulsory PAN Number need to be unique for each client |
cPassport | varchar(25) | |
dPPDate | datetime | |
dPPExpDate | datetime | |
cVoterId | varchar(25) | |
cRationId | varchar(25) | |
cDriveLicense | varchar(25) | |
dDLDate | datetime | |
dDLExpDate | datetime | |
cAadhaar | char(12) | |
cPhotoIdPrf | char(30) | PAN Card Voter ID Passport Driving License ADHAAR |
cAddPrf | char(30) | Voter ID Passport Driving License Ration Card Telephone Bill Electricity Bill Credit-Card Bill Bank Pass Book ADHAAR |
Address | ||
cAdd1 | varchar(50) | |
cAdd2 | varchar(50) | |
cAdd3 | varchar(50) | |
cCity | varchar(25) | |
cPin | char(10) | |
*cStateCd | char(4) | Please refer to getStateCodeList call to get a list of States with the broker. Send STATECD |
cCountry | varchar(35) | Like : 'India' |
cPhone | varchar(40) | |
cFax | char(20) | |
Residential Address | ||
cResAdd1 | varchar(30) | |
cResAdd2 | varchar(30) | |
cResAdd3 | varchar(30) | |
cResCity | varchar(25) | |
cResPin | char(7) | |
cResStateCd | char(4) | Please refer to getStateCodeList call to get a list of States with the broker. Send STATECD |
cResCountry | char(20) | Like : 'India' |
cResPhone | char(20) | |
cResFax | char(20) | |
Communication | ||
cEmail | char(80) | |
cMobile | char(40) | |
FmlyEmailFlag | bit | Family Email Flag 0 : No 1 : Yes |
EmailStat | char(40) | (Self,Spouse,Dependent Children,Dependent Parent,Authorized,Contact Person) |
FmlyMobileFlag | bit | Family Mobile Flag 0 : No 1 : Yes |
MobileStat | char(40) | (Self,Spouse,Dependent Children,Dependent Parent,Authorized,Contact Person) |
KRA | ||
cKraApplDt | datetime | KRA Application date (yyyy-MM-dd) |
cKraOccupation | varchar(2) | 01 : Private Sector Service 02 : Public Sector / Government Service 03 : Business 04 : Professional 05 : Agriculturist 06 : Retired 07 : Housewife 08 : Student 09 : Forex Dealer 99 : Others (please specify) |
cKraOccupationDtlOth | varchar(50) | Others occupation details |
cKraAnnualInc | varchar(2) | 01 : Below Rs. 1 Lac 02 : Btw Rs. 1 to Rs. 5 Lacs 03 : Btw Rs. 5 to Rs. 10 Lacs 04 : Btw Rs. 10 to Rs. 25 Lacs 05 : Btw Rs. 25 Lacs to Rs. 1 CR 06 : Greater than 1 CR |
cKraAnnualIncDt | datetime | |
cKraPEP | varchar(4) | NA : Not a PEP PEP : PEP RPE : Related to a PEP |
cKraCorrAddPrf | varchar(2) | KRA correspondence address Proof Please refer to getKRAAddressProofList call to get a list of KRA address Proof |
cKraCorrAddPrfId | varchar(100) | Correspondence address reference id |
cKraCorrAddPrfDt | datetime | |
cKraPermAddPrf | varchar(2) | KRA permanent address proof Please refer to getKRAAddressProofList call to get a list of KRA address Proof |
cKraPermAddPrfId | varchar(100) | Permanent address reference id |
cKraPermAddPrfDt | datetime | |
cKraPermCorrSame | varchar(1) | Permanent address same as Corr. address? Y : Yes N : No |
cKraCorrAddState | varchar(20) | State of KRA Correspondence address Please refer to getKRAStateCodeList call to get a list of KRA States |
cKraPermAddState | varchar(20) | State of KRA Permanent address Please refer to getKRAStateCodeList call to get a list of KRA States |
cKraCorrAddCntry | varchar(30) | Country of KRA Correspondence address Please refer to getKRACountryCodeList call to get a list of KRA Country |
cKraPermAddCntry | varchar(30) | Country of KRA Permanent address Please refer to getKRACountryCodeList call to get a list of KRA Country |
cKraIdProof | cKraIdProof | KRA Proof of Identity Submitted (Others) Please refer to getKRAPhotoIdProofList call to get a list of KRA Photo Id Proof |
cKraStateCity | char(5) | KRA State City Please refer to getKRAStateCityList call to get a list of KRA State City |
cKraIpvDt | datetime | IPV Date (yyyy-MM-dd) |
cKraIpvDesig | varchar(50) | IPV Designation |
cKraIpvName | varchar(50) | IPV Name |
cKraIpvOrg | varchar(50) | IPV Organisation |
cKraIdProofOth | varchar(50) | Proof of Identity Others |
KRACompStatus | varchar(2) | 01- Private Ltd Company 02- Public Ltd Company 03- Body Corporate 04- Partnership 05- Trust / Charities / NGOs 06- FI 07- FII 08- HUF 09- AOP 10- Bank 11- Government Body 12- Non-Government Organisation 13- Defense Establishment 14- Body of Individuals 15- Society 16- LLP 99- Others |
Introducer Details | ||
cIntroClId | char(10) | |
cIntroName | varchar(30) | |
cIntroCtgry | char(15) | 01 : Individual 02 : Partnership Firm 03 : HUF 04 : Public & Private Companies 05 : Trust/Society 06 : Mutual Fund 07 : Domestic Financial Institution 08 : Bank 09 : Insurance 10 : Statutory Bodies 11 : NRI 12 : FII 13 : OCB 14 : Foreign Ven Cap Funds/Direct Foreign Inv 15 : PMS Clients 16 : New Pension System (NPS), 17 : Association (QFIG/A) 18 : (QFI-I) 19 : Non Govt.Organisation 20 : Foreign Venture Capital Fund 21 : Depository Receipts, LLP : LLP 99 : Others |
cIntroCatDscr | varchar(25) | |
cIntroAdd1 | varchar(30) | |
cIntroAdd2 | varchar(30) | |
cIntroAdd3 | varchar(30) | |
cIntroCity | varchar(15) | |
cIntroPin | varchar(7) | |
cIntroCntry | varchar(35) | |
cIntroPhone | varchar(30) | |
cIntroFather | varchar(35) | |
cIntroRel | varchar(25) | |
cIntroIdPrf | char(30) | PAN Card Voter ID Passport Driving License |
cIntroId | char(30) | |
cIntroIdExp | datetime | |
Contact Person 1 | ||
*cContactPerson | varchar(30) | Contact Person Name is compulsory |
*cCpDesignation | varchar(25) | Contact Person Designation is compulsory |
*cCpAddress | varchar(100) | Contact Person Address is compulsory |
*cCpPhone | varchar(20) | Contact Person Phone No. is compulsory |
cCpCity | varchar(50) | |
*cCpPin | varchar(10) | Contact Person PIN is compulsory |
*cCpState | varchar(2) | Contact Person State is compulsory Please refer to getKRAStateCodeList call to get a list. Send CODE |
*cCpCountry | varchar(3) | Contact Person Country is compulsory Please refer to getKRACountryCodeList call to get a list. Send CODE |
Primary Bank Details | ||
*cIfsc | varchar(40) | IFSC of Primary Bank Account is compulsory |
cMicr | varchar(40) | |
cAcType | varchar(10) | Savings Current PIS A/c Others |
*cAcNo | varchar(20) | |
*cBankClientName | varchar(40) | |
Secondary Bank Details | ||
cSecIfsc | varchar(40) | |
cSecMicr | varchar(40) | |
cSecAcType | varchar(10) | Savings Current PIS A/c Others |
cSecAcNo | varchar(20) | |
cSecBankClientName | varchar(40) | |
PayMode | char(1) | Preferred mode of Payment "1" : Any "2" : RTGS "3" : NEFT "4" : Cheque |
cAutoFundPo | bit | 0 : No 1 : Yes |
cClientType | char(2) | 01 : Individual 02 : Partnership Firm 03 : HUF 04 : Public & Private Companies 05 : Trust/Society 06 : Mutual Fund 07 : Domestic Financial Institution 08 : Bank 09 : Insurance 10 : Statutory Bodies 11 : NRI 12 : FII 13 : OCB 14 : Foreign Ven Cap Funds/Direct Foreign Inv 15 : PMS Clients 16 : New Pension System (NPS) 17 : Association (QFIG/A) 18 : (QFI-I) 19 : Non Govt.Organisation 20 : Foreign Venture Capital Fund 21 : Depository Receipts, LLP : LLP 99 : Others |
cDealMod | char(15) | T : Trading Member N : Custodian B : Both |
cRegFrmRecvd | bit | 0 : No 1 : Yes |
cIpvFlag | bit | 0 : No, 1 : Yes |
Segments to register in | ||
cREG_NSE | bit | NSE-CM - 0 : No, 1 : Yes |
cREG_NFO | bit | NSE-FO |
cREG_BSE | bit | BSE-CM |
cREG_BFO | bit | BSE-FO |
cREG_CSE | bit | CSE |
cREG_DSE | bit | |
cREG_NCDEX | bit | NCDEX |
cREG_MCX | bit | MCX |
cREG_MF | bit | |
cREG_NBFC | bit | |
cREG_DGCX | bit | |
cREG_NMCEIL | bit | |
cREG_CNFO | bit | NSE-CDS |
cREG_CMFO | bit | MSEI-CDS |
cREG_CBFO | bit | BSE-CDS |
cREG_PMS | bit | |
cREG_ICFO | bit | ICEX |
cREG_NMFS | bit | NSEE-MF |
cREG_NSFO | bit | |
cREG_KCFO | bit | |
cREG_KCFO | bit | |
cREG_USFO | bit | |
cREG_CSENSE | bit | |
cREG_CSENFO | bit | |
cREG_MXEQ | bit | |
cREG_MXFO | bit | |
cREG_UCX | bit | |
cREG_NSEDS | bit | |
cREG_BMFS | bit | |
cREG_NSLB | bit | NSE-SLBM |
cREG_NSPT | bit | |
IBTActive | datetime | yyyy-MM-dd |
FATCAReceivedDate | datetime | yyyy-MM-dd |
cHoldDlvry | bit | Always Hold Traded purchase shares hold by broker? 0 : No 1 : Yes |
DP Details | ||
DP Account : DPID may not be passed if a client wants a new DP Account opened in an eKYC system | ||
cDpId | char(10) | |
cBenAcNum | char(8) | |
Nominee Opt Out | ||
NomOptOutDt | datetime | yyyy-MM-dd |
Nominee Old (Obsolete in SharePro no need to pass now) | ||
cNomineeNm | char(40) | Nominee Name |
cNomineeRel | char(40) | Nominee Relation |
NomineeAdd1 | char(40) | |
NomineeAdd2 | char(40) | |
NomineeAdhar | char(12) | |
NomineeCity | char(20) | |
NomineeEmail | char(40) | |
NomineePan | char(10) | |
NomineePhone | char(20) | |
NomineePin | char(20) | |
Nominee 1 | ||
Nominee1_EffectDate | datetime | yyyy-MM-dd (Default it is Current Date) |
Nominee1_Prefix | varchar(5) | MR, MRS, etc |
Nominee1_Descr | varchar(50) | Nominee Name * mandatory for nominee1 |
Nominee1_Percent | numeric(5,2) | Nominee percentage ( Like : “50.00”) |
Nominee1_Relation | varchar(50) | Nominee Relation (Like :”Son”) |
Nominee1_Add1 | varchar(50) | * mandatory for nominee1 |
Nominee1_Add2 | varchar(50) | |
Nominee1_Add3 | varchar(50) | |
Nominee1_City | varchar(50) | |
Nominee1_Pincode | varchar(50) | |
Nominee1_State | varchar(50) | (Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee1 |
Nominee1_Country | varchar(50) | (Like : "IN" OR “India”) * mandatory for nominee1 |
Nominee1_Mobile | varchar(20) | |
Nominee1_Phone | varchar(20) | |
Nominee1_Email | varchar(50) | |
Nominee1_IdType | varchar(50) | ID PROOF "D" : Driving License "F" : NREGA Job Card "Z" : Others "C" : PAN "A" : Passport "S02" : Simple/SimplifiedID issued by a Gazetted Officer "S01" : SSId Issued by CG/SG/SB/RA/PSU/SCB/PFI "E" : UID / AADHAR "B" : Voter Identity Card |
Nominee1_IdNumber | varchar(30) | ID PROOF Number ( Like : for AADHAR its UID) |
Nominee1_IsMinor | bit | "1": yes, "0": No ( default 0) |
Nominee1_MinorDOB | datetime | yyyy-MM-dd |
Nominee1_GdDescr | varchar(50) | Nominee’s Guardian Name |
Nominee1_GdRelation | varchar(50) | Guardian Relation with Nominee ( like : “Mother”) |
Nominee1_GdAdd1 | varchar(50) | |
Nominee1_GdAdd2 | varchar(50) | |
Nominee1_GdAdd3 | varchar(50) | |
Nominee1_GdCity | varchar(50) | |
Nominee1_GdPincode | varchar(50) | |
Nominee1_GdState | varchar(50) | |
Nominee1_GdCountry | varchar(50) | |
Nominee1_GdMobile | varchar(20) | |
Nominee1_GdPhone | varchar(20) | |
Nominee1_GdEmail | varchar(50) | |
Nominee1_GdIdType | varchar(50) | ID PROOF ( same as IdType) |
Nominee1_GdIdNumber | varchar(30) | ID PROOF Number (Like : for AADHAR its UID) |
Nominee 2 | ||
Nominee2_EffectDate | datetime | yyyy-MM-dd (Default it is Current Date) |
Nominee2_Prefix | varchar(5) | MR, MRS, etc |
Nominee2_Descr | varchar(50) | Nominee Name * mandatory for nominee2 |
Nominee2_Percent | numeric(5,2) | Nominee percentage ( Like : “50.00”) |
Nominee2_Relation | varchar(50) | Nominee Relation (Like :”Son”) |
Nominee2_Add1 | varchar(50) | * mandatory for nominee2 |
Nominee2_Add2 | varchar(50) | |
Nominee2_Add3 | varchar(50) | |
Nominee2_City | varchar(50) | |
Nominee2_Pincode | varchar(50) | |
Nominee2_State | varchar(50) | (Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee2 |
Nominee2_Country | varchar(50) | (Like : "IN" OR “India”) * mandatory for nominee2 |
Nominee2_Mobile | varchar(20) | |
Nominee2_Phone | varchar(20) | |
Nominee2_Email | varchar(50) | |
Nominee2_IdType | varchar(50) | ID PROOF "D" : Driving License "F" : NREGA Job Card "Z" : Others "C" : PAN "A" : Passport "S02" : Simple/SimplifiedID issued by a Gazetted Officer "S01" : SSId Issued by CG/SG/SB/RA/PSU/SCB/PFI "E" : UID / AADHAR "B" : Voter Identity Card |
Nominee2_IdNumber | varchar(30) | ID PROOF Number ( Like : for AADHAR its UID) |
Nominee2_IsMinor | bit | "1": yes, "0": No ( default 0) |
Nominee2_MinorDOB | datetime | yyyy-MM-dd |
Nominee2_GdPrefix | varchar(5) | MR, MRS, etc |
Nominee2_GdDescr | varchar(50) | Nominee’s Guardian Name |
Nominee2_GdRelation | varchar(50) | Guardian Relation with Nominee ( like : “Mother”) |
Nominee2_GdAdd1 | varchar(50) | |
Nominee2_GdAdd2 | varchar(50) | |
Nominee2_GdAdd3 | varchar(50) | |
Nominee2_GdCity | varchar(50) | |
Nominee2_GdPincode | varchar(50) | |
Nominee2_GdState | varchar(50) | |
Nominee2_GdCountry | varchar(50) | |
Nominee2_GdMobile | varchar(20) | |
Nominee2_GdPhone | varchar(20) | |
Nominee2_GdEmail | varchar(50) | |
Nominee2_GdIdType | varchar(50) | ID PROOF ( same as IdType) |
Nominee2_GdIdNumber | varchar(30) | ID PROOF Number (Like : for AADHAR its UID) |
Nominee 3 | ||
Nominee3_EffectDate | datetime | yyyy-MM-dd (Default it is Current Date) |
Nominee3_Prefix | varchar(5) | MR, MRS, etc |
Nominee3_Descr | varchar(50) | Nominee Name * mandatory for nominee3 |
Nominee3_Percent | numeric(5,2) | Nominee percentage ( Like : “50.00”) |
Nominee3_Relation | varchar(50) | Nominee Relation (Like :”Son”) |
Nominee3_Add1 | varchar(50) | * mandatory for nominee3 |
Nominee3_Add2 | varchar(50) | |
Nominee3_Add3 | varchar(50) | |
Nominee3_City | varchar(50) | |
Nominee3_Pincode | varchar(50) | |
Nominee3_State | varchar(50) | (Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee3 |
Nominee3_Country | varchar(50) | (Like : "IN" OR “India”) * mandatory for nominee3 |
Nominee3_Mobile | varchar(20) | |
Nominee3_Phone | varchar(20) | |
Nominee3_Email | varchar(50) | |
Nominee3_IdType | varchar(50) | ID PROOF "D" : Driving License "F" : NREGA Job Card "Z" : Others "C" : PAN "A" : Passport "S02" : Simple/SimplifiedID issued by a Gazetted Officer "S01" : SSId Issued by CG/SG/SB/RA/PSU/SCB/PFI "E" : UID / AADHAR "B" : Voter Identity Card |
Nominee3_IdNumber | varchar(30) | ID PROOF Number ( Like : for AADHAR its UID) |
Nominee3_IsMinor | bit | "1": yes, "0": No ( default 0) |
Nominee3_MinorDOB | datetime | yyyy-MM-dd |
Nominee3_GdPrefix | varchar(5) | MR, MRS, etc |
Nominee3_GdDescr | Nominee3_GdDescr | Nominee’s Guardian Name |
Nominee’s Guardian Name | varchar(50) | Guardian Relation with Nominee ( like : “Mother”) |
Nominee3_GdAdd1 | varchar(50) | |
Nominee3_GdAdd2 | varchar(50) | |
Nominee3_GdAdd3 | varchar(50) | |
Nominee3_GdCity | varchar(50) | |
Nominee3_GdPincode | varchar(50) | |
Nominee3_GdState | varchar(50) | |
Nominee3_GdCountry | varchar(50) | |
Nominee3_GdMobile | varchar(20) | |
Nominee3_GdPhone | varchar(20) | |
Nominee3_GdEmail | varchar(50) | |
Nominee3_GdIdType | varchar(50) | ID PROOF ( same as IdType) |
Nominee3_GdIdNumber | varchar(30) | ID PROOF Number (Like : for AADHAR its UID) |
Guardian | ||
cGuardianNm | char(35) | Guardian Name |
cGuardianPan | char(10) | |
Brokerage | ||
Note : Passing this basket will add the Basket to the Client's Brokerage. Please ensure that you pass a valid Basket code as the system will not check whether the basket actually exists or not | ||
cBrkgBasketNSE | char(10) | Brokerage NSE Basket Code |
cBrkgBasketBSE | char(10) | Brokerage BSE Basket Code |
cBrkgBasketFO | char(10) | Brokerage FO Basket Code |
cBrkgBasketCDS | char(10) | Brokerage CDS Basket Code |
cBrkgBasketCOMM | char(10) | Brokerage COMM Basket Code |
cBrkgBasketBSEFO | char(10) | Brokerage BSE FO Basket Code |
cBrkgBasketBSECDS | char(10) | Brokerage BSE CDS Basket Code |
dBrkgEffectDate | datetime | Brokerage Effect Date |
nDelCMBrkg | numeric(9,6) | NSE-CM Delivery Brokerage % |
nDelCMBrkgMin | numeric(8,4) | NSE-CM Delivery Brokerage Min |
nSqCMBrkg | numeric(9,6) | NSE-CM Square Off Brokerage % |
nSqCMBrkgMin | numeric(8,4) | NSE-CM Square Off Min |
nFutBrkg | numeric(9,6) | Future Brokerage % |
nFutBrkgMin | numeric(8,4) | Future Brokerage Min |
nOptBrkg | numeric(7,4) | Option Brokerage % |
Running Accounts | ||
cRunAcSegment | varchar(10) | Securities, Commodity, Both |
Note: If Segment is only Commodity and Commodity parameters does not have values then set Securities values auto set to Commodity parameters | ||
Securities | ||
dRunAcRcvdDt | datetime | Received on (yyyy-MM-dd) |
dRunAcRcvdDt | datetime | Received on (yyyy-MM-dd) |
dRunAcRvkdDt | datetime | Revoked on (yyyy-MM-dd) |
nSettleType | numeric(1,0) | 0 : Not Set 1 : Monthly 2 : Quarterly, 3 : Half Yearly |
Retainable | numeric(6,0) | Securities Retainable (Like 10000) |
Commodity | ||
dRunAcRcvdDtCom | datetime | Received on (yyyy-MM-dd) |
dRunAcRvkdDtCom | datetime | Revoked on (yyyy-MM-dd) |
nSettleTypeCom | numeric(1,0) | 0 : Not Set 1 : Monthly 2 : Quarterly 3 : Half Yearly |
RetainableCom | numeric(6,0) | Commodity Retainable (Like 10000) |
**Operations ** | ||
cGroupCd | char(4) | |
dAPEffectDate | datetime | |
cAPCd | char(10) | |
dRMEffectDate | datetime | |
cRMCd | char(10) | |
dDealerEffectDate | datetime | |
cDealerCd | char(10) | |
dSREffectDate | datetime | |
cSRCd | char(10) | |
eContract | bit | Clients take e-contract ? 0 : No 1 : Yes |
NETWORTH-- PMLA | ||
cACC_DateDESCR | char(9) | Financial year (Like 2021-2022) |
nGROSSINCOME | numeric(16, 2) | Gross Income |
nNETWORTH | numeric(16, 2) | Net Worth |
dtNETWORTHDT | datetime | Net Worth date (yyyy-MM-dd) |
BusiCommenceDt | datetime | Business commencement date (yyyy-MM-dd) |
cClientWithOthTM | char(1) | Client account with another TM ? Y : Yes N : No |
NMFS_occupation | char(2) | 1 : Business 2 : Service 3 : Professional 4 : Agriculture 5 : Retired 6 : Housewife 7 : Student 8 : Others |
NMFS_state | char(2) | Need to pass GSTSTATECD Please refer to getStateCodeList call to get a list of States with the broker |
Funding Rate of Interest | ||
Normal Interest Segment Type | ||
InterestEffectDate | datetime | Normal Interest EffectDate (yyyy-MM-dd) |
FlatInterest | numeric(6,2) | Normal Flat Interest (Interest %) like : 18.00 |
InterestSlabCd | char(2) | Normal Interest SlabCd |
DntCalcInterest | bit | Normal Do not calculate Interest of Client? 0 : No 1 : Yes |
InterestRegPending | bit | Normal Interest Reg Pending |
InterestRoundOff | int | Normal Interest Rounding Off 1 : Nearest 5 Paisa 2 : Higher 5 Paisa 3 : Nearest Paisa 4 : Higher Paisa 5 : Higher 2 Paisa 6 : Nearest Rupee 7 : Higher Rupee |
InterestGracePeriod | char(8) | Normal Grace Days - Grace Period Default 0 1 2 3 4 5 6 7 |
InterestSpecShareCr | bit | Normal SpecShareCr 0 : No 1 : Yes |
InterestShareCrPer | numeric(6,2) | Normal ShareCrPer |
InterestExclSpanMarkup | bit | Normal Exclude Span Margin |
InterestExclM2MValue | bit | Normal Exclude Exposure Margin [M2M] |
MTF Interest Segment Type | ||
MTFInterestEffectDate | datetime | MTF Interest EffectDate (yyyy-MM-dd) |
MTFFlatInterest | numeric(6,2) | MTF Flat Interest (Interest %) like : 18.00 |
MTFInterestSlabCd | char(2) | MTF Interest SlabCd |
MTFDntCalcInterest | bit | MTF Do not calculate Interest of Client ? 0 : No 1 : Yes |
MTFInterestRegPending | bit | MTF Interest Reg Pending |
MTFInterestRoundOff | int | MTF Interest Rounding Off 1 : Nearest 5 Paisa 2 : Higher 5 Paisa 3 : Nearest Paisa 4 : Higher Paisa 5 : Higher 2 Paisa 6 : Nearest Rupee 7 : Higher Rupee |
MTFInterestGracePeriod | char(8) | MTF Grace Days - Grace Period Default 0 1 2 3 4 5 6 7 |
MTFInterestSpecShareCr | bit | MTF SpecShareCr |
MTFInterestShareCrPer | numeric(6,2) | MTF ShareCrPer |
MTFInterestExclSpanMarkup | bit | MTF Exclude Span Margin |
MTFInterestExclM2MValue | bit | MTF Exclude Exposure Margin [M2M] |
NBFC Interest Segment Type | ||
NBFCInterestEffectDate | datetime | NBFC Interest EffectDate (yyyy-MM-dd) |
NBFCFlatInterest | numeric(6,2) | NBFC Flat Interest (Interest %) like : 18.00 |
NBFCInterestSlabCd | char(2) | NBFC Interest SlabCd |
NBFCDntCalcInterest | bit | NBFC Do not calculate Interest of Client 0 : No 1 : Yes |
NBFCInterestRegPending | bit | NBFC Interest Reg Pending |
NBFCInterestRoundOff | int | **NBFC Interest Rounding Off ** 1 : Nearest 5 Paisa 2 : Higher 5 Paisa 3 : Nearest Paisa 4 : Higher Paisa 5 : Higher 2 Paisa 6 : Nearest Rupee 7 : Higher Rupee |
NBFCInterestGracePeriod | char(8) | NBFC Grace Days - Grace Period Default 0 1 2 3 4 5 6 7 |
NBFCInterestSpecShareCr | bit | NBFC SpecShareCr |
NBFCInterestShareCrPer | numeric(6,2) | NBFC ShareCrPer |
NBFCInterestExclSpanMarkup | bit | NBFC Exclude Span Margin |
NBFCInterestExclM2MValue | bit | NBFC Exclude Exposure Margin [M2M] |
ADD USER | ||
ADD USER | varchar(15) | Record inserted by (like a 3rd party vendor name : KYCDone) "AddUser": "KYCDone" |
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"cUcc": "Z999",
"cClientName": "Dummy Name",
"cFatherNm": "Dummy Father",
"cMotherNm": "Dummy Mother",
"dBirth_Date": "1990-06-02",
"cGender": "M",
"cMaritalStatus": "02",
"dMarriageAniv": "",
"cNationality": "01",
"cResIndStatus": "R",
"cOccupation": "",
"cAnnualIncome": "Below Rs. 100000",
"cBranchID": "HO",
"cPan_No": "PAN_EXEMPT",
"cPassport": "",
"dPPDate": "",
"dPPExpDate": "",
"cVoterId": "",
"cRationId": "",
"cDriveLicense": "",
"dDLDate": "",
"dDLExpDate": "",
"cAadhaar": "111122223333",
"cPhotoIdPrf": "", "cAddPrf": "",
"cAdd1": "Dummy Address 1",
"cAdd2": "Dummy Address 2",
"cAdd3": "Dummy Address 3",
"cCity": "Kolkata",
"cPin": "700019",
"cStateCd": "WB",
"cCountry": "India",
"cPhone": "9999-9999",
"cFax": "5555-5555",
"cResAdd1": "Dummy Res Address 1",
"cResAdd2": "Dummy Res Address 2",
"cResAdd3": "Dummy Res Address 3",
"cResCity": "Pune",
"cResPin": "700059",
"cResStateCd": "MAHA",
"cResCountry": "India",
"cResPhone": "",
"cResFax": "",
"cEmail": "dummy@gamil.com",
"cMobile": "+919999999999",
"cKraOccupation": "01",
"cKraAnnualInc": "01",
"cKraPEP": "NA",
"cKraCorrAddPrf": "01",
"cKraPermAddPrf": "01",
"cKraPermCorrSame": "N",
"cKraCorrAddState": "01",
"cKraPermAddState": "01",
"cKraCorrAddCntry": "01",
"cKraPermAddCntry": "01",
"cKraIdProof": "01",
"cKraStateCity": "17102",
"cIntroClId": "Z015",
"cIntroName": "Dummy Introducer",
"cIntroCtgry": "04",
"cIntroCatDscr": "",
"cIntroAdd1": "Dummy Intro Add 1",
"cIntroAdd2": "Dummy Intro Add 2",
"cIntroAdd3": "Dummy Intro Add 3",
"cIntroCity": "Mumbai",
"cIntroPin": "800001",
"cIntroCntry": "India",
"cIntroPhone": "8888-8888",
"cIntroFather": "Dummy Intro Father",
"cIntroRel": "Friend",
"cIntroIdPrf": "",
"cIntroId": "",
"cIntroIdExp": "",
"cContactPerson": "Dummy CP",
"cCpDesignation": "Manager",
"cCpAddress": "Dummy CP Add",
"cCpPhone": "6767-4545",
"cCpCity": "Kolkata",
"cCpPin": "700025",
"cCpState": "01",
"cCpCountry": "01",
"cIfsc": "UTIB0000034",
"cMicr": "700211009",
"cAcType": "Savings",
"cAcNo": "123456789",
"cSecIfsc": "ALLA0211713",
"cSecMicr": "700010086",
"cSecAcType": "Savings",
"cSecAcNo": "987654321",
"cAutoFundPo": "1",
"cClientType": "01",
"cDealMode": "T",
"cRegFrmRecvd": "1",
"cIpvFlag": "1",
"cREG_NSE": "0",
"cREG_NFO": "0",
"cREG_BSE": "0",
"cREG_BFO": "0",
"cREG_CSE": "0",
"cREG_DSE": "0",
"cREG_NCDEX": "0",
"cREG_MCX": "0",
"cREG_MF": "0",
"cREG_NBFC": "0",
"cREG_DGCX": "0",
"cREG_NMCEIL": "0",
"cREG_CNFO": "0",
"cREG_CMFO": "0",
"cREG_CBFO": "0",
"cREG_PMS": "0",
"cREG_ICFO": "0",
"cREG_NMFS": "0",
"cREG_NSFO": "0",
"cREG_KCFO": "0",
"cREG_USFO": "0",
"cREG_BMFS": "0",
"cHoldDlvry": "1",
"cDpId": "",
"cBenAcNum": "",
"cGuardianNm": "",
"cGuardianPan": "",
"Nominee1_EffectDate": "2022-02-22",
"Nominee1_Prefix": "MRS",
"Nominee1_Descr": "KAVITA HP SEN",
"Nominee1_Percent": 100.00,
"Nominee1_Relation": "Wife",
"Nominee1_Add1": "15/12, Dr SEN Road",
"Nominee1_Add2": "GolPark",
"Nominee1_Add3": "Jadavpur",
"Nominee1_City": "Kolkata",
"Nominee1_Pincode": "700019",
"Nominee1_State": "WB",
"Nominee1_Country": "IN",
"Nominee1_Mobile": "9038931047",
"Nominee1_Phone": "1234567",
"Nominee1_Email": "kavita@abc.com",
"Nominee1_IdType": "E",
"Nominee1_IdNumber": "529874145551",
"Nominee1_IsMinor": "0",
"Nominee2_EffectDate": "2022-02-22",
"Nominee2_Prefix": "",
"Nominee2_Descr": "Rahul Sen",
"Nominee2_Percent": 50.00,
"Nominee2_Relation": "Son",
"Nominee2_Add1": "15/12, Dr SEN Road",
"Nominee2_Add2": "GolPark",
"Nominee2_Add3": "Jadavpur",
"Nominee2_City": "Kolkata",
"Nominee2_Pincode": "700019",
"Nominee2_State": "WB",
"Nominee2_Country": "IN",
"Nominee2_Mobile": "9038931048",
"Nominee2_Phone": "1234567",
"Nominee2_Email": "rahulkav@abc.com",
"Nominee2_IdType": "E",
"Nominee2_IdNumber": "529874145667",
"Nominee2_IsMinor": "1",
"Nominee2_MinorDOB": "2012-02-25",
"Nominee2_GdPrefix": "MRS",
"Nominee2_GdDescr": "KAVITA HP SEN",
"Nominee2_GdRelation": "Mother",
"Nominee2_GdAdd1": "15/12, Dr SEN Road",
"Nominee2_GdAdd2": "GolPark",
"Nominee2_GdAdd3": "Jadavpur",
"Nominee2_GdCity": "Kolkata",
"Nominee2_GdPincode": "700019",
"Nominee2_GdState": "WB",
"Nominee2_GdCountry": "IN",
"Nominee2_GdMobile": "9855558252",
"Nominee2_GdPhone": "75544",
"Nominee2_GdEmail": "kavita@abc.com",
"Nominee2_GdIdType": "E",
"Nominee2_GdIdNumber": "529874145551",
"dBrkgEffectDate": "",
"nDelCMBrkg": "0.3",
"nDelCMBrkgMin": "0.3",
"nSqCMBrkg": "0.03",
"nSqCMBrkgMin": "0.03",
"nFutBrkg": "0.03",
"nFutBrkgMin": "0.03",
"nOptBrkg": "50",
"dRunAcRcvdDt": "",
"cRunAcSegment": "Securities",
"nSettleType": "2",
"cGroupCd": "A003",
"dAPEffectDate": "",
"cAPCd": "AP001",
"dRMEffectDate": "",
"cRMCd": "000034",
"dDealerEffectDate": "",
"cDealerCd": "4A001",
"dSREffectDate": "",
"cClientWithOthTM": "Y",
"cSRCd": "000500"
}
- Return JSon Response
Return JSon Response: | Sample |
---|---|
|
|
rest NewCDSLClientRegistration
Method : POST or GET| Send raw Json data in Body
- Creates a new CDSL Client in the Depository Segment
Request Data | ||
---|---|---|
API Parameter | Data Type | Explanation |
*key | varchar(100) | REST API Key |
CompanyId | char(2) | SharePro Company Code of CDSL. A broker may have multiple CDSL Depository Licenses. If value is not passed, the call picks up the first available CDSL segment in SharePro. |
BranchID | char(4) | SharePro Branchid. If not passed, the client is created in “HO”. Please refer to getBranchesList call to get a list of branches with the broker. |
First Holder information | ||
FhTitle | varchar(10) | First Holder Title (Like MR, MRS) |
* FhFirstName | varchar(100) | First Holder First Name is compulsory |
FhMiddleName | varchar(20) | First Holder Middle Name |
*FhLastName | varchar(20) | First Holder Last Name is compulsory |
FhSuffix | varchar(10) | First Holder Suffix (Like DR) |
FhFather | varchar(50) | First Holder Father Name |
FhMother | varchar(100) | First Holder Mother Name |
UCC | char(10) | First Holder trading UCC |
FhDOB | datetime | First Holder Date of Birth |
FhGender | char(1) | First Holder Gender "M" - Male "F" - Female "X" - None |
*FhAddr1 | varchar(55) | First Holder Address is compulsory |
FhAddr2 | varchar(55) | First Holder Address 2 |
FhAddr3 | varchar(55) | First Holder Address 3 |
FhCity | varchar(25) | First Holder City is compulsory. If you not pass then we will search it using Pincode |
*FhStateCode | char(4) | GST State Code is compulsory Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD |
FhState | varchar(25) | First Holder NRI State Name |
*FhCountry | varchar(25) | First Holder Country is compulsory (Like India) |
*FhPin | varchar(10) | First Holder Pincode is compulsory |
CitySeqNo | char(2) | City Sequence Number -- 01, 02 (Obsolete in SharePro no need to pass now) |
FhNationCode | char(3) | First Holder Nationality "01" - Indian "99" - Others "02" - United States of America "03" - United Kingdom "04" - Middle East Nations "05" - Japan "06" - France "07" - Germany "08" - Singapore "09" - Canada |
FhPhoneInd1 | char(1) | Phone Indicator (Obsolete in SharePro no need to pass now) "N" - None "M" - Mobile "O" - Office "P" - Pager "R" - Residence |
FhPhone1 | varchar(17) | First Holder Primary Mobile No. |
FhPhoneInd2 | char(1) | Phone Indicator (Obsolete in SharePro no need to pass now) "N" - None "M" - Mobile "O" - Office "P" - Pager "R" - Residence |
FhPhone2 | varchar(17) | First Holder Secondary Mobile No |
FhAdtnlPhone | varchar(100) | First Holder Additional Secondary Phone No (Obsolete in SharePro no need to pass now) |
FhFax | varchar(17) | First Holder Fax |
FhEmail | varchar(50) | First Holder Primary Email |
*FhPan | varchar(25) | First Holder Income Tax PAN No. is compulsory |
FhPanExempt | varchar(1) | First Holder Pan Exempt (Obsolete in SharePro no need to pass now) |
FhPanVerify | numeric(1, 0) | 1st Holder PAN Verify (Verification Code) "0" - Pan Not Verified "1" - PAN verified "2" - PAN Verification reversed "3" - PAN Verified & Aadhar linked "4" - PAN Exempted "5" - PAN Verified and Aadhar link to be checked "6" - PAN Verified and Aadhaar linked confirmed by DP "7" - Aadhaar Exempted Cases |
FhITCircle | varchar(15) | IT Circle / Ward / District |
FhDepAllowYesNo | char(1) | First Holder Dependent Allow “N” - No “Y” - Yes |
FhDepDeclYesNo | char(1) | First Holder Dependent Declaration “N” - No “Y” - Yes |
FhDepRelation | char(2) | First Holder Dependent Relation "" - None "SA" - Same a/c Holder "DF" - Dependent Father "DF" - Dependent Father "SP" - Spouse "SO" - Son "UD" - Unmarried Daughter |
*FhPerAddr1 | varchar(55) | 1st Holder Permanent Address is compulsory |
FhPerAddr2 | varchar(55) | 1st Holder Permanent Address 2 |
FhPerAddr3 | varchar(55) | 1st Holder Permanent Address 3 |
*FhPerCity | varchar(25) | 1st Holder Permanent City is compulsory. If you not pass then we will search it using Pincode |
*FhPerStateCode | char(4) | 1st Holder Permanent GST State Code is compulsory Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD |
FhPerState | varchar(25) | 1st Holder NRI Permanent State Name |
*FhPerCountry | varchar(25) | 1st Holder Permanent Country is compulsory (Like : India ) |
*FhPerPin | varchar(10) | 1st Holder Permanent PIN Code is compulsory |
FhPerPhoneInd1 | char(1) | 1st Holder Permanent Phone Indicator (Obsolete in SharePro no need to pass now) |
FhPerPhone1 | varchar(17) | 1st Holder Permanent Primary Phone (Obsolete in SharePro no need to pass now) |
FhPerPhoneInd2 | char(1) | 1st Holder Permanent Secondary Phone Indicator (Obsolete in SharePro no need to pass now) "N" - None "M" - Mobile "O" - Office "P" - Pager "R" - Residence |
FhPerPhone2 | varchar(17) | 1st Holder Permanent Secondary Phone (Obsolete in SharePro no need to pass now) |
FhPerEmail | varchar(50) | 1st Holder Permanent Email (Obsolete in SharePro no need to pass now) |
FhAadhaar | char(15) | 1st Holder Aadhaar |
FhUidFlag | char(1) | 1st Holder Aadhaar Flag (If send Y then FhAadhaar is mandatory) “N” - UID not verified “Y” - UID verified by DP OR You can send direct code (If send 2 then FhAadhaar is mandatory) “0” - UID not verified “2” - UID verified by DP |
FhInstraId | char(8) | Instra Id Length should be 8 digits |
AcopenSource | char(1) | Account Opening Flag: “1” : Online Account opening by the BO “2” : Account Opening based on submission of Physical documents |
FhProductNo | varchar(2) | 1st Holder Product Description - Product No. Value must be between "01" and "57" Please refer to *view CDSL Product Description Codes |
FhSubStatus | varchar(4) | 1st Holder Product Sub Status Code Please refer to view CDSL Product Sub Status Codes |
FhCategory | varchar(2) | BO Product Category value must be between "01" and "15" Please refer to view CDSL Category Codes |
FhDPIntRefNo | varchar(10) | 1st Holder DP Internal Ref No |
*FhOccupation | char(4) | 1st Holder Occupation is compulsory "B" - Business "H" - Housewife "P" - Professional "O" - Others "R" - Retired "ST" - Student "F" - Farmer "PV" - Private Sector "PS" - Public Sector "GS" - Government Sector "S" - Service |
FhConfWaivedYesNo | char(1) | Confirmation Waived “Y” - Yes “N” - No |
FhStmntCycle | char(2) | BO Statement Cycle value must be in "EM" - End of Month "2M" - Twice Monthly 15 & End of Month "DA" - Daily "EW" - End of Week |
FhECSYesNo | char(1) | ECS/Mandate “Y” - Yes “N” - No |
FhSettPlanYesNo | char(1) | Settlement Planning flag “Y” - Yes “N” - No |
FhIncomeCode | varchar(4) | Annual Income Code "1" - UpTo 1 Lakhs "6" - 1 Lakhs To 5 Lakhs "7" - 5 Lakhs To 10 Lakhs "8" - 10 Lakhs To 25 Lakhs "9" - Above 25 Lakhs "10" - 25 Lakhs To 1 Crore "11" - Above 1 Crore |
"11" - Above 1 Crore | varchar(2) | Beneficiary Tax Deduction value must be in "2" - Resident Individual "3" - NRI with Repatriation "4" - NRI without Repatriation "5" - Domestic Company "6" - Overseas Corporate Bodies "9" - Double Taxation Treaty "10" - Others |
FhEducation | char(4) | Education/Degree value "02" - Graduate "01" - High School "03" - Postgraduate "04" - Doctorate "05" - Professional Degree "06" - Under High School "07" - Illiterate "08" - Others "99" - None |
FhGeoCode | char(4) | Geographical Code "M" - Metropolitan "O" - Others "R" - Rural "SU" - Semi-Urban "U" - Urban, "N" - None |
FhStaff_Relative | char(1) | Staff/Relative "N" - Neither staff nor Relative "S" - Staff of the DP "R" - Relative of staff of DP "X" - None |
FhStaffCode | varchar(10) | Staff Code ( in Product Details) |
FhLanguageCode | varchar(2) | "3" - English "5" - Hindi "10" - Oriya "11" - Punjabi "12" - Sanskrit "13" - Sindhi "14" - Tamil "15" - Telegu "16" - Urdu "2" - Bengali "4" - Gujrati "6" - Kannada "7" - Kashmiri "8" - Malyalam "9" - Marathi "0" - None |
FhGroupCode | varchar(8) | Group Code ( in Product Details) |
FhClrngCorpId | char(2) | 1st Holder Clearing Corporation Id * If have Clearing Member Account then it is mandatory "00" : None "10" : BOI Shareholding Limited "11" : National Securities Clearing Corporation Limited "12" : The Calcutta Stock Exchange - Clearing House "13" : The Delhi Stock Exchange - Clearing House "14" : Ahmedabad Stock Exchange –- Clearing House "15" : Vadodara Stock Exchange - Clearing House "16" : Madras Stock Exchange Limited "17" : Bangalore Stock Exchange "18" : National Securities Clearing Corporation Limited - OTCEI "19" : Bombay Stock Exchange Limited - CISA "20" : Ludhiana Stock Exchange - Clearing House "21" : National Commodity Derivates Exchange Limited "22" : Multi Commodity Exchange of India Limited - Clearing House "23" : National Securities Clearing Corporation Limited - SLB "25" : BSE-SLB Limited - SLB - CISA "26" : National Spot Exchange Limited |
FhStkExchngId | char(2) | 1st Holder Stock Exchange Id * If have Clearing Member Account then it is mandatory “11” : Bombay Stock Exchange Limited -- CDSL “12” : National Stock Exchange Limited -- CDSL “22” : National Commodity Derivates Exchange Limited -- CDSL “23” : Multi Commodity Exchange of India Limited -- CDSL “29” : METROPOLITAN STOCK EXCHANGE OF INDIA LIMITED -- CDSL “01” : NSE -- NSDL “02” : BSE -- NSDL “03” : MSE -- NSDL “04” : NCDEX -- NSDL “05” : MCX -- NSDL “06” : ICEX -- NSDL |
FhClrngMemberId | char(8) | Clearing Member Id * If have Clearing Member Account then it is mandatory |
FhSebiRegNo | char(24) | SEBI Registration Id * If have Clearing Member Account then it is mandatory |
FhTradingId | char(8) | Trading Id * If have Clearing Member Account then it is mandatory |
FhPoaRegNo | varchar(16) | POA Reg No bIf have POA id then it is mandatory* |
FhPoaId | varchar(16) | * If have POA id then it is mandatory |
FhPoaType | char(1) | "R" - Regular POA "C" - Clearing Member POA |
FhPoaPurposeCode | varchar(20) | "4" - All Holder "1" - First Holder "2" Second Holder "3" - Third Holder |
FhPoaSetupDate | datetime | * If have POA id then it is mandatory |
FhPoaOptrYesNo | char(1) | POA Operator “Y” - Yes “N” - No |
FhGPA_BPA | char(1) | POA BPA/BPA "G" - "GPA" "B" - "BPA" "A" - "All DDPI Options" "S" - "Settlement" "P" - "Margin Pledge" "M" - "Mutual Fund MF" "T" - "Tendering shares in Open- offers TO" |
FhPoaFromDate | datetime | * If have POA id then it is mandatory |
FhPoaToDate | datetime | |
FhPoaRemarks | varchar(50) | |
FhAnnualReport | char(1) | Annual Report Flag "1" - Physical Annual Report "2" - Electronic Annual Report "3" - Both Physical and Electronic Annual Report |
FhBsda | char(1) | BSDA Flag "N" - No "Y" - Yes "O" - Opted Out |
FhEmailRtaYesNo | char(1) | Download Email RTA Flag “Y” - Yes “N” - No |
FhPledgeIndYesNo | char(1) | Pledge Standing Indicator “Y” - Yes “N” - No |
FhRgessYesNo | char(1) | RGESS Flag “Y” - Yes “N” - No |
FhEmailStmntYesNo | char(1) | Email Statement flag “Y” - Yes “N” - No |
FhDisabilityYesNo | char(1) | Mental Disability flag “Y” - Yes “N” - No |
FhFmlyAccYesNo | char(1) | Family Account flag “Y” - Yes “N” - No |
FhCasMode | char(2) | CAS Mode "" - None "PH" - Physical CAS "NO" - CAS not required |
FhCasDepository | char(1) | Preferred Depository for CAS "" - None "C" - CDSL "N" - NSDL |
RMCode | char(10) | |
GSTIN | char(15) | |
GSTRegDate | datetime | |
ChargeCd | char(8) | Charge Basket CD |
Authorised Signatory | ||
Img | text - Base64String | |
Bank | ||
BankType | char(2) | Like : "22" - Dividend Bank (Obsolete in SharePro no need to pass now) |
BankAcNo | varchar(20) | |
MicrNo | char(12) | |
IFSC | char(15) | |
BankAcType | varchar(15) | "10" - Savings "11" - Current "13" - Cash Credit |
BankCurrency | varchar(15) | "999001" - Indian Rupees "999002" - US Dollar "999003" - UK Pound |
Second Holder | ||
ShTitle | varchar(10) | Like MR, MRS |
ShFirstName | varchar(100) | |
ShMiddleName | varchar(20) | |
ShLastName | varchar(20) | |
ShSuffix | varchar(10) | |
ShFather | varchar(50) | |
ShMother | varchar(100) | |
ShPan | varchar(25) | |
ShITCircle | varchar(15) | IT Circle / Ward / District |
ShAadhaar | char(15) | |
ShEmail | varchar(50) | |
ShMobile | char(10) | |
Third Holder | ||
ThTitle | varchar(10) | Like MR, MRS |
ThFirstName | varchar(100) | |
ThMiddleName | varchar(20) | |
ThLastName | varchar(20) | |
ThSuffix | varchar(10) | |
ThFather | varchar(50) | |
ThMother | varchar(100) | |
ThPan | varchar(25) | |
ThITCircle | varchar(15) | IT Circle / Ward / District |
ThAadhaar | char(15) | |
ThEmail | varchar(50) | |
ThMobile | char(10) | |
First Nominee | ||
Nom1Title | varchar(10) | Like MR, MRS |
Nom1FirstName | varchar(100) | |
Nom1MiddleName | varchar(20) | |
Nom1LastName | varchar(20) | |
Nom1Suffix | varchar(10) | Like DR |
Nom1Father | varchar(50) | |
Nom1Addr1 | varchar(30) | |
Nom1Addr2 | varchar(30) | |
Nom1Addr3 | varchar(30) | |
Nom1City | varchar(25) | |
Nom1State | varchar(25) | State Name |
Nom1StateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD Like : For West Bengal : WB |
Nom1Country | varchar(25) | Like: India |
Nom1Pin | varchar(10) | Pincode |
Nom1PhoneInd1 | char(1) | (Obsolete in SharePro no need to pass now) |
Nom1Phone1 | varchar(17) | Primary Mobile |
Nom1PhoneInd2 | char(1) | (Obsolete in SharePro no need to pass now) |
Nom1Phone2 | varchar(17) | (Obsolete in SharePro no need to pass now) |
Nom1AdtnlPhone | varchar(100) | (Obsolete in SharePro no need to pass now) |
Nom1Fax | varchar(17) | |
Nom1Email | varchar(50) | Primary Email |
Nom1Pan | varchar(25) | Income Tax PAN No |
Nom1ITCircle | varchar(15) | IT Circle / Ward / District |
Nom1MinorYesNo | char(1) | Minor Flag “Y” - Yes “N” - No |
Nom1MinorDOB | datetime | Minor Date of Birth (yyyy-mm-dd |
Nom1Relation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Nom1SharePer | numeric(6, 2) | Nominee Share % |
Nom1ResSecYesNo | char(1) | Residual Security flag “Y” - Yes “N” - No |
Second Nominee | ||
Nom2Title | varchar(20) | Like MR, MRS |
Nom2FirstName | varchar(200) | |
Nom2MiddleName | varchar(20) | |
Nom2LastName | varchar(20) | |
Nom2Suffix | varchar(20) | Like DR |
Nom2Father | varchar(50) | |
Nom2Addr1 | varchar(30) | |
Nom2Addr2 | varchar(30) | |
Nom2Addr3 | varchar(30) | |
Nom2City | varchar(25) | |
Nom2State | varchar(25) | State Name |
Nom2StateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD |
Nom2Country | varchar(25) | Like: India |
Nom2Pin | varchar(20) | Pincode |
Nom2PhoneInd1 | char(2) | (Obsolete in SharePro no need to pass now) |
Nom2Phone1 | varchar(27) | Primary Mobile |
Nom2PhoneInd2 | char(2) | (Obsolete in SharePro no need to pass now) |
Nom2Phone2 | varchar(27) | (Obsolete in SharePro no need to pass now) |
Nom2AdtnlPhone | varchar(200) | (Obsolete in SharePro no need to pass now) |
Nom2Fax | varchar(27) | |
Nom2Email | varchar(50) | Primary Email |
Nom2Pan | varchar(25) | Income Tax PAN No |
Nom2ITCircle | varchar(25) | IT Circle / Ward / District |
Nom2MinorYesNo | char(2) | Minor Flag “Y” - Yes “N” - No |
Nom2MinorDOB | datetime | Minor Date of Birth |
Nom2Relation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Nom2SharePer | numeric(6, 2) | Nominee Share % |
Nom2ResSecYesNo | char(2) | Residual Security flag “Y” - Yes “N” - No |
Third Nominee | ||
Nom3Title | varchar(30) | Like MR, MRS |
Nom3FirstName | varchar(300) | |
Nom3MiddleName | varchar(20) | |
Nom3LastName | varchar(20) | |
Nom3Suffix | varchar(30) | Like DR |
Nom3Father | varchar(50) | |
Nom3Addr1 | varchar(30) | |
Nom3Addr2 | varchar(30) | |
Nom3Addr3 | varchar(30) | |
Nom3City | varchar(25) | |
Nom3State | varchar(25) | State Name |
Nom3StateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD |
Nom3Country | varchar(25) | Like: India |
Nom3Pin | varchar(30) | Pincode |
Nom3PhoneInd1 | char(3) | (Obsolete in SharePro no need to pass now) |
Nom3Phone1 | varchar(37) | Primary Mobile |
Nom3PhoneInd2 | char(3) | (Obsolete in SharePro no need to pass now) |
Nom3Phone2 | varchar(37) | (Obsolete in SharePro no need to pass now) |
Nom3AdtnlPhone | varchar(300) | (Obsolete in SharePro no need to pass now) |
Nom3Fax | varchar(37) | |
Nom3Email | varchar(50) | Primary Email |
Nom3Pan | varchar(25) | Income Tax PAN No |
Nom3ITCircle | varchar(35) | IT Circle / Ward / District |
Nom3MinorYesNo | char(3) | Minor Flag “Y” - Yes “N” - No |
Nom3MinorDOB | datetime | Minor Date of Birth |
Nom3Relation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Nom3SharePer | numeric(6, 2) | Nominee Share % |
Nom3ResSecYesNo | char(3) | Residual Security flag “Y” - Yes “N” - No |
Minor Guardian | ||
MinGrdTitle | varchar(30) | Like MR, MRS |
MinGrdFirstName | varchar(300) | |
MinGrdMiddleName | varchar(20) | |
MinGrdLastName | varchar(20) | |
MinGrdSuffix | varchar(30) | Like DR |
MinGrdFather | varchar(50) | |
MinGrdAddr1 | varchar(30) | |
MinGrdAddr2 | varchar(30) | |
MinGrdAddr3 | varchar(30) | |
MinGrdCity | varchar(25) | |
MinGrdState | varchar(25) | State Name |
MinGrdStateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD Like : For West Bengal : WB |
MinGrdCountry | varchar(25) | Like: India |
MinGrdPin | varchar(30) | Pincode |
MinGrdPhoneInd1 | char(3) | (Obsolete in SharePro no need to pass now) |
MinGrdPhone1 | varchar(37) | Primary Mobile |
MinGrdPhoneInd2 | char(3) | (Obsolete in SharePro no need to pass now) |
MinGrdPhone2 | varchar(37) | (Obsolete in SharePro no need to pass now) |
MinGrdAdtnlPhone | varchar(300) | (Obsolete in SharePro no need to pass now) |
MinGrdFax | varchar(37) | |
MinGrdEmail | varchar(50) | Primary Email |
MinGrdPan | Income Tax PAN No | |
MinGrdITCircle | varchar(35) | IT Circle / Ward / District |
MinGrdMinorYesNo | char(3) | Minor Flag “Y” - Yes “N” - No |
MinGrdMinorDOB | datetime | Minor Date of Birth |
MinGrdRelation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
First Minor Nominee Guardian | ||
MinNom1GrdTitle | varchar(30) | Like MR, MRS |
MinNom1GrdFirstName | varchar(300) | |
MinNom1GrdMiddleName | varchar(20) | |
MinNom1GrdLastName | varchar(20) | |
MinNom1GrdSuffix | varchar(30) | Like DR |
MinNom1GrdFather | varchar(50) | |
MinNom1GrdAddr1 | varchar(30) | |
MinNom1GrdAddr2 | varchar(30) | |
MinNom1GrdAddr3 | varchar(30) | |
MinNom1GrdCity | varchar(25) | |
MinNom1GrdState | varchar(25) | State Name |
MinNom1GrdStateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD Like : For West Bengal : WB |
MinNom1GrdCountry | varchar(25) | Like: India |
MinNom1GrdPin | varchar(30) | Pincode |
MinNom1GrdPhoneInd1 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom1GrdPhone1 | varchar(37) | Primary Mobile |
MinNom1GrdPhoneInd2 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom1GrdPhone2 | varchar(37) | (Obsolete in SharePro no need to pass now) |
MinNom1GrdAdtnlPhone | varchar(300) | (Obsolete in SharePro no need to pass now) |
MinNom1GrdFax | varchar(37) | |
MinNom1GrdEmail | varchar(50) | Primary Email |
MinNom1GrdPan | varchar(25) | Income Tax PAN No |
MinNom1GrdITCircle | varchar(35) | IT Circle / Ward / District |
MinNom1GrdMinorYesNo | char(3) | Minor Flag “Y” - Yes “N” - No |
MinNom1GrdMinorDOB | datetime | Minor Date of Birth |
MinNom1GrdRelation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Second Minor Nominee Guardian | ||
MinNom2GrdTitle | varchar(30) | Like MR, MRS |
MinNom2GrdFirstName | varchar(300) | |
MinNom2GrdMiddleName | varchar(20) | |
MinNom2GrdLastName | varchar(20) | |
MinNom2GrdSuffix | varchar(30) | Like DR |
MinNom2GrdFather | varchar(50) | |
MinNom2GrdAddr1 | varchar(30) | |
MinNom2GrdAddr2 | varchar(30) | |
MinNom2GrdAddr3 | varchar(30) | |
MinNom2GrdCity | varchar(25) | |
MinNom2GrdState | varchar(25) | State Name |
MinNom2GrdStateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD Like : For West Bengal : WB |
MinNom2GrdCountry | varchar(25) | Like: India |
MinNom2GrdPin | varchar(30) | Pincode |
MinNom2GrdPhoneInd1 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom2GrdPhone1 | varchar(37) | Primary Mobile |
MinNom2GrdPhoneInd2 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom2GrdPhone2 | varchar(37) | (Obsolete in SharePro no need to pass now) |
MinNom2GrdAdtnlPhone | varchar(300) | (Obsolete in SharePro no need to pass now) |
MinNom2GrdFax | varchar(37) | |
MinNom2GrdEmail | varchar(50) | Primary Email |
MinNom2GrdPan | varchar(25) | Income Tax PAN No |
MinNom2GrdITCircle | varchar(35) | IT Circle / Ward / District |
MinNom2GrdMinorYesNo | char(3) | Minor Flag “Y” - Yes “N” - No |
MinNom2GrdMinorDOB | datetime | Minor Date of Birth |
MinNom2GrdRelation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Third Minor Nominee Guardian | ||
MinNom3GrdTitle | varchar(30) | |
MinNom3GrdFirstName | varchar(300) | |
MinNom3GrdMiddleName | varchar(20) | |
MinNom3GrdLastName | varchar(20) | |
MinNom3GrdSuffix | varchar(30) | Like DR |
MinNom3GrdFather | varchar(50) | |
MinNom3GrdAddr1 | varchar(30) | |
MinNom3GrdAddr2 | varchar(30) | |
MinNom3GrdAddr3 | varchar(30) | |
MinNom3GrdCity | varchar(25) | |
MinNom3GrdState | varchar(25) | State Name |
MinNom3GrdStateCd | char(6) | Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD Like : For West Bengal : WB |
MinNom3GrdCountry | varchar(25) | Like: India |
MinNom3GrdPin | varchar(30) | Pincode |
MinNom3GrdPhoneInd1 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom3GrdPhone1 | varchar(37) | Primary Mobile |
MinNom3GrdPhoneInd2 | char(3) | (Obsolete in SharePro no need to pass now) |
MinNom3GrdPhone2 | varchar(37) | (Obsolete in SharePro no need to pass now) |
MinNom3GrdAdtnlPhone | varchar(300) | (Obsolete in SharePro no need to pass now) |
MinNom3GrdFax | varchar(37) | |
MinNom3GrdEmail | varchar(50) | Primary Email |
MinNom3GrdPan | varchar(25) | Income Tax PAN No |
MinNom3GrdITCircle | varchar(35) | IT Circle / Ward / District |
MinNom3GrdMinorYesNo | char(3) | Minor Flag “Y” - Yes “N” - No |
MinNom3GrdMinorDOB | datetime | Minor Date of Birth |
MinNom3GrdRelation | char(2) | "01" : Spouse "02" : Son "03" : Daughter "04" : Father "05" : Mother "06" : Brother "07" : Sister "08" : Grand-Son "09" : Granddaughter "10" : Grandfather "11" : Grandmother "12" : Not Provided "13" : Others |
Other data | ||
OpMode | char(1) | Mode of Operation Anyone or Survivor : 2, Jointly: 1, Sole Holder: 0 |
CommPref | char(1) | Communication Preference All Holder: 2, First Holder: 1, None: 3 |
NomOpt | char(1) | Nomination Opt Out No: N, Yes: Y |
SMS | ||
Mobile | char(10) | (Obsolete in SharePro no need to pass now) |
Email2 | char(100) | (Obsolete in SharePro no need to pass now) |
SmsRemarks | char(100) | (Obsolete in SharePro no need to pass now) |
ADDUSER | char(10) | Record inserted by (like a 3r party vendor name : KYCDone) "AddUser": "KYCDone" |
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"CompanyId": "06",
"BranchID": "HO",
"FhTitle": "Mr",
"FhFirstName": "Dummy First Name",
"FhMiddleName": "Dummy Middle Name",
"FhLastName": "Dummy Last Name",
"FhFather": "Dummy Father Name",
"FhDOB": "1990-06-02",
"FhGender": "M",
"FhAddr1": "25/1, Goaltuli Lane",
"FhAddr2": "Taltala",
"FhAddr3": "New Market",
"FhCity": "Kolkata",
"FhStateCode": "WB",
"FhCountry": "India",
"FhPin": "700013",
"FhNationCode": "01",
"FhPan": "AAAAA1111A",
"FhPhoneInd1": "M",
"FhPhone1": "9748585397",
"FhPhone2": "22441139",
"FhEmail": "dummy@gmail.com",
"FhPerAddr1": "25/1, Goaltuli Lane",
"FhPerAddr2": "Taltala",
"FhPerAddr3": "New Market",
"FhPerCity": "Kolkata",
"FhPerState": "West Bengal",
"FhPerCountry": "India",
"FhPerPin": "700013",
"FhAadhaar": "111122223333",
"GSTIN": "AAAAA1111A1ZA",
"BankAcNo": "1111222233334444",
"MicrNo": "110002031",
"IFSC": "SBIN0006064",
"Nom1FirstName": "Nominee First Name",
"Nom1LastName": "Nominee Last Name",
"Nom1Father": "Nominee Father Name",
"Nom1Addr1": "Nominee Addr1",
"Nom1City": "Kolkata",
"Nom1State": "West Bengal",
"Nom1Country": "India",
"Nom1Pin": "700013",
"Mobile": "9758782569",
"Email2": "nominee@gmail.com",
"SmsRemarks": "Test CDSL Client"
}
Return Data | Sample |
---|---|
JSon Data:
|
|
NewNSDLClientRegistration
Endpoint : NewNSDLClientRegistration
Method : POST or GET| Send raw Json data in Body
-
Creates a new NSDL Client in DPPro
-
Get NSDL Code Details : view NSDL Codes
-
Request Data
API Parameter | Data Type | Explanation |
---|---|---|
*key | varchar(100) | REST API Key |
CompanyId | char(2) | SharePro Company Code of NSDL. A broker may have multiple NSDL Depository Licenses. If value is not passed, the call picks up the first available NSDL segment in SharePro. |
BranchId | char(4) | SharePro Branchid. If not passed, the client is created in “HO”. Please refer to getBranchesList call to get a list of branches with the broker |
ClientId | char(8) | Instra ClientId |
First Holder | ||
*FhName | char(45) | 1st Holder Name is compulsory |
ShortName | char(16) | |
*FhDOB | datetime | 1st Holder Date of Birth is compulsory |
Gender | char(1) | "M" - Male "F" - Female "X" - None (This parameter is Obsolete no need to pass now) |
*FhGender | char(1) | 1st Holder Gender is compulsory Male: 1 Female: 2 Transgender: 3 |
*FhFather | char(45) | 1st Holder Father's Name is compulsory |
FhMother | varchar(100) | |
*BenType | char(2) | Beneficiary Type is compulsory Please refer to view NSDL Codes and search Client Type / Ben Type (For single digit code please pass code with leading zero like for 1 = 01) |
*BenSubType | char(4) | Beneficiary Sub Type is compulsory Please refer to view NSDL Codes and search Ben SubType (For single digit code please pass code with leading zero like for 1 = 01) |
*BenCategory | char(2) | Beneficiary Sub Type is compulsory Please refer to view NSDL Codes and search Account Category (For single digit code please pass code with leading zero like for 1 = 01) |
*BenOccupation | char(2) | Beneficiary Sub Type is compulsory Please refer to view NSDL Codes and search Client Occupation Code (For single digit code please pass code with leading zero like for 1 = 01) |
BoardOfReso | bit | Board meeting/resolution is done? “0” : No “1” : Yes |
MemoOfArticle | bit | Have Company details ? |
*FhEmail | char(50) | 1st Holder Email is compulsory |
FhAltEmail1 | char(50) | 1st Holder Secondary Email 1 |
FhAltEmail2 | char(50) | 1st Holder Secondary Email 2 |
FhLandPhone | char(30) | |
*FhMobile | char(12) | 1st Holder Mobile is compulsory |
*FhSmsYesNo | char(1) | 1st Holder send SMS value must be in "Y" - Yes "N" - No |
PidProofCd | char(2) | 1st Holder Proof of Identity Please refer to view NSDL Codes and search PHOTOID PROOF (idProofCd) |
*FhPAN | char(10) | 1st Holder PAN is compulsory |
*FhAadhaar | char(12) | 1st Holder Aadhaar is compulsory |
FhMapin | char(9) | Mapin Id given by company |
FhRtaYesNo | char(1) | Is Registered of transferred agent registered ? ”N” - No “Y” - Yes |
FhFmlyEmailYesNo | char(1) | Family Email Flag ”N” - No “Y” - Yes |
FhFmlyMobileYesNo | char(1) | Family Mobile Flag ”N” - No “Y” - Yes |
UCC | char(10) | Client with this UCC must be exists in SharePro |
StaningIndicator | char(1) | Auto Credit ”N” - No “Y” - Yes |
CustClntYesNo | char(1) | Having Custodian Identification no? ”N” - No “Y” - Yes |
CustIncomeCd | char(4) | "" - None "1" - UpTo 1 Lakhs "6" - 1 Lakhs To 5 Lakhs "7" - 5 Lakhs To 10 Lakhs "8" - 10 Lakhs To 25 Lakhs "9" - Above 25 Lakhs "10" - 25 Lakhs To 1 Crore "11" - Above 1 Crore |
SharePerYesNo | char(1) | Having Share %? ”N” - No “Y” - Yes |
RiskProfile | char(20) | Low Risk High Risk Medium Risk |
RmCode | char(10) | |
GSTIN | char(15) | |
GSTRegDate | datetime | |
*FhBankAcNo | char(30) | 1st Holder Bank Account No. is compulsory |
*BankAcType | numeric(2, 0) | 1st Holder Bank Account Type is compulsory "10" - Savings "11" - Current "13" - Other Please refer to view NSDL Codes and search Bank Account Type |
*MicrNo | char(9) | MICR No. of Bank is compulsory |
*IFSC | char(11) | IFSC of Bank is compulsory |
EStatementYesNo | char(1) | E-Statement Flag ”N” - No “Y” - Yes |
FhRbiRefNo | char(50) | |
RbiApprovalDate | datetime | |
SebiRegNo | char(24) | |
FhTds | char(20) | |
AdrProofCd | char(2) | 1st Holder Proof of Address Please refer to view NSDL Codes and search Address Proof - AdrProofCd |
*StateCode | char(4) | GST State Code is compulsory Please refer to getStateCodeList call to get a list of States with the broker. Need to pass GSTStateCD |
*BenLclAdrYesNo | char(1) | Beneficiary Local Address value must be either "Y" or "N" ”N” - No “Y” - Yes |
NoOfFhSignAuth | numeric(2, 0) | |
ExchangeId | char(8) | |
SenderRefNo1 | char(35) | |
SenderRefNo2 | char(35) | |
ChargeCd | char(8) | Charge Basket Cd |
GroupCd | char(4) | Family Group Cd |
CommissionCd | char(5) | |
DespatchCd | char(5) | |
RgessYesNo | char(1) | RGESS value must be in ”N” - No “Y” - Yes |
BsdaYesNo | char(1) | BSDA value must be in ”N” - No “Y” - Yes |
CommodityYesNo | char(1) | ”N” - No “Y” - Yes |
AutoPledgeYesNo | char(1) | ”N” - No “Y” - Yes |
MinorIndYesNo | char(1) | ”N” - No “Y” - Yes |
MinorName | char(45) | |
MinorGuardian | char(45) | |
NomineeIndicator | char(1) | "" : No Nominee |
NomineeName | char(45) | 1st Holder 1st Nominee Name |
NomineeGuardian | char(45) | 1st Holder 1st Nominee Guardian Name |
NomineeDOB | datetime | 1st Holder 1st Nominee DOB |
MinorNominee1DOB | datetime | 1st Holder 1st Minor Nominee DOB |
NomineeName2 | char(45) | 1st Holder 2nd Nominee Name |
NomGrdn2SameAs1 | char(1) | Nominee Guardian 2 same as 1 ”N” - No |
NomineeGuardian2 | char(45) | 1st Holder 2nd Nominee Guardian Name |
MinorNominee2DOB | datetime | 1st Holder 2nd Minor Nominee DOB |
NomineeName3 | char(45) | 1st Holder 3rd Nominee Name |
NomGrdn3SameAs1 | char(1) | Nominee Guardian 3 same as 1 ”N” - No “Y” - Yes |
NomineeGuardian3 | char(45) | 1st Holder 3rd Nominee Guardian Name |
MinorNominee3DOB | datetime | 1st Holder 3rd Minor Nominee DOB |
GrossIncome | char(2) | "01" - Below 1 Lac "02" - 1-5 Lacs "03" - 5-10 Lacs "04" - 10-25 Lacs "05" - Above 25 Lacs |
Second Holder | ||
ShName | char(45) | |
ShDOB | datetime | |
ShGender | char(1) | 2nd Holder Gender Male: 1, Female: 2, Transgender: 3 |
ShFather | char(45) | |
ShMother | varchar(100) | |
ShEmail | char(50) | |
ShAltEmail | char(50) | |
ShLandPhone | char(30) | |
ShMobile | char(12) | |
ShSmsYesNo | char(1) | ”N” - No “Y” - Yes |
ShPAN | char(10) | |
ShAadhaar | char(12) | |
ShMapin | char(9) | |
ShRtaYesNo | char(1) | ”N” - No “Y” - Yes |
ShFmlyEmailYesNo | char(1) | ”N” - No “Y” - Yes |
ShFmlyMobileYesNo | char(1) | ”N” - No “Y” - Yes |
NoOfShSignAuth | numeric(2, 0) | |
Third Holder | ||
ThName | char(45) | |
ThDOB | datetime | |
ThGender | char(1) | 3rd Holder Gender Male: 1, Female: 2, Transgender: 3 |
ThFather | char(45) | |
ThMother | varchar(100) | |
ThEmail | char(50) | |
ThAltEmail | char(50) | |
ThLandPhone | char(30) | |
ThMobile | char(12) | |
ThSmsYesNo | char(1) | ”N” - No “Y” - Yes |
ThPAN | char(10) | |
ThAadhaar | char(12) | |
ThMapin | char(9) | |
ThRtaYesNo | char(1) | ”N” - No “Y” - Yes |
ThFmlyEmailYesNo | char(1) | ”N” - No “Y” - Yes |
ThFmlyMobileYesNo | char(1) | ”N” - No “Y” - Yes |
NoOfThSignAuth | numeric(2, 0) | |
First Holder Local | ||
*FhLclAddress1 | char(36) | 1st Holder Local Address is compulsory |
FhLclAddress2 | char(36) | |
FhLclAddress3 | char(36) | |
FhLclAddress4 | char(36) | |
FhLclStateCd | char(2) | Please refer to view NSDL Codes and search State Code |
*FhLclCntryCd | char(3) | “356” : India Please refer to view NSDL Codes and search Country Code |
*FhLclPin | char(10) | 1st Holder Local PIN is compulsory |
FhLclPhone | char(24) | |
FhLclFax | char(24) | |
*FhLclMobile | numeric(13, 0) | 1st Holder Local Mobile is compulsory |
*FhLclEmail | char(50) | 1st Holder Local Email is compulsory |
*FhLclPAN | char(10) | 1st Holder Local PAN compulsory |
*FhLclAadhaar | char(12) | 1st Holder Local Aadhaar compulsory |
FhLclSharePer | numeric(3, 0) | |
First Holder Bank Address | ||
*FhBnkAddress1 | char(36) | 1st Holder Bank Address is compulsory |
FhBnkAddress2 | char(36) | |
FhBnkAddress3 | char(36) | |
FhBnkAddress4 | char(36) | |
*FhBnkPin | char(10) | 1st Holder Bank PIN is compulsory |
FhBnkPhone | char(24) | 1st Holder Bank Phone |
FhBnkFax | char(24) | |
FhBnkEmail | char(50) | 1st Holder Bank Email |
First Holder Foreign Address | ||
FhFrgnAddress1 | char(36) | |
FhFrgnAddress2 | char(36) | |
FhFrgnAddress3 | char(36) | |
FhFrgnAddress4 | char(36) | |
FhFrgnPin | char(10) | |
FhFrgnPhone | char(24) | |
FhFrgnFax | char(24) | |
FhFrgnMobile | numeric(13, 0) | |
FhFrgnEmail | char(50) | |
FhFrgnPAN | char(10) | |
FhFrgnAadhaar | char(12) | |
FhFrgnSharePer | numeric(3, 0) | |
First Holder 1st Nominee Address | ||
Fh1NomAddress1char(36) | ||
Fh1NomAddress2 | char(36) | |
Fh1NomAddress3 | char(36) | |
Fh1NomAddress4 | char(36) | |
Fh1NomPin | char(10) | |
Fh1NomPhone | char(24) | |
Fh1NomFax | char(24) | |
Fh1NomMobile | numeric(13, 0) | |
Fh1NomEmail | char(50) | |
Fh1NomPAN | char(10) | |
Fh1NomAadhaar | char(12) | |
Fh1NomSharePer | numeric(3, 0) | |
First Holder 2nd Nominee Address | ||
Fh2NomAddress1char(36) | ||
Fh2NomAddress2 | char(36) | |
Fh2NomAddress3 | char(36) | |
Fh2NomAddress4 | char(36) | |
Fh2NomPin | char(10) | |
Fh2NomPhone | char(24) | |
Fh2NomFax | char(24) | |
Fh2NomMobile | numeric(13, 0) | |
Fh2NomEmail | char(50) | |
Fh2NomPAN | char(10) | |
Fh2NomAadhaar | char(12) | |
Fh2NomSharePer | numeric(3, 0) | |
First Holder 3rd Nominee Address | ||
Fh3NomAddress1char(36) | ||
Fh3NomAddress2 | char(36) | |
Fh3NomAddress3 | char(36) | |
Fh3NomAddress4 | char(36) | |
Fh3NomPin | char(10) | |
Fh3NomPhone | char(24) | |
Fh3NomFax | char(24) | |
Fh3NomMobile | numeric(13, 0) | |
Fh3NomEmail | char(50) | |
Fh3NomPAN | char(10) | |
Fh3NomAadhaar | char(12) | |
Fh3NomSharePer | numeric(3, 0) | |
1st Minor | ||
Fh1MinAddress1 | char(36) | |
Fh1MinAddress2 | char(36) | |
Fh1MinAddress3 | char(36) | |
Fh1MinAddress4 | char(36) | |
Fh1MinPin | char(10) | |
Fh1MinPhone | char(24) | |
Fh1MinFax | char(24) | |
Fh1MinMobile | numeric(13, 0) | |
Fh1MinEmail | char(50) | |
Fh1MinPAN | char(10) | |
Fh1MinAadhaar | char(12) | |
Fh1MinSharePer | numeric(3, 0) | |
2nd Minor | ||
Fh2MinAddress1 | char(36) | |
Fh2MinAddress2 | char(36) | |
Fh2MinAddress3 | char(36) | |
Fh2MinAddress4 | char(36) | |
Fh2MinPin | char(10) | |
Fh2MinPhone | char(24) | |
Fh2MinFax | char(24) | |
Fh2MinMobile | numeric(13, 0) | |
Fh2MinEmail | char(50) | |
Fh2MinPAN | char(10) | |
Fh2MinAadhaar | char(12) | |
Fh2MinSharePer | numeric(3, 0) | |
3rd Minor | ||
Fh3MinAddress1 | char(36) | |
Fh3MinAddress2 | char(36) | |
Fh3MinAddress3 | char(36) | |
Fh3MinAddress4 | char(36) | |
Fh3MinPin | char(10) | |
Fh3MinPhone | char(24) | |
Fh3MinFax | char(24) | |
Fh3MinMobile | numeric(13, 0) | |
Fh3MinEmail | char(50) | |
Fh3MinPAN | char(10) | |
Fh3MinAadhaar | char(12) | |
Fh3MinSharePer | numeric(3, 0) | |
Second Holder Local Address | ||
ShLclAddress1 | char(36) | |
ShLclAddress2 | char(36) | |
ShLclAddress3 | char(36) | |
ShLclAddress4 | char(36) | |
ShLclPin | char(10) | |
ShLclPhone | char(24) | |
ShLclFax | char(24) | |
ShLclMobile | numeric(13, 0) | |
ShLclEmail | char(50) | |
ShLclPAN | char(10) | |
ShLclAadhaar | char(12) | |
ShLclSharePer | numeric(3, 0) | |
Second Holder Bank Address | ||
ShBnkAddress1 | char(36) | |
ShBnkAddress2 | char(36) | |
ShBnkAddress3 | char(36) | |
ShBnkAddress4 | char(36) | |
ShBnkPin | char(10) | |
ShBnkPhone | char(24) | |
ShBnkFax | char(24) | |
ShBnkEmail | char(50) | |
Second Holder Foreign Address | ||
ShFrgnAddress1 | char(36) | |
ShFrgnAddress2 | char(36) | |
ShFrgnAddress3 | char(36) | |
ShFrgnAddress4 | char(36) | |
ShFrgnPin | char(10) | |
ShFrgnPhone | char(24) | |
ShFrgnFax | char(24) | |
ShFrgnMobile | numeric(13, 0) | |
ShFrgnEmail | char(50) | |
ShFrgnPAN | char(10) | |
ShFrgnAadhaar | char(12) | |
ShFrgnSharePer | numeric(3, 0) | |
Second Holder 1st Nominee | ||
Sh1NomAddress1 | char(36) | |
Sh1NomAddress2 | char(36) | |
Sh1NomAddress3 | char(36) | |
Sh1NomAddress4 | char(36) | |
Sh1NomPin | char(10) | |
Sh1NomPhone | char(24) | |
Sh1NomFax | char(24) | |
Sh1NomMobile | numeric(13, 0) | |
Sh1NomEmail | char(50) | |
Sh1NomPAN | char(10) | |
Sh1NomAadhaar | char(12) | |
Sh1NomSharePer | numeric(3, 0) | |
Second Holder 2nd Nominee | ||
Sh2NomAddress1 | char(36) | |
Sh2NomAddress2 | char(36) | |
Sh2NomAddress3 | char(36) | |
Sh2NomAddress4 | char(36) | |
Sh2NomPin | char(10) | |
Sh2NomPhone | char(24) | |
Sh2NomFax | char(24) | |
Sh2NomMobile | numeric(13, 0) | |
Sh2NomEmail | char(50) | |
Sh2NomPAN | char(10) | |
Sh2NomAadhaar | char(12) | |
Sh2NomSharePer | numeric(3, 0) | |
Second Holder 3rd Nominee | ||
Sh3NomAddress1 | char(36) | |
Sh3NomAddress2 | char(36) | |
Sh3NomAddress3 | char(36) | |
Sh3NomAddress4 | char(36) | |
Sh3NomPin | char(10) | |
Sh3NomPhone | char(24) | |
Sh3NomFax | char(24) | |
Sh3NomMobile | numeric(13, 0) | |
Sh3NomEmail | char(50) | |
Sh3NomPAN | char(10) | |
Sh3NomAadhaar | char(12) | |
Sh3NomSharePer | numeric(3, 0) | |
Second Holder 1st Minor | ||
Sh1MinAddress1 | char(36) | |
Sh1MinAddress2 | char(36) | |
Sh1MinAddress3 | char(36) | |
Sh1MinAddress4 | char(36) | |
Sh1MinPin | char(10) | |
Sh1MinPhone | char(24) | |
Sh1MinFax | char(24) | |
Sh1MinMobile | numeric(13, 0) | |
Sh1MinEmail | char(50) | |
Sh1MinPAN | char(10) | |
Sh1MinAadhaar | char(12) | |
Sh1MinSharePer | numeric(3, 0) | |
Second Holder 2nd Minor | ||
Sh2MinAddress1 | char(36) | |
Sh2MinAddress2 | char(36) | |
Sh2MinAddress3 | char(36) | |
Sh2MinAddress4 | char(36) | |
Sh2MinPin | char(10) | |
Sh2MinPhone | char(24) | |
Sh2MinFax | char(24) | |
Sh2MinMobile | numeric(13, 0) | |
Sh2MinEmail | char(50) | |
Sh2MinPAN | char(10) | |
Sh2MinAadhaar | char(12) | |
Sh2MinSharePer | numeric(3, 0) | |
Second Holder 3rd Minor | ||
Sh3MinAddress1 | char(36) | |
Sh3MinAddress2 | char(36) | |
Sh3MinAddress3 | char(36) | |
Sh3MinAddress4 | char(36) | |
Sh3MinPin | char(10) | |
Sh3MinPhone | char(24) | |
Sh3MinFax | char(24) | |
Sh3MinMobile | numeric(13, 0) | |
Sh3MinEmail | char(50) | |
Sh3MinPAN | char(10) | |
Sh3MinAadhaar | char(12) | |
Sh3MinSharePer | numeric(3, 0) | |
Third Holder Local Address | ||
ThLclAddress1 | char(36) | |
ThLclAddress2 | char(36) | |
ThLclAddress3 | char(36) | |
ThLclAddress4 | char(36) | |
ThLclPin | char(10) | |
ThLclPhone | char(24) | |
ThLclFax | char(24) | |
ThLclMobile | numeric(13, 0) | |
ThLclEmail | char(50) | |
ThLclPAN | char(10) | |
ThLclAadhaar | char(12) | |
ThLclSharePer | numeric(3, 0) | |
Third Holder Bank Address | ||
ThBnkAddress1 | char(36) | |
ThBnkAddress2 | char(36) | |
ThBnkAddress3 | char(36) | |
ThBnkAddress4 | char(36) | |
ThBnkPin | char(10) | |
ThBnkPhone | char(24) | |
ThBnkFax | char(24) | |
ThBnkEmail | char(50) | |
Third Holder Foreign Address | ||
ThFrgnAddress1 | char(36) | |
ThFrgnAddress2 | char(36) | |
ThFrgnAddress3 | char(36) | |
ThFrgnAddress4 | char(36) | |
ThFrgnPin | char(10) | |
ThFrgnPhone | char(24) | |
ThFrgnFax | char(24) | |
ThFrgnMobile | numeric(13, 0) | |
ThFrgnEmail | char(50) | |
ThFrgnPAN | char(10) | |
ThFrgnAadhaar | char(12) | |
ThFrgnSharePer | numeric(3, 0) | |
Third Holder 1st Nominee Address | ||
Th1NomAddress1 | char(36) | |
Th1NomAddress2 | char(36) | |
Th1NomAddress3 | char(36) | |
Th1NomAddress4 | char(36) | |
Th1NomPin | char(10) | |
Th1NomPhone | char(24) | |
Th1NomFax | char(24) | |
Th1NomMobile | numeric(13, 0) | |
Th1NomEmail | char(50) | |
Th1NomPAN | char(10) | |
Th1NomAadhaar | char(12) | |
Th1NomSharePer | numeric(3, 0) | |
Third Holder 2nd Nominee Address | ||
Th2NomAddress1 | char(36) | |
Th2NomAddress2 | char(36) | |
Th2NomAddress3 | char(36) | |
Th2NomAddress4 | char(36) | |
Th2NomPin | char(10) | |
Th2NomPhone | char(24) | |
Th2NomFax | char(24) | |
Th2NomMobile | numeric(13, 0) | |
Th2NomEmail | char(50) | |
Th2NomPAN | char(10) | |
Th2NomAadhaar | char(12) | |
Th2NomSharePer | numeric(3, 0) | |
Third Holder 3rd Nominee Address | ||
Th3NomAddress1 | char(36) | |
Th3NomAddress2 | char(36) | |
Th3NomAddress3 | char(36) | |
Th3NomAddress4 | char(36) | |
Th3NomPin | char(10) | |
Th3NomPhone | char(24) | |
Th3NomFax | char(24) | |
Th3NomMobile | numeric(13, 0) | |
Th3NomEmail | char(50) | |
Th3NomPAN | char(10) | |
Th3NomAadhaar | char(12) | |
Th3NomSharePer | numeric(3, 0) | |
Third Holder 1st Minor Address | ||
Th1MinAddress1 | char(36) | |
Th1MinAddress2 | char(36) | |
Th1MinAddress3 | char(36) | |
Th1MinAddress4 | char(36) | |
Th1MinPin | char(10) | |
Th1MinPhone | char(24) | |
Th1MinFax | char(24) | |
Th1MinMobile | numeric(13, 0) | |
Th1MinEmail | char(50) | |
Th1MinPAN | char(10) | |
Th1MinAadhaar | char(12) | |
Th1MinSharePer | numeric(3, 0) | |
Third Holder 2nd Minor Address | ||
Th2MinAddress1 | char(36) | |
Th2MinAddress2 | char(36) | |
Th2MinAddress3 | char(36) | |
Th2MinAddress4 | char(36) | |
Th2MinPin | char(10) | |
Th2MinPhone | char(24) | |
Th2MinFax | char(24) | |
Th2MinMobile | numeric(13, 0) | |
Th2MinEmail | char(50) | |
Th2MinPAN | char(10) | |
Th2MinAadhaar | char(12) | |
Th2MinSharePer | numeric(3, 0) | |
Third Holder 3rd Minor Address | ||
Th3MinAddress1 | char(36) | |
Th3MinAddress2 | char(36) | |
Th3MinAddress3 | char(36) | |
Th3MinAddress4 | char(36) | |
Th3MinPin | char(10) | |
Th3MinPhone | char(24) | |
Th3MinFax | char(24) | |
Th3MinMobile | numeric(13, 0) | |
Th3MinEmail | char(50) | |
Th3MinPAN | char(10) | |
Th3MinAadhaar | char(12) | |
Th3MinSharePer | numeric(3, 0) | |
Authorised Signatories | ||
First Holder | ||
FhAuthName | char(135) | |
FhAuthRefNo | char(10) | |
FhAuthPidProofCd | char(2) | 1st Holder Authorised Signatory Proof of Identity |
FhAuthAdrProofCd | char(2) | 1st Holder Authorised Signatory Proof of Address |
Second Holder | ||
ShAuthName | char(135) | |
ShAuthRefNo | char(10) | |
ShAuthPidProofCd | char(2) | 2nd Holder Authorised Signatory Proof of Identity |
ShAuthAdrProofCd | char(2) | 2nd Holder Authorised Signatory Proof of Address |
Third Holder | ||
ThAuthName | char(135) | |
ThAuthRefNo | char(10) | |
ThAuthPidProofCd | char(2) | 3rd Holder Authorised Signatory Proof of Identity |
ThAuthAdrProofCd | char(2) | 3rd Holder Authorised Signatory Proof of Address |
Ben POA | ||
First Holder | ||
FhPoaType | char(1) | |
FhPoaId | char(8) | |
FhPoaActiveDate | datetime | |
Second Holder | ||
ShPoaType | char(1) | |
ShPoaId | char(8) | |
ShPoaActiveDate | datetime | |
Third Holder | ||
ThPoaType | char(1) | |
ThPoaId | char(8) | |
ThPoaActiveDate | datetime | |
Add Signature | ||
SigImg | text Base64String | Sent Signature image as Base64String |
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"CompanyId": "04",
"BranchId": "HO",
"FhName": "Dummy FH Name",
"ShortName": "Dummy Short Name",
"FhDOB": "1984-05-27",
"Gender": "M",
"FhFather": "Dummy Father Name",
"BenType": "01",
"BenSubType": "01",
"BenCategory": "02",
"BenOccupation": "02",
"FhEmail": "dummy@gmail.com",
"FhLandPhone": "033-24008804",
"FhMobile": "9804616461",
"FhSmsYesNo": "Y",
"FhPAN": "AMUPH7894E",
"FhAadhaar": "ASSD56666",
"FhMapin": "700020",
"FhRtaYesNo": "N",
"FhFmlyEmailYesNo": "N",
"FhFmlyMobileYesNo": "N",
"StaningIndicator": "Y",
"CustClntYesNo": "N",
"CustIncomeCd": "",
"SharePerYesNo": "N",
"FhBankAcNo": "12345566",
"BankAcType": "10",
"MicrNo": "110002031",
"IFSC": "SBIN0006064",
"EStatementYesNo": "Y",
"StateCode": "WB",
"BenLclAdrYesNo": "Y",
"RgessYesNo": "N",
"BsdaYesNo": "N",
"CommodityYesNo": "N",
"AutoPledgeYesNo": "N",
"MinorIndYesNo": "N",
"NomineeIndicator": "N",
"NomineeName": "K M",
"NomineeDOB": "1983-01-01",
"FhLclAddress1": "226/1",
"FhLclAddress2": "MINTO PARK",
"FhLclAddress3": "J C BOSE RD",
"FhLclAddress4": "KOLKATA",
"FhLclPin": "700020",
"FhLclPhone": "033-24008804",
"FhLclMobile": "9804616461",
"FhLclEmail": "dummy@gmail.com",
"FhLclPAN": "AFDRM2769E",
"FhLclAadhaar": "ASGTM4578E",
"FhBnkAddress1": "228",
"FhBnkAddress2": "AJC",
"FhBnkAddress3": "BOSE ROAD",
"FhBnkAddress4": "KOLKATA",
"FhBnkPin": "700056",
"FhBnkPhone": "033-24008804",
"FhBnkEmail": "bank@gmail.com",
"Fh1NomAddress1": "228/1",
"Fh1NomAddress2": "AJC",
"Fh1NomAddress3": "BOSE RD",
"Fh1NomAddress4": "KOLKATA",
"Fh1NomPin": "700080",
"Fh1NomPhone": "033-24007785",
"Fh1NomMobile": "9804644684",
"Fh1NomEmail": "nominee@gmail.com",
"Fh1NomSharePer": "100",
"AdrProofCd": "10",
"PidProofCd": "07",
"FhLclStateCd": "19",
"FhLclCntryCd": "356"
}
Return Data | Sample |
---|---|
JSon Data:
|
|
InsertClientImage
Endpoint : InsertClientImage
Method : POST or GET | Send raw Json data in Body
Insert a new Client's Image / File (like photo, signature) into SharePro
Request Data
|
Request Sample (JSon Data)
|
Return JSon Response: | Sample |
---|---|
Return Data:
|
|
updateClientNomineeCDSL
Endpoint : updateClientNomineeCDSL
Method : POST or GET | Send raw Json data in Body
Client’s Update Client Nominee linked to the CDSL BO pending account
Data | UAT Sample |
---|---|
JSon Request: | |
|
|
JSon Response: | |
|
|
updateEmailCDSL
Endpoint : updateEmailCDSL
Method : POST or GET | Send raw Json data in Body
Client’s Update Email id linked to the CDSL BO pending account
Data | UAT Sample |
---|---|
JSon Request: | |
|
|
JSon Response: | |
|
|
Email already exists Error | |
|
|
updateMobileCDSL
Endpoint : updateMobileCDSL
Method : POST or GET | Send raw Json data in Body
Client’s Update Email id linked to the CDSL BO pending account
Data | UAT Sample |
---|---|
JSon Request: | |
|
|
JSon Response: | |
|
|
Mobile already exists Error | |
|
|