Skip to main content

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:
{
"key": "<<RestAPI Key>>",
"pan": "<<Pan Number>>"
}
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"pan": "PAN7121"
}
JSon Response:
{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "PAN exists"
}

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:
{
"key": "<<RestAPI Key>>",
"ucc": "<<UCC>>"
}
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"ucc": "151A355"
}

Return Data:

{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "UCC exists"
}


NewClientRegistration

Endpoint : NewClientRegistration

Method : POST or GET | Send raw Json data in Body

Creates a new Client in Sharepro

  • Request Data
API ParameterData TypeExplanation
*keyvarchar(100)REST API Key
cUccchar(10)UCC need to be unique for each client
*cClientNamevarchar(75)Client Name is compulsory
cFatherNmvarchar(38)
cMotherNmchar(40)
dBirth_Datedatetime
*cGenderchar(1)M : Male
F : Female
N : None
*cMaritalStatusvarchar(2)01 : Married
02 : Single
03 : Widow / Widower
dMarriageAnivdatetimeMarriage anniversary date
cNationalitychar(2)01 : Indian
02 : Others
cResIndStatusvarchar(1)Residential Status
R : Resident Individual
N : Non Resident
P : Foreign National
cOccupationchar(25)Business
Employed
Professional
Student
Self Employed
House Wife
Others
cAnnualIncomechar(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
ClRiskProfilechar(30)RiskProfile
Low Risk
High Risk
Medium Risk
cBranchIDchar(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_Nochar(30)PAN Number is compulsory
PAN Number need to be unique for each client
cPassportvarchar(25)
dPPDatedatetime
dPPExpDatedatetime
cVoterIdvarchar(25)
cRationIdvarchar(25)
cDriveLicensevarchar(25)
dDLDatedatetime
dDLExpDatedatetime
cAadhaarchar(12)
cPhotoIdPrfchar(30)PAN Card
Voter ID
Passport
Driving License
ADHAAR
cAddPrfchar(30)Voter ID
Passport
Driving License
Ration Card
Telephone Bill
Electricity Bill
Credit-Card Bill
Bank Pass Book
ADHAAR
Address
cAdd1varchar(50)
cAdd2varchar(50)
cAdd3varchar(50)
cCityvarchar(25)
cPinchar(10)
*cStateCdchar(4)Please refer to getStateCodeList call to get a list of States with the broker. Send STATECD
cCountryvarchar(35)Like : 'India'
cPhonevarchar(40)
cFaxchar(20)
Residential Address
cResAdd1varchar(30)
cResAdd2varchar(30)
cResAdd3varchar(30)
cResCityvarchar(25)
cResPinchar(7)
cResStateCdchar(4)Please refer to getStateCodeList call to get a list of States with the broker. Send STATECD
cResCountrychar(20)Like : 'India'
cResPhonechar(20)
cResFaxchar(20)
Communication
cEmailchar(80)
cMobilechar(40)
FmlyEmailFlagbitFamily Email Flag
0 : No
1 : Yes
EmailStatchar(40)(Self,Spouse,Dependent Children,Dependent Parent,Authorized,Contact Person)
FmlyMobileFlagbitFamily Mobile Flag
0 : No
1 : Yes
MobileStatchar(40)(Self,Spouse,Dependent Children,Dependent Parent,Authorized,Contact Person)
KRA
cKraApplDtdatetimeKRA Application date (yyyy-MM-dd)
cKraOccupationvarchar(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)
cKraOccupationDtlOthvarchar(50)Others occupation details
cKraAnnualIncvarchar(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
cKraAnnualIncDtdatetime
cKraPEPvarchar(4)NA : Not a PEP
PEP : PEP
RPE : Related to a PEP
cKraCorrAddPrfvarchar(2)KRA correspondence address Proof Please refer to getKRAAddressProofList call to get a list of KRA address Proof
cKraCorrAddPrfIdvarchar(100)Correspondence address reference id
cKraCorrAddPrfDtdatetime
cKraPermAddPrfvarchar(2)KRA permanent address proof Please refer to getKRAAddressProofList call to get a list of KRA address Proof
cKraPermAddPrfIdvarchar(100)Permanent address reference id
cKraPermAddPrfDtdatetime
cKraPermCorrSamevarchar(1)Permanent address same as Corr. address?
Y : Yes
N : No
cKraCorrAddStatevarchar(20)State of KRA Correspondence address Please refer to getKRAStateCodeList call to get a list of KRA States
cKraPermAddStatevarchar(20)State of KRA Permanent address Please refer to getKRAStateCodeList call to get a list of KRA States
cKraCorrAddCntryvarchar(30)Country of KRA Correspondence address Please refer to getKRACountryCodeList call to get a list of KRA Country
cKraPermAddCntryvarchar(30)Country of KRA Permanent address Please refer to getKRACountryCodeList call to get a list of KRA Country
cKraIdProofcKraIdProofKRA Proof of Identity Submitted (Others) Please refer to getKRAPhotoIdProofList call to get a list of KRA Photo Id Proof
cKraStateCitychar(5)KRA State City Please refer to getKRAStateCityList call to get a list of KRA State City
cKraIpvDtdatetimeIPV Date (yyyy-MM-dd)
cKraIpvDesigvarchar(50)IPV Designation
cKraIpvNamevarchar(50)IPV Name
cKraIpvOrgvarchar(50)IPV Organisation
cKraIdProofOthvarchar(50)Proof of Identity Others
KRACompStatusvarchar(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
cIntroClIdchar(10)
cIntroNamevarchar(30)
cIntroCtgrychar(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
cIntroCatDscrvarchar(25)
cIntroAdd1varchar(30)
cIntroAdd2varchar(30)
cIntroAdd3varchar(30)
cIntroCityvarchar(15)
cIntroPinvarchar(7)
cIntroCntryvarchar(35)
cIntroPhonevarchar(30)
cIntroFathervarchar(35)
cIntroRelvarchar(25)
cIntroIdPrfchar(30)PAN Card
Voter ID
Passport
Driving License
cIntroIdchar(30)
cIntroIdExpdatetime
Contact Person 1
*cContactPersonvarchar(30)Contact Person Name is compulsory
*cCpDesignationvarchar(25)Contact Person Designation is compulsory
*cCpAddressvarchar(100)Contact Person Address is compulsory
*cCpPhonevarchar(20)Contact Person Phone No. is compulsory
cCpCityvarchar(50)
*cCpPinvarchar(10)Contact Person PIN is compulsory
*cCpStatevarchar(2)Contact Person State is compulsory Please refer to getKRAStateCodeList call to get a list. Send CODE
*cCpCountryvarchar(3)Contact Person Country is compulsory Please refer to getKRACountryCodeList call to get a list. Send CODE
Primary Bank Details
*cIfscvarchar(40)IFSC of Primary Bank Account is compulsory
cMicrvarchar(40)
cAcTypevarchar(10)Savings
Current
PIS A/c
Others
*cAcNovarchar(20)
*cBankClientNamevarchar(40)
Secondary Bank Details
cSecIfscvarchar(40)
cSecMicrvarchar(40)
cSecAcTypevarchar(10)Savings
Current
PIS A/c
Others
cSecAcNovarchar(20)
cSecBankClientNamevarchar(40)
PayModechar(1)Preferred mode of Payment
"1" : Any
"2" : RTGS
"3" : NEFT
"4" : Cheque
cAutoFundPobit0 : No
1 : Yes
cClientTypechar(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
cDealModchar(15)T : Trading Member
N : Custodian
B : Both
cRegFrmRecvdbit0 : No
1 : Yes
cIpvFlagbit0 : No,
1 : Yes
Segments to register in
cREG_NSEbitNSE-CM - 0 : No, 1 : Yes
cREG_NFObitNSE-FO
cREG_BSEbitBSE-CM
cREG_BFObitBSE-FO
cREG_CSEbitCSE
cREG_DSEbit
cREG_NCDEXbitNCDEX
cREG_MCXbitMCX
cREG_MFbit
cREG_NBFCbit
cREG_DGCXbit
cREG_NMCEILbit
cREG_CNFObitNSE-CDS
cREG_CMFObitMSEI-CDS
cREG_CBFObitBSE-CDS
cREG_PMSbit
cREG_ICFObitICEX
cREG_NMFSbitNSEE-MF
cREG_NSFObit
cREG_KCFObit
cREG_KCFObit
cREG_USFObit
cREG_CSENSEbit
cREG_CSENFObit
cREG_MXEQbit
cREG_MXFObit
cREG_UCXbit
cREG_NSEDSbit
cREG_BMFSbit
cREG_NSLBbitNSE-SLBM
cREG_NSPTbit
IBTActivedatetimeyyyy-MM-dd
FATCAReceivedDatedatetimeyyyy-MM-dd
cHoldDlvrybitAlways 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
cDpIdchar(10)
cBenAcNumchar(8)
Nominee Opt Out
NomOptOutDtdatetimeyyyy-MM-dd
Nominee Old (Obsolete in SharePro no need to pass now)
cNomineeNmchar(40)Nominee Name
cNomineeRelchar(40)Nominee Relation
NomineeAdd1char(40)
NomineeAdd2char(40)
NomineeAdharchar(12)
NomineeCitychar(20)
NomineeEmailchar(40)
NomineePanchar(10)
NomineePhonechar(20)
NomineePinchar(20)
Nominee 1
Nominee1_EffectDatedatetimeyyyy-MM-dd (Default it is Current Date)
Nominee1_Prefixvarchar(5)MR, MRS, etc
Nominee1_Descrvarchar(50)Nominee Name * mandatory for nominee1
Nominee1_Percentnumeric(5,2)Nominee percentage ( Like : “50.00”)
Nominee1_Relationvarchar(50)Nominee Relation (Like :”Son”)
Nominee1_Add1varchar(50)* mandatory for nominee1
Nominee1_Add2varchar(50)
Nominee1_Add3varchar(50)
Nominee1_Cityvarchar(50)
Nominee1_Pincodevarchar(50)
Nominee1_Statevarchar(50)(Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee1
Nominee1_Countryvarchar(50)(Like : "IN" OR “India”) * mandatory for nominee1
Nominee1_Mobilevarchar(20)
Nominee1_Phonevarchar(20)
Nominee1_Emailvarchar(50)
Nominee1_IdTypevarchar(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_IdNumbervarchar(30)ID PROOF Number ( Like : for AADHAR its UID)
Nominee1_IsMinorbit"1": yes, "0": No ( default 0)
Nominee1_MinorDOBdatetimeyyyy-MM-dd
Nominee1_GdDescrvarchar(50)Nominee’s Guardian Name
Nominee1_GdRelationvarchar(50)Guardian Relation with Nominee ( like : “Mother”)
Nominee1_GdAdd1varchar(50)
Nominee1_GdAdd2varchar(50)
Nominee1_GdAdd3varchar(50)
Nominee1_GdCityvarchar(50)
Nominee1_GdPincodevarchar(50)
Nominee1_GdStatevarchar(50)
Nominee1_GdCountryvarchar(50)
Nominee1_GdMobilevarchar(20)
Nominee1_GdPhonevarchar(20)
Nominee1_GdEmailvarchar(50)
Nominee1_GdIdTypevarchar(50)ID PROOF ( same as IdType)
Nominee1_GdIdNumbervarchar(30)ID PROOF Number (Like : for AADHAR its UID)
Nominee 2
Nominee2_EffectDatedatetimeyyyy-MM-dd (Default it is Current Date)
Nominee2_Prefixvarchar(5)MR, MRS, etc
Nominee2_Descrvarchar(50)Nominee Name * mandatory for nominee2
Nominee2_Percentnumeric(5,2)Nominee percentage ( Like : “50.00”)
Nominee2_Relationvarchar(50)Nominee Relation (Like :”Son”)
Nominee2_Add1varchar(50)* mandatory for nominee2
Nominee2_Add2varchar(50)
Nominee2_Add3varchar(50)
Nominee2_Cityvarchar(50)
Nominee2_Pincodevarchar(50)
Nominee2_Statevarchar(50)(Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee2
Nominee2_Countryvarchar(50)(Like : "IN" OR “India”) * mandatory for nominee2
Nominee2_Mobilevarchar(20)
Nominee2_Phonevarchar(20)
Nominee2_Emailvarchar(50)
Nominee2_IdTypevarchar(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_IdNumbervarchar(30)ID PROOF Number ( Like : for AADHAR its UID)
Nominee2_IsMinorbit"1": yes, "0": No ( default 0)
Nominee2_MinorDOBdatetimeyyyy-MM-dd
Nominee2_GdPrefixvarchar(5)MR, MRS, etc
Nominee2_GdDescrvarchar(50)Nominee’s Guardian Name
Nominee2_GdRelationvarchar(50)Guardian Relation with Nominee ( like : “Mother”)
Nominee2_GdAdd1varchar(50)
Nominee2_GdAdd2varchar(50)
Nominee2_GdAdd3varchar(50)
Nominee2_GdCityvarchar(50)
Nominee2_GdPincodevarchar(50)
Nominee2_GdStatevarchar(50)
Nominee2_GdCountryvarchar(50)
Nominee2_GdMobilevarchar(20)
Nominee2_GdPhonevarchar(20)
Nominee2_GdEmailvarchar(50)
Nominee2_GdIdTypevarchar(50)ID PROOF ( same as IdType)
Nominee2_GdIdNumbervarchar(30)ID PROOF Number (Like : for AADHAR its UID)
Nominee 3
Nominee3_EffectDatedatetimeyyyy-MM-dd (Default it is Current Date)
Nominee3_Prefixvarchar(5)MR, MRS, etc
Nominee3_Descrvarchar(50)Nominee Name * mandatory for nominee3
Nominee3_Percentnumeric(5,2)Nominee percentage ( Like : “50.00”)
Nominee3_Relationvarchar(50)Nominee Relation (Like :”Son”)
Nominee3_Add1varchar(50)* mandatory for nominee3
Nominee3_Add2varchar(50)
Nominee3_Add3varchar(50)
Nominee3_Cityvarchar(50)
Nominee3_Pincodevarchar(50)
Nominee3_Statevarchar(50)(Like: West Bengal : WB) Please refer to getStateCodeList call to get a list of States with the broker. * mandatory for nominee3
Nominee3_Countryvarchar(50)(Like : "IN" OR “India”) * mandatory for nominee3
Nominee3_Mobilevarchar(20)
Nominee3_Phonevarchar(20)
Nominee3_Emailvarchar(50)
Nominee3_IdTypevarchar(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_IdNumbervarchar(30)ID PROOF Number ( Like : for AADHAR its UID)
Nominee3_IsMinorbit"1": yes, "0": No ( default 0)
Nominee3_MinorDOBdatetimeyyyy-MM-dd
Nominee3_GdPrefixvarchar(5)MR, MRS, etc
Nominee3_GdDescrNominee3_GdDescrNominee’s Guardian Name
Nominee’s Guardian Namevarchar(50)Guardian Relation with Nominee ( like : “Mother”)
Nominee3_GdAdd1varchar(50)
Nominee3_GdAdd2varchar(50)
Nominee3_GdAdd3varchar(50)
Nominee3_GdCityvarchar(50)
Nominee3_GdPincodevarchar(50)
Nominee3_GdStatevarchar(50)
Nominee3_GdCountryvarchar(50)
Nominee3_GdMobilevarchar(20)
Nominee3_GdPhonevarchar(20)
Nominee3_GdEmailvarchar(50)
Nominee3_GdIdTypevarchar(50)ID PROOF ( same as IdType)
Nominee3_GdIdNumbervarchar(30)ID PROOF Number (Like : for AADHAR its UID)
Guardian
cGuardianNmchar(35)Guardian Name
cGuardianPanchar(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
cBrkgBasketNSEchar(10)Brokerage NSE Basket Code
cBrkgBasketBSEchar(10)Brokerage BSE Basket Code
cBrkgBasketFOchar(10)Brokerage FO Basket Code
cBrkgBasketCDSchar(10)Brokerage CDS Basket Code
cBrkgBasketCOMMchar(10)Brokerage COMM Basket Code
cBrkgBasketBSEFOchar(10)Brokerage BSE FO Basket Code
cBrkgBasketBSECDSchar(10)Brokerage BSE CDS Basket Code
dBrkgEffectDatedatetimeBrokerage Effect Date
nDelCMBrkgnumeric(9,6)NSE-CM Delivery Brokerage %
nDelCMBrkgMinnumeric(8,4)NSE-CM Delivery Brokerage Min
nSqCMBrkgnumeric(9,6)NSE-CM Square Off Brokerage %
nSqCMBrkgMinnumeric(8,4)NSE-CM Square Off Min
nFutBrkgnumeric(9,6)Future Brokerage %
nFutBrkgMinnumeric(8,4)Future Brokerage Min
nOptBrkgnumeric(7,4)Option Brokerage %
Running Accounts
cRunAcSegmentvarchar(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
dRunAcRcvdDtdatetimeReceived on (yyyy-MM-dd)
dRunAcRcvdDtdatetimeReceived on (yyyy-MM-dd)
dRunAcRvkdDtdatetimeRevoked on (yyyy-MM-dd)
nSettleTypenumeric(1,0)0 : Not Set
1 : Monthly
2 : Quarterly,
3 : Half Yearly
Retainablenumeric(6,0)Securities Retainable (Like 10000)
Commodity
dRunAcRcvdDtComdatetimeReceived on (yyyy-MM-dd)
dRunAcRvkdDtComdatetimeRevoked on (yyyy-MM-dd)
nSettleTypeComnumeric(1,0)0 : Not Set
1 : Monthly
2 : Quarterly
3 : Half Yearly
RetainableComnumeric(6,0)Commodity Retainable (Like 10000)
**Operations **
cGroupCdchar(4)
dAPEffectDatedatetime
cAPCdchar(10)
dRMEffectDatedatetime
cRMCdchar(10)
dDealerEffectDatedatetime
cDealerCdchar(10)
dSREffectDatedatetime
cSRCdchar(10)
eContractbitClients take e-contract ?
0 : No
1 : Yes
NETWORTH-- PMLA
cACC_DateDESCRchar(9)Financial year (Like 2021-2022)
nGROSSINCOMEnumeric(16, 2)Gross Income
nNETWORTHnumeric(16, 2)Net Worth
dtNETWORTHDTdatetimeNet Worth date (yyyy-MM-dd)
BusiCommenceDtdatetimeBusiness commencement date (yyyy-MM-dd)
cClientWithOthTMchar(1)Client account with another TM ?
Y : Yes
N : No
NMFS_occupationchar(2)1 : Business
2 : Service
3 : Professional
4 : Agriculture
5 : Retired
6 : Housewife
7 : Student
8 : Others
NMFS_statechar(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
InterestEffectDatedatetimeNormal Interest EffectDate (yyyy-MM-dd)
FlatInterestnumeric(6,2)Normal Flat Interest (Interest %) like : 18.00
InterestSlabCdchar(2)Normal Interest SlabCd
DntCalcInterestbitNormal Do not calculate Interest of Client?
0 : No
1 : Yes
InterestRegPendingbitNormal Interest Reg Pending
InterestRoundOffintNormal 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
InterestGracePeriodchar(8)Normal Grace Days - Grace Period
Default
0
1
2
3
4
5
6
7
InterestSpecShareCrbitNormal SpecShareCr
0 : No
1 : Yes
InterestShareCrPernumeric(6,2)Normal ShareCrPer
InterestExclSpanMarkupbitNormal Exclude Span Margin
InterestExclM2MValuebitNormal Exclude Exposure Margin [M2M]
MTF Interest Segment Type
MTFInterestEffectDatedatetimeMTF Interest EffectDate (yyyy-MM-dd)
MTFFlatInterestnumeric(6,2)MTF Flat Interest (Interest %) like : 18.00
MTFInterestSlabCdchar(2)MTF Interest SlabCd
MTFDntCalcInterestbitMTF Do not calculate Interest of Client ?
0 : No
1 : Yes
MTFInterestRegPendingbitMTF Interest Reg Pending
MTFInterestRoundOffintMTF 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
MTFInterestGracePeriodchar(8)MTF Grace Days - Grace Period
Default
0
1
2
3
4
5
6
7
MTFInterestSpecShareCrbitMTF SpecShareCr
MTFInterestShareCrPernumeric(6,2)MTF ShareCrPer
MTFInterestExclSpanMarkupbitMTF Exclude Span Margin
MTFInterestExclM2MValuebitMTF Exclude Exposure Margin [M2M]
NBFC Interest Segment Type
NBFCInterestEffectDatedatetimeNBFC Interest EffectDate (yyyy-MM-dd)
NBFCFlatInterestnumeric(6,2)NBFC Flat Interest (Interest %) like : 18.00
NBFCInterestSlabCdchar(2)NBFC Interest SlabCd
NBFCDntCalcInterestbitNBFC Do not calculate Interest of Client
0 : No
1 : Yes
NBFCInterestRegPendingbitNBFC Interest Reg Pending
NBFCInterestRoundOffint**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
NBFCInterestGracePeriodchar(8)NBFC Grace Days - Grace Period
Default
0
1
2
3
4
5
6
7
NBFCInterestSpecShareCrbitNBFC SpecShareCr
NBFCInterestShareCrPernumeric(6,2)NBFC ShareCrPer
NBFCInterestExclSpanMarkupbitNBFC Exclude Span Margin
NBFCInterestExclM2MValuebitNBFC Exclude Exposure Margin [M2M]
ADD USER
ADD USERvarchar(15)Record inserted by (like a 3rd party vendor name : KYCDone)
"AddUser": "KYCDone"

Request Sample (JSon Data)


{
"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
{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "Record imported Successfully in SharePro"
}

rest NewCDSLClientRegistration

Method : POST or GET| Send raw Json data in Body

  • Creates a new CDSL Client in the Depository Segment
Request Data
API ParameterData TypeExplanation
*keyvarchar(100)REST API Key
CompanyIdchar(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.
BranchIDchar(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
FhTitlevarchar(10)First Holder Title (Like MR, MRS)
* FhFirstNamevarchar(100)First Holder First Name is compulsory
FhMiddleNamevarchar(20)First Holder Middle Name
*FhLastNamevarchar(20)First Holder Last Name is compulsory
FhSuffixvarchar(10)First Holder Suffix (Like DR)
FhFathervarchar(50)First Holder Father Name
FhMothervarchar(100)First Holder Mother Name
UCCchar(10)First Holder trading UCC
FhDOBdatetimeFirst Holder Date of Birth
FhGenderchar(1)First Holder Gender
"M" - Male
"F" - Female
"X" - None
*FhAddr1varchar(55)First Holder Address is compulsory
FhAddr2varchar(55)First Holder Address 2
FhAddr3varchar(55)First Holder Address 3
FhCityvarchar(25)First Holder City is compulsory. If you not pass then we will search it using Pincode
*FhStateCodechar(4)GST State Code is compulsory Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
FhStatevarchar(25)First Holder NRI State Name
*FhCountryvarchar(25)First Holder Country is compulsory (Like India)
*FhPinvarchar(10)First Holder Pincode is compulsory
CitySeqNochar(2)City Sequence Number -- 01, 02 (Obsolete in SharePro no need to pass now)
FhNationCodechar(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
FhPhoneInd1char(1)Phone Indicator
(Obsolete in SharePro no need to pass now)
"N" - None
"M" - Mobile
"O" - Office
"P" - Pager
"R" - Residence
FhPhone1varchar(17)First Holder Primary Mobile No.
FhPhoneInd2char(1)Phone Indicator
(Obsolete in SharePro no need to pass now)
"N" - None
"M" - Mobile
"O" - Office
"P" - Pager
"R" - Residence
FhPhone2varchar(17)First Holder Secondary Mobile No
FhAdtnlPhonevarchar(100)First Holder Additional Secondary Phone No
(Obsolete in SharePro no need to pass now)
FhFaxvarchar(17)First Holder Fax
FhEmailvarchar(50)First Holder Primary Email
*FhPanvarchar(25)First Holder Income Tax PAN No. is compulsory
FhPanExemptvarchar(1)First Holder Pan Exempt
(Obsolete in SharePro no need to pass now)
FhPanVerifynumeric(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
FhITCirclevarchar(15)IT Circle / Ward / District
FhDepAllowYesNochar(1)First Holder Dependent Allow
“N” - No
“Y” - Yes
FhDepDeclYesNochar(1)First Holder Dependent Declaration
“N” - No
“Y” - Yes
FhDepRelationchar(2)First Holder Dependent Relation
"" - None
"SA" - Same a/c Holder
"DF" - Dependent Father
"DF" - Dependent Father
"SP" - Spouse
"SO" - Son
"UD" - Unmarried Daughter
*FhPerAddr1varchar(55)1st Holder Permanent Address is compulsory
FhPerAddr2varchar(55)1st Holder Permanent Address 2
FhPerAddr3varchar(55)1st Holder Permanent Address 3
*FhPerCityvarchar(25)1st Holder Permanent City is compulsory. If you not pass then we will search it using Pincode
*FhPerStateCodechar(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
FhPerStatevarchar(25)1st Holder NRI Permanent State Name
*FhPerCountryvarchar(25)1st Holder Permanent Country is compulsory (Like : India )
*FhPerPinvarchar(10)1st Holder Permanent PIN Code is compulsory
FhPerPhoneInd1char(1)1st Holder Permanent Phone Indicator
(Obsolete in SharePro no need to pass now)
FhPerPhone1varchar(17)1st Holder Permanent Primary Phone
(Obsolete in SharePro no need to pass now)
FhPerPhoneInd2char(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
FhPerPhone2varchar(17)1st Holder Permanent Secondary Phone
(Obsolete in SharePro no need to pass now)
FhPerEmailvarchar(50)1st Holder Permanent Email
(Obsolete in SharePro no need to pass now)
FhAadhaarchar(15)1st Holder Aadhaar
FhUidFlagchar(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
FhInstraIdchar(8)Instra Id Length should be 8 digits
AcopenSourcechar(1)Account Opening Flag:
“1” : Online Account opening by the BO
“2” : Account Opening based on submission of Physical documents
FhProductNovarchar(2)1st Holder Product Description - Product No. Value must be between "01" and "57" Please refer to *view CDSL Product Description Codes
FhSubStatusvarchar(4)1st Holder Product Sub Status Code Please refer to view CDSL Product Sub Status Codes
FhCategoryvarchar(2)BO Product Category value must be between "01" and "15" Please refer to view CDSL Category Codes
FhDPIntRefNovarchar(10)1st Holder DP Internal Ref No
*FhOccupationchar(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
FhConfWaivedYesNochar(1)Confirmation Waived
“Y” - Yes
“N” - No
FhStmntCyclechar(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
FhECSYesNochar(1)ECS/Mandate
“Y” - Yes
“N” - No
FhSettPlanYesNochar(1)Settlement Planning flag
“Y” - Yes
“N” - No
FhIncomeCodevarchar(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 Crorevarchar(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
FhEducationchar(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
FhGeoCodechar(4)Geographical Code
"M" - Metropolitan
"O" - Others
"R" - Rural
"SU" - Semi-Urban
"U" - Urban,
"N" - None
FhStaff_Relativechar(1)Staff/Relative
"N" - Neither staff nor Relative
"S" - Staff of the DP
"R" - Relative of staff of DP
"X" - None
FhStaffCodevarchar(10)Staff Code ( in Product Details)
FhLanguageCodevarchar(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
FhGroupCodevarchar(8)Group Code ( in Product Details)
FhClrngCorpIdchar(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
FhStkExchngIdchar(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
FhClrngMemberIdchar(8)Clearing Member Id
* If have Clearing Member Account then it is mandatory
FhSebiRegNochar(24)SEBI Registration Id
* If have Clearing Member Account then it is mandatory
FhTradingIdchar(8)Trading Id
* If have Clearing Member Account then it is mandatory
FhPoaRegNovarchar(16)POA Reg No
bIf have POA id then it is mandatory*
FhPoaIdvarchar(16)* If have POA id then it is mandatory
FhPoaTypechar(1)"R" - Regular POA
"C" - Clearing Member POA
FhPoaPurposeCodevarchar(20)"4" - All Holder
"1" - First Holder
"2" Second Holder
"3" - Third Holder
FhPoaSetupDatedatetime* If have POA id then it is mandatory
FhPoaOptrYesNochar(1)POA Operator
“Y” - Yes
“N” - No
FhGPA_BPAchar(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"
FhPoaFromDatedatetime* If have POA id then it is mandatory
FhPoaToDatedatetime
FhPoaRemarksvarchar(50)
FhAnnualReportchar(1)Annual Report Flag
"1" - Physical Annual Report
"2" - Electronic Annual Report
"3" - Both Physical and Electronic Annual Report
FhBsdachar(1)BSDA Flag
"N" - No
"Y" - Yes
"O" - Opted Out
FhEmailRtaYesNochar(1)Download Email RTA Flag
“Y” - Yes
“N” - No
FhPledgeIndYesNochar(1)Pledge Standing Indicator
“Y” - Yes
“N” - No
FhRgessYesNochar(1)RGESS Flag
“Y” - Yes
“N” - No
FhEmailStmntYesNochar(1)Email Statement flag
“Y” - Yes
“N” - No
FhDisabilityYesNochar(1)Mental Disability flag
“Y” - Yes
“N” - No
FhFmlyAccYesNochar(1)Family Account flag
“Y” - Yes
“N” - No
FhCasModechar(2)CAS Mode
"" - None
"PH" - Physical CAS
"NO" - CAS not required
FhCasDepositorychar(1)Preferred Depository for CAS
"" - None
"C" - CDSL
"N" - NSDL
RMCodechar(10)
GSTINchar(15)
GSTRegDatedatetime
ChargeCdchar(8)Charge Basket CD
Authorised Signatory
Imgtext - Base64String
Bank
BankTypechar(2)Like : "22" - Dividend Bank
(Obsolete in SharePro no need to pass now)
BankAcNovarchar(20)
MicrNochar(12)
IFSCchar(15)
BankAcTypevarchar(15)"10" - Savings
"11" - Current
"13" - Cash Credit
BankCurrencyvarchar(15)"999001" - Indian Rupees
"999002" - US Dollar
"999003" - UK Pound
Second Holder
ShTitlevarchar(10)Like MR, MRS
ShFirstNamevarchar(100)
ShMiddleNamevarchar(20)
ShLastNamevarchar(20)
ShSuffixvarchar(10)
ShFathervarchar(50)
ShMothervarchar(100)
ShPanvarchar(25)
ShITCirclevarchar(15)IT Circle / Ward / District
ShAadhaarchar(15)
ShEmailvarchar(50)
ShMobilechar(10)
Third Holder
ThTitlevarchar(10)Like MR, MRS
ThFirstNamevarchar(100)
ThMiddleNamevarchar(20)
ThLastNamevarchar(20)
ThSuffixvarchar(10)
ThFathervarchar(50)
ThMothervarchar(100)
ThPanvarchar(25)
ThITCirclevarchar(15)IT Circle / Ward / District
ThAadhaarchar(15)
ThEmailvarchar(50)
ThMobilechar(10)
First Nominee
Nom1Titlevarchar(10)Like MR, MRS
Nom1FirstNamevarchar(100)
Nom1MiddleNamevarchar(20)
Nom1LastNamevarchar(20)
Nom1Suffixvarchar(10)Like DR
Nom1Fathervarchar(50)
Nom1Addr1varchar(30)
Nom1Addr2varchar(30)
Nom1Addr3varchar(30)
Nom1Cityvarchar(25)
Nom1Statevarchar(25)State Name
Nom1StateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Like : For West Bengal : WB
Nom1Countryvarchar(25)Like: India
Nom1Pinvarchar(10)Pincode
Nom1PhoneInd1char(1)(Obsolete in SharePro no need to pass now)
Nom1Phone1varchar(17)Primary Mobile
Nom1PhoneInd2char(1)(Obsolete in SharePro no need to pass now)
Nom1Phone2varchar(17)(Obsolete in SharePro no need to pass now)
Nom1AdtnlPhonevarchar(100)(Obsolete in SharePro no need to pass now)
Nom1Faxvarchar(17)
Nom1Emailvarchar(50)Primary Email
Nom1Panvarchar(25)Income Tax PAN No
Nom1ITCirclevarchar(15)IT Circle / Ward / District
Nom1MinorYesNochar(1)Minor Flag
“Y” - Yes
“N” - No
Nom1MinorDOBdatetimeMinor Date of Birth (yyyy-mm-dd
Nom1Relationchar(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
Nom1SharePernumeric(6, 2)Nominee Share %
Nom1ResSecYesNochar(1)Residual Security flag
“Y” - Yes
“N” - No
Second Nominee
Nom2Titlevarchar(20)Like MR, MRS
Nom2FirstNamevarchar(200)
Nom2MiddleNamevarchar(20)
Nom2LastNamevarchar(20)
Nom2Suffixvarchar(20)Like DR
Nom2Fathervarchar(50)
Nom2Addr1varchar(30)
Nom2Addr2varchar(30)
Nom2Addr3varchar(30)
Nom2Cityvarchar(25)
Nom2Statevarchar(25)State Name
Nom2StateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Nom2Countryvarchar(25)Like: India
Nom2Pinvarchar(20)Pincode
Nom2PhoneInd1char(2)(Obsolete in SharePro no need to pass now)
Nom2Phone1varchar(27)Primary Mobile
Nom2PhoneInd2char(2)(Obsolete in SharePro no need to pass now)
Nom2Phone2varchar(27)(Obsolete in SharePro no need to pass now)
Nom2AdtnlPhonevarchar(200)(Obsolete in SharePro no need to pass now)
Nom2Faxvarchar(27)
Nom2Emailvarchar(50)Primary Email
Nom2Panvarchar(25)Income Tax PAN No
Nom2ITCirclevarchar(25)IT Circle / Ward / District
Nom2MinorYesNochar(2)Minor Flag
“Y” - Yes
“N” - No
Nom2MinorDOBdatetimeMinor Date of Birth
Nom2Relationchar(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
Nom2SharePernumeric(6, 2)Nominee Share %
Nom2ResSecYesNochar(2)Residual Security flag
“Y” - Yes
“N” - No
Third Nominee
Nom3Titlevarchar(30)Like MR, MRS
Nom3FirstNamevarchar(300)
Nom3MiddleNamevarchar(20)
Nom3LastNamevarchar(20)
Nom3Suffixvarchar(30)Like DR
Nom3Fathervarchar(50)
Nom3Addr1varchar(30)
Nom3Addr2varchar(30)
Nom3Addr3varchar(30)
Nom3Cityvarchar(25)
Nom3Statevarchar(25)State Name
Nom3StateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Nom3Countryvarchar(25)Like: India
Nom3Pinvarchar(30)Pincode
Nom3PhoneInd1char(3)(Obsolete in SharePro no need to pass now)
Nom3Phone1varchar(37)Primary Mobile
Nom3PhoneInd2char(3)(Obsolete in SharePro no need to pass now)
Nom3Phone2varchar(37)(Obsolete in SharePro no need to pass now)
Nom3AdtnlPhonevarchar(300)(Obsolete in SharePro no need to pass now)
Nom3Faxvarchar(37)
Nom3Emailvarchar(50)Primary Email
Nom3Panvarchar(25)Income Tax PAN No
Nom3ITCirclevarchar(35)IT Circle / Ward / District
Nom3MinorYesNochar(3)Minor Flag
“Y” - Yes
“N” - No
Nom3MinorDOBdatetimeMinor Date of Birth
Nom3Relationchar(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
Nom3SharePernumeric(6, 2)Nominee Share %
Nom3ResSecYesNochar(3)Residual Security flag
“Y” - Yes
“N” - No
Minor Guardian
MinGrdTitlevarchar(30)Like MR, MRS
MinGrdFirstNamevarchar(300)
MinGrdMiddleNamevarchar(20)
MinGrdLastNamevarchar(20)
MinGrdSuffixvarchar(30)Like DR
MinGrdFathervarchar(50)
MinGrdAddr1varchar(30)
MinGrdAddr2varchar(30)
MinGrdAddr3varchar(30)
MinGrdCityvarchar(25)
MinGrdStatevarchar(25)State Name
MinGrdStateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Like : For West Bengal : WB
MinGrdCountryvarchar(25)Like: India
MinGrdPinvarchar(30)Pincode
MinGrdPhoneInd1char(3)(Obsolete in SharePro no need to pass now)
MinGrdPhone1varchar(37)Primary Mobile
MinGrdPhoneInd2char(3)(Obsolete in SharePro no need to pass now)
MinGrdPhone2varchar(37)(Obsolete in SharePro no need to pass now)
MinGrdAdtnlPhonevarchar(300)(Obsolete in SharePro no need to pass now)
MinGrdFaxvarchar(37)
MinGrdEmailvarchar(50)Primary Email
MinGrdPanIncome Tax PAN No
MinGrdITCirclevarchar(35)IT Circle / Ward / District
MinGrdMinorYesNochar(3)Minor Flag
“Y” - Yes
“N” - No
MinGrdMinorDOBdatetimeMinor Date of Birth
MinGrdRelationchar(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
MinNom1GrdTitlevarchar(30)Like MR, MRS
MinNom1GrdFirstNamevarchar(300)
MinNom1GrdMiddleNamevarchar(20)
MinNom1GrdLastNamevarchar(20)
MinNom1GrdSuffixvarchar(30)Like DR
MinNom1GrdFathervarchar(50)
MinNom1GrdAddr1varchar(30)
MinNom1GrdAddr2varchar(30)
MinNom1GrdAddr3varchar(30)
MinNom1GrdCityvarchar(25)
MinNom1GrdStatevarchar(25)State Name
MinNom1GrdStateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Like : For West Bengal : WB
MinNom1GrdCountryvarchar(25)Like: India
MinNom1GrdPinvarchar(30)Pincode
MinNom1GrdPhoneInd1char(3)(Obsolete in SharePro no need to pass now)
MinNom1GrdPhone1varchar(37)Primary Mobile
MinNom1GrdPhoneInd2char(3)(Obsolete in SharePro no need to pass now)
MinNom1GrdPhone2varchar(37)(Obsolete in SharePro no need to pass now)
MinNom1GrdAdtnlPhonevarchar(300)(Obsolete in SharePro no need to pass now)
MinNom1GrdFaxvarchar(37)
MinNom1GrdEmailvarchar(50)Primary Email
MinNom1GrdPanvarchar(25)Income Tax PAN No
MinNom1GrdITCirclevarchar(35)IT Circle / Ward / District
MinNom1GrdMinorYesNochar(3)Minor Flag
“Y” - Yes
“N” - No
MinNom1GrdMinorDOBdatetimeMinor Date of Birth
MinNom1GrdRelationchar(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
MinNom2GrdTitlevarchar(30)Like MR, MRS
MinNom2GrdFirstNamevarchar(300)
MinNom2GrdMiddleNamevarchar(20)
MinNom2GrdLastNamevarchar(20)
MinNom2GrdSuffixvarchar(30)Like DR
MinNom2GrdFathervarchar(50)
MinNom2GrdAddr1varchar(30)
MinNom2GrdAddr2varchar(30)
MinNom2GrdAddr3varchar(30)
MinNom2GrdCityvarchar(25)
MinNom2GrdStatevarchar(25)State Name
MinNom2GrdStateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Like : For West Bengal : WB
MinNom2GrdCountryvarchar(25)Like: India
MinNom2GrdPinvarchar(30)Pincode
MinNom2GrdPhoneInd1char(3)(Obsolete in SharePro no need to pass now)
MinNom2GrdPhone1varchar(37)Primary Mobile
MinNom2GrdPhoneInd2char(3)(Obsolete in SharePro no need to pass now)
MinNom2GrdPhone2varchar(37)(Obsolete in SharePro no need to pass now)
MinNom2GrdAdtnlPhonevarchar(300)(Obsolete in SharePro no need to pass now)
MinNom2GrdFaxvarchar(37)
MinNom2GrdEmailvarchar(50)Primary Email
MinNom2GrdPanvarchar(25)Income Tax PAN No
MinNom2GrdITCirclevarchar(35)IT Circle / Ward / District
MinNom2GrdMinorYesNochar(3)Minor Flag
“Y” - Yes
“N” - No
MinNom2GrdMinorDOBdatetimeMinor Date of Birth
MinNom2GrdRelationchar(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
MinNom3GrdTitlevarchar(30)
MinNom3GrdFirstNamevarchar(300)
MinNom3GrdMiddleNamevarchar(20)
MinNom3GrdLastNamevarchar(20)
MinNom3GrdSuffixvarchar(30)Like DR
MinNom3GrdFathervarchar(50)
MinNom3GrdAddr1varchar(30)
MinNom3GrdAddr2varchar(30)
MinNom3GrdAddr3varchar(30)
MinNom3GrdCityvarchar(25)
MinNom3GrdStatevarchar(25)State Name
MinNom3GrdStateCdchar(6)Please refer to getStateCodeList call to get a list of States with the broker. Send GSTSTATECD
Like : For West Bengal : WB
MinNom3GrdCountryvarchar(25)Like: India
MinNom3GrdPinvarchar(30)Pincode
MinNom3GrdPhoneInd1char(3)(Obsolete in SharePro no need to pass now)
MinNom3GrdPhone1varchar(37)Primary Mobile
MinNom3GrdPhoneInd2char(3)(Obsolete in SharePro no need to pass now)
MinNom3GrdPhone2varchar(37)(Obsolete in SharePro no need to pass now)
MinNom3GrdAdtnlPhonevarchar(300)(Obsolete in SharePro no need to pass now)
MinNom3GrdFaxvarchar(37)
MinNom3GrdEmailvarchar(50)Primary Email
MinNom3GrdPanvarchar(25)Income Tax PAN No
MinNom3GrdITCirclevarchar(35)IT Circle / Ward / District
MinNom3GrdMinorYesNochar(3)Minor Flag
“Y” - Yes
“N” - No
MinNom3GrdMinorDOBdatetimeMinor Date of Birth
MinNom3GrdRelationchar(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
OpModechar(1)Mode of Operation
Anyone or Survivor : 2, Jointly: 1, Sole Holder: 0
CommPrefchar(1)Communication Preference
All Holder: 2, First Holder: 1, None: 3
NomOptchar(1)Nomination Opt Out
No: N, Yes: Y
SMS
Mobilechar(10)(Obsolete in SharePro no need to pass now)
Email2char(100)(Obsolete in SharePro no need to pass now)
SmsRemarkschar(100)(Obsolete in SharePro no need to pass now)
ADDUSERchar(10)Record inserted by (like a 3r party vendor name : KYCDone)
"AddUser": "KYCDone"

Request Sample (JSon Data)
{
"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 JSon Response
Return DataSample

JSon Data:

{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "Record imported Successfully in SharePro"

}

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 ParameterData TypeExplanation
*keyvarchar(100)REST API Key
CompanyIdchar(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.
BranchIdchar(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
ClientIdchar(8)Instra ClientId
First Holder
*FhNamechar(45)1st Holder Name is compulsory
ShortNamechar(16)
*FhDOBdatetime1st Holder Date of Birth is compulsory
Genderchar(1)"M" - Male
"F" - Female
"X" - None
(This parameter is Obsolete no need to pass now)
*FhGenderchar(1)1st Holder Gender is compulsory
Male: 1
Female: 2
Transgender: 3
*FhFatherchar(45)1st Holder Father's Name is compulsory
FhMothervarchar(100)
*BenTypechar(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)
*BenSubTypechar(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)
*BenCategorychar(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)
*BenOccupationchar(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)
BoardOfResobitBoard meeting/resolution is done?
“0” : No
“1” : Yes
MemoOfArticlebitHave Company details ?
*FhEmailchar(50)1st Holder Email is compulsory
FhAltEmail1char(50)1st Holder Secondary Email 1
FhAltEmail2char(50)1st Holder Secondary Email 2
FhLandPhonechar(30)
*FhMobilechar(12)1st Holder Mobile is compulsory
*FhSmsYesNochar(1)1st Holder send SMS value must be in
"Y" - Yes
"N" - No
PidProofCdchar(2)1st Holder Proof of Identity Please refer to view NSDL Codes and search PHOTOID PROOF (idProofCd)
*FhPANchar(10)1st Holder PAN is compulsory
*FhAadhaarchar(12)1st Holder Aadhaar is compulsory
FhMapinchar(9)Mapin Id given by company
FhRtaYesNochar(1)Is Registered of transferred agent registered ?
”N” - No
“Y” - Yes
FhFmlyEmailYesNochar(1)Family Email Flag
”N” - No
“Y” - Yes
FhFmlyMobileYesNochar(1)Family Mobile Flag
”N” - No
“Y” - Yes
UCCchar(10)Client with this UCC must be exists in SharePro
StaningIndicatorchar(1)Auto Credit
”N” - No
“Y” - Yes
CustClntYesNochar(1)Having Custodian Identification no?
”N” - No
“Y” - Yes
CustIncomeCdchar(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
SharePerYesNochar(1)Having Share %?
”N” - No
“Y” - Yes
RiskProfilechar(20)Low Risk
High Risk
Medium Risk
RmCodechar(10)
GSTINchar(15)
GSTRegDatedatetime
*FhBankAcNochar(30)1st Holder Bank Account No. is compulsory
*BankAcTypenumeric(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
*MicrNochar(9)MICR No. of Bank is compulsory
*IFSCchar(11)IFSC of Bank is compulsory
EStatementYesNochar(1)E-Statement Flag
”N” - No
“Y” - Yes
FhRbiRefNochar(50)
RbiApprovalDatedatetime
SebiRegNochar(24)
FhTdschar(20)
AdrProofCdchar(2)1st Holder Proof of Address
Please refer to view NSDL Codes and search Address Proof - AdrProofCd
*StateCodechar(4)GST State Code is compulsory
Please refer to getStateCodeList call to get a list of States with the broker. Need to pass GSTStateCD
*BenLclAdrYesNochar(1)Beneficiary Local Address value must be either "Y" or "N"
”N” - No
“Y” - Yes
NoOfFhSignAuthnumeric(2, 0)
ExchangeIdchar(8)
SenderRefNo1char(35)
SenderRefNo2char(35)
ChargeCdchar(8)Charge Basket Cd
GroupCdchar(4)Family Group Cd
CommissionCdchar(5)
DespatchCdchar(5)
RgessYesNochar(1)RGESS value must be in
”N” - No
“Y” - Yes
BsdaYesNochar(1)BSDA value must be in
”N” - No
“Y” - Yes
CommodityYesNochar(1)”N” - No
“Y” - Yes
AutoPledgeYesNochar(1)”N” - No
“Y” - Yes
MinorIndYesNochar(1)”N” - No
“Y” - Yes
MinorNamechar(45)
MinorGuardianchar(45)
NomineeIndicatorchar(1)"" : No Nominee
NomineeNamechar(45)1st Holder 1st Nominee Name
NomineeGuardianchar(45)1st Holder 1st Nominee Guardian Name
NomineeDOBdatetime1st Holder 1st Nominee DOB
MinorNominee1DOBdatetime1st Holder 1st Minor Nominee DOB
NomineeName2char(45)1st Holder 2nd Nominee Name
NomGrdn2SameAs1char(1)Nominee Guardian 2 same as 1
”N” - No
NomineeGuardian2char(45)1st Holder 2nd Nominee Guardian Name
MinorNominee2DOBdatetime1st Holder 2nd Minor Nominee DOB
NomineeName3char(45)1st Holder 3rd Nominee Name
NomGrdn3SameAs1char(1)Nominee Guardian 3 same as 1
”N” - No
“Y” - Yes
NomineeGuardian3char(45)1st Holder 3rd Nominee Guardian Name
MinorNominee3DOBdatetime1st Holder 3rd Minor Nominee DOB
GrossIncomechar(2)"01" - Below 1 Lac
"02" - 1-5 Lacs
"03" - 5-10 Lacs
"04" - 10-25 Lacs
"05" - Above 25 Lacs
Second Holder
ShNamechar(45)
ShDOBdatetime
ShGenderchar(1)2nd Holder Gender
Male: 1, Female: 2, Transgender: 3
ShFatherchar(45)
ShMothervarchar(100)
ShEmailchar(50)
ShAltEmailchar(50)
ShLandPhonechar(30)
ShMobilechar(12)
ShSmsYesNochar(1)”N” - No
“Y” - Yes
ShPANchar(10)
ShAadhaarchar(12)
ShMapinchar(9)
ShRtaYesNochar(1)”N” - No
“Y” - Yes
ShFmlyEmailYesNochar(1)”N” - No
“Y” - Yes
ShFmlyMobileYesNochar(1)”N” - No
“Y” - Yes
NoOfShSignAuthnumeric(2, 0)
Third Holder
ThNamechar(45)
ThDOBdatetime
ThGenderchar(1)3rd Holder Gender
Male: 1, Female: 2, Transgender: 3
ThFatherchar(45)
ThMothervarchar(100)
ThEmailchar(50)
ThAltEmailchar(50)
ThLandPhonechar(30)
ThMobilechar(12)
ThSmsYesNochar(1)”N” - No
“Y” - Yes
ThPANchar(10)
ThAadhaarchar(12)
ThMapinchar(9)
ThRtaYesNochar(1)”N” - No
“Y” - Yes
ThFmlyEmailYesNochar(1)”N” - No
“Y” - Yes
ThFmlyMobileYesNochar(1)”N” - No
“Y” - Yes
NoOfThSignAuthnumeric(2, 0)
First Holder Local
*FhLclAddress1char(36)1st Holder Local Address is compulsory
FhLclAddress2char(36)
FhLclAddress3char(36)
FhLclAddress4char(36)
FhLclStateCdchar(2)Please refer to view NSDL Codes and search State Code
*FhLclCntryCdchar(3)“356” : India
Please refer to view NSDL Codes and search Country Code
*FhLclPinchar(10)1st Holder Local PIN is compulsory
FhLclPhonechar(24)
FhLclFaxchar(24)
*FhLclMobilenumeric(13, 0)1st Holder Local Mobile is compulsory
*FhLclEmailchar(50)1st Holder Local Email is compulsory
*FhLclPANchar(10)1st Holder Local PAN compulsory
*FhLclAadhaarchar(12)1st Holder Local Aadhaar compulsory
FhLclSharePernumeric(3, 0)
First Holder Bank Address
*FhBnkAddress1char(36)1st Holder Bank Address is compulsory
FhBnkAddress2char(36)
FhBnkAddress3char(36)
FhBnkAddress4char(36)
*FhBnkPinchar(10)1st Holder Bank PIN is compulsory
FhBnkPhonechar(24)1st Holder Bank Phone
FhBnkFaxchar(24)
FhBnkEmailchar(50)1st Holder Bank Email
First Holder Foreign Address
FhFrgnAddress1char(36)
FhFrgnAddress2char(36)
FhFrgnAddress3char(36)
FhFrgnAddress4char(36)
FhFrgnPinchar(10)
FhFrgnPhonechar(24)
FhFrgnFaxchar(24)
FhFrgnMobilenumeric(13, 0)
FhFrgnEmailchar(50)
FhFrgnPANchar(10)
FhFrgnAadhaarchar(12)
FhFrgnSharePernumeric(3, 0)
First Holder 1st Nominee Address
Fh1NomAddress1char(36)
Fh1NomAddress2char(36)
Fh1NomAddress3char(36)
Fh1NomAddress4char(36)
Fh1NomPinchar(10)
Fh1NomPhonechar(24)
Fh1NomFaxchar(24)
Fh1NomMobilenumeric(13, 0)
Fh1NomEmailchar(50)
Fh1NomPANchar(10)
Fh1NomAadhaarchar(12)
Fh1NomSharePernumeric(3, 0)
First Holder 2nd Nominee Address
Fh2NomAddress1char(36)
Fh2NomAddress2char(36)
Fh2NomAddress3char(36)
Fh2NomAddress4char(36)
Fh2NomPinchar(10)
Fh2NomPhonechar(24)
Fh2NomFaxchar(24)
Fh2NomMobilenumeric(13, 0)
Fh2NomEmailchar(50)
Fh2NomPANchar(10)
Fh2NomAadhaarchar(12)
Fh2NomSharePernumeric(3, 0)
First Holder 3rd Nominee Address
Fh3NomAddress1char(36)
Fh3NomAddress2char(36)
Fh3NomAddress3char(36)
Fh3NomAddress4char(36)
Fh3NomPinchar(10)
Fh3NomPhonechar(24)
Fh3NomFaxchar(24)
Fh3NomMobilenumeric(13, 0)
Fh3NomEmailchar(50)
Fh3NomPANchar(10)
Fh3NomAadhaarchar(12)
Fh3NomSharePernumeric(3, 0)
1st Minor
Fh1MinAddress1char(36)
Fh1MinAddress2char(36)
Fh1MinAddress3char(36)
Fh1MinAddress4char(36)
Fh1MinPinchar(10)
Fh1MinPhonechar(24)
Fh1MinFaxchar(24)
Fh1MinMobilenumeric(13, 0)
Fh1MinEmailchar(50)
Fh1MinPANchar(10)
Fh1MinAadhaarchar(12)
Fh1MinSharePernumeric(3, 0)
2nd Minor
Fh2MinAddress1char(36)
Fh2MinAddress2char(36)
Fh2MinAddress3char(36)
Fh2MinAddress4char(36)
Fh2MinPinchar(10)
Fh2MinPhonechar(24)
Fh2MinFaxchar(24)
Fh2MinMobilenumeric(13, 0)
Fh2MinEmailchar(50)
Fh2MinPANchar(10)
Fh2MinAadhaarchar(12)
Fh2MinSharePernumeric(3, 0)
3rd Minor
Fh3MinAddress1char(36)
Fh3MinAddress2char(36)
Fh3MinAddress3char(36)
Fh3MinAddress4char(36)
Fh3MinPinchar(10)
Fh3MinPhonechar(24)
Fh3MinFaxchar(24)
Fh3MinMobilenumeric(13, 0)
Fh3MinEmailchar(50)
Fh3MinPANchar(10)
Fh3MinAadhaarchar(12)
Fh3MinSharePernumeric(3, 0)
Second Holder Local Address
ShLclAddress1char(36)
ShLclAddress2char(36)
ShLclAddress3char(36)
ShLclAddress4char(36)
ShLclPinchar(10)
ShLclPhonechar(24)
ShLclFaxchar(24)
ShLclMobilenumeric(13, 0)
ShLclEmailchar(50)
ShLclPANchar(10)
ShLclAadhaarchar(12)
ShLclSharePernumeric(3, 0)
Second Holder Bank Address
ShBnkAddress1char(36)
ShBnkAddress2char(36)
ShBnkAddress3char(36)
ShBnkAddress4char(36)
ShBnkPinchar(10)
ShBnkPhonechar(24)
ShBnkFaxchar(24)
ShBnkEmailchar(50)
Second Holder Foreign Address
ShFrgnAddress1char(36)
ShFrgnAddress2char(36)
ShFrgnAddress3char(36)
ShFrgnAddress4char(36)
ShFrgnPinchar(10)
ShFrgnPhonechar(24)
ShFrgnFaxchar(24)
ShFrgnMobilenumeric(13, 0)
ShFrgnEmailchar(50)
ShFrgnPANchar(10)
ShFrgnAadhaarchar(12)
ShFrgnSharePernumeric(3, 0)
Second Holder 1st Nominee
Sh1NomAddress1char(36)
Sh1NomAddress2char(36)
Sh1NomAddress3char(36)
Sh1NomAddress4char(36)
Sh1NomPinchar(10)
Sh1NomPhonechar(24)
Sh1NomFaxchar(24)
Sh1NomMobilenumeric(13, 0)
Sh1NomEmailchar(50)
Sh1NomPANchar(10)
Sh1NomAadhaarchar(12)
Sh1NomSharePernumeric(3, 0)
Second Holder 2nd Nominee
Sh2NomAddress1char(36)
Sh2NomAddress2char(36)
Sh2NomAddress3char(36)
Sh2NomAddress4char(36)
Sh2NomPinchar(10)
Sh2NomPhonechar(24)
Sh2NomFaxchar(24)
Sh2NomMobilenumeric(13, 0)
Sh2NomEmailchar(50)
Sh2NomPANchar(10)
Sh2NomAadhaarchar(12)
Sh2NomSharePernumeric(3, 0)
Second Holder 3rd Nominee
Sh3NomAddress1char(36)
Sh3NomAddress2char(36)
Sh3NomAddress3char(36)
Sh3NomAddress4char(36)
Sh3NomPinchar(10)
Sh3NomPhonechar(24)
Sh3NomFaxchar(24)
Sh3NomMobilenumeric(13, 0)
Sh3NomEmailchar(50)
Sh3NomPANchar(10)
Sh3NomAadhaarchar(12)
Sh3NomSharePernumeric(3, 0)
Second Holder 1st Minor
Sh1MinAddress1char(36)
Sh1MinAddress2char(36)
Sh1MinAddress3char(36)
Sh1MinAddress4char(36)
Sh1MinPinchar(10)
Sh1MinPhonechar(24)
Sh1MinFaxchar(24)
Sh1MinMobilenumeric(13, 0)
Sh1MinEmailchar(50)
Sh1MinPANchar(10)
Sh1MinAadhaarchar(12)
Sh1MinSharePernumeric(3, 0)
Second Holder 2nd Minor
Sh2MinAddress1char(36)
Sh2MinAddress2char(36)
Sh2MinAddress3char(36)
Sh2MinAddress4char(36)
Sh2MinPinchar(10)
Sh2MinPhonechar(24)
Sh2MinFaxchar(24)
Sh2MinMobilenumeric(13, 0)
Sh2MinEmailchar(50)
Sh2MinPANchar(10)
Sh2MinAadhaarchar(12)
Sh2MinSharePernumeric(3, 0)
Second Holder 3rd Minor
Sh3MinAddress1char(36)
Sh3MinAddress2char(36)
Sh3MinAddress3char(36)
Sh3MinAddress4char(36)
Sh3MinPinchar(10)
Sh3MinPhonechar(24)
Sh3MinFaxchar(24)
Sh3MinMobilenumeric(13, 0)
Sh3MinEmailchar(50)
Sh3MinPANchar(10)
Sh3MinAadhaarchar(12)
Sh3MinSharePernumeric(3, 0)
Third Holder Local Address
ThLclAddress1char(36)
ThLclAddress2char(36)
ThLclAddress3char(36)
ThLclAddress4char(36)
ThLclPinchar(10)
ThLclPhonechar(24)
ThLclFaxchar(24)
ThLclMobilenumeric(13, 0)
ThLclEmailchar(50)
ThLclPANchar(10)
ThLclAadhaarchar(12)
ThLclSharePernumeric(3, 0)
Third Holder Bank Address
ThBnkAddress1char(36)
ThBnkAddress2char(36)
ThBnkAddress3char(36)
ThBnkAddress4char(36)
ThBnkPinchar(10)
ThBnkPhonechar(24)
ThBnkFaxchar(24)
ThBnkEmailchar(50)
Third Holder Foreign Address
ThFrgnAddress1char(36)
ThFrgnAddress2char(36)
ThFrgnAddress3char(36)
ThFrgnAddress4char(36)
ThFrgnPinchar(10)
ThFrgnPhonechar(24)
ThFrgnFaxchar(24)
ThFrgnMobilenumeric(13, 0)
ThFrgnEmailchar(50)
ThFrgnPANchar(10)
ThFrgnAadhaarchar(12)
ThFrgnSharePernumeric(3, 0)
Third Holder 1st Nominee Address
Th1NomAddress1char(36)
Th1NomAddress2char(36)
Th1NomAddress3char(36)
Th1NomAddress4char(36)
Th1NomPinchar(10)
Th1NomPhonechar(24)
Th1NomFaxchar(24)
Th1NomMobilenumeric(13, 0)
Th1NomEmailchar(50)
Th1NomPANchar(10)
Th1NomAadhaarchar(12)
Th1NomSharePernumeric(3, 0)
Third Holder 2nd Nominee Address
Th2NomAddress1char(36)
Th2NomAddress2char(36)
Th2NomAddress3char(36)
Th2NomAddress4char(36)
Th2NomPinchar(10)
Th2NomPhonechar(24)
Th2NomFaxchar(24)
Th2NomMobilenumeric(13, 0)
Th2NomEmailchar(50)
Th2NomPANchar(10)
Th2NomAadhaarchar(12)
Th2NomSharePernumeric(3, 0)
Third Holder 3rd Nominee Address
Th3NomAddress1char(36)
Th3NomAddress2char(36)
Th3NomAddress3char(36)
Th3NomAddress4char(36)
Th3NomPinchar(10)
Th3NomPhonechar(24)
Th3NomFaxchar(24)
Th3NomMobilenumeric(13, 0)
Th3NomEmailchar(50)
Th3NomPANchar(10)
Th3NomAadhaarchar(12)
Th3NomSharePernumeric(3, 0)
Third Holder 1st Minor Address
Th1MinAddress1char(36)
Th1MinAddress2char(36)
Th1MinAddress3char(36)
Th1MinAddress4char(36)
Th1MinPinchar(10)
Th1MinPhonechar(24)
Th1MinFaxchar(24)
Th1MinMobilenumeric(13, 0)
Th1MinEmailchar(50)
Th1MinPANchar(10)
Th1MinAadhaarchar(12)
Th1MinSharePernumeric(3, 0)
Third Holder 2nd Minor Address
Th2MinAddress1char(36)
Th2MinAddress2char(36)
Th2MinAddress3char(36)
Th2MinAddress4char(36)
Th2MinPinchar(10)
Th2MinPhonechar(24)
Th2MinFaxchar(24)
Th2MinMobilenumeric(13, 0)
Th2MinEmailchar(50)
Th2MinPANchar(10)
Th2MinAadhaarchar(12)
Th2MinSharePernumeric(3, 0)
Third Holder 3rd Minor Address
Th3MinAddress1char(36)
Th3MinAddress2char(36)
Th3MinAddress3char(36)
Th3MinAddress4char(36)
Th3MinPinchar(10)
Th3MinPhonechar(24)
Th3MinFaxchar(24)
Th3MinMobilenumeric(13, 0)
Th3MinEmailchar(50)
Th3MinPANchar(10)
Th3MinAadhaarchar(12)
Th3MinSharePernumeric(3, 0)
Authorised Signatories
First Holder
FhAuthNamechar(135)
FhAuthRefNochar(10)
FhAuthPidProofCdchar(2)1st Holder Authorised Signatory Proof of Identity
FhAuthAdrProofCdchar(2)1st Holder Authorised Signatory Proof of Address
Second Holder
ShAuthNamechar(135)
ShAuthRefNochar(10)
ShAuthPidProofCdchar(2)2nd Holder Authorised Signatory Proof of Identity
ShAuthAdrProofCdchar(2)2nd Holder Authorised Signatory Proof of Address
Third Holder
ThAuthNamechar(135)
ThAuthRefNochar(10)
ThAuthPidProofCdchar(2)3rd Holder Authorised Signatory Proof of Identity
ThAuthAdrProofCdchar(2)3rd Holder Authorised Signatory Proof of Address
Ben POA
First Holder
FhPoaTypechar(1)
FhPoaIdchar(8)
FhPoaActiveDatedatetime
Second Holder
ShPoaTypechar(1)
ShPoaIdchar(8)
ShPoaActiveDatedatetime
Third Holder
ThPoaTypechar(1)
ThPoaIdchar(8)
ThPoaActiveDatedatetime
Add Signature
SigImgtext Base64StringSent Signature image as Base64String
Request Sample (JSon Data)
{
"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 JSon Response
Return DataSample

JSon Data:

{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "Record imported Successfully in SharePro"
}

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


cUcc          varchar(10)
cSegment varchar(4) -- "CM", "NSDL", "CDSL"
cCategory varchar(10)
"KYC" : KYC Scan Copy,
"SIG": Signature ,
"MISC": Miscellaneous
"1": CKYC - KYC
"2": CKYC - PHOTO
"3": CKYC - PAN
"4": CKYC - UID / AADHAR
"5": CKYC - Passport
"6": CKYC - Driving License
"7": CKYC - Voters Identity Card
"8": CKYC - NREGA Job Card
"9": CKYC - SIGN
"10": CKYC - Simplified ID - issued by CG/SG/SB/RA/PSU/S
"11": CKYC - Simplified ID - issued by a Gazzetted Offic
"12": CKYC - Utility:Elec/Tel/Mob-PostPaid/PipeGas/Water
"13": CKYC - Property / Municipal Tax Receipt
"14": CKYC - Bank account / Post Office SB Statement
"15": CKYC - Pension(Family) PO issued to Govt/PSU retir
"16": CKYC - Allot Letter/Agreement (specified Employers
"17": CKYC - Doc from ForEmbassy/ForGovtDepts/MissionInI
"98": CKYC - Other
"99": CKYC - Multiple Images

FileType char(10) -- File, Image
cDescr varchar(100)
cNotes text
cImgFileName varchar(100) -- File Name ( Like : signature.JPG )
cImg text -- Sent image as Base64String

Request Sample (JSon Data)


  {
"key": "ezhDMEI5ND4MLE3YwNH0=",
"cUcc": "151A355",
"cSegment": "CM",
"cCategory": "SIG",
"FileType": "Image",
"cDescr": "This is my signature",
"cNotes": "Notes",
"cImgFileName": "signature.JPG",
"cImg": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAAxAJ4DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD9/KKKKACiiigAoqO7u4rC1knnkjhghQySSSMFWNQMkkngADnJr8qv2Cf+DkXVP+Clv/BVSx+Dvwv+FMjfCO3tdSn1XxZeTyPfxw28MjQXpiUCO3hlnEMIRy7k3CnKnKUAfqzRX5v/ALRf/Bzz+z9+zb/wULt/gPq/9qXFnY3jaR4l8YQkDTfDeohtn2eRCN8io3yyyIcRHIw21tv6QUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRXiv8AwUX/AOFyn9ib4hr+z7DYXHxik05Y/DS3csMSCVpo1lZWnIhEqwGVo/NITzAm75c0AfCP/B1X/wAFK/h/8B/+Cfnjb4J2njOW3+MHxEgsYbLSdJlJurKyW+t5riW7ZSPIhlt45YgGO6XzcBWTey6n/Bqf/wAE2F/Yu/4J92nxG1y3tv8AhNvjpDa+ImkRlka10cxb9Og3DIBeOVp2AOczqrDMfGL+yX/wa3/DHUP2UfE8f7Q1/wCJPH3xu+L9jDc+LPFcl+smoeHrppIrl4tPmcSrvSWNVe4cOZgrDCxuYq5//iCp/ZZ/6H79oD/weaR/8rKAPx7/AOCj11Al9+3tC0kIupP2ptOeOMsPMZFPjoMQOuAWTJHALL6iv6/NO1G31fT4Lu0nhurW6jWaGaFw8cyMMqysOCpBBBHBBr+K/wDbj/ZL+H/7Cnx0/aM+FvirS/ivbeNvC/iaK0+F80slmmnXeji8nL3mqFohJM0tkLVoTbCNDI8hbAUIf1O/4NK/+Ch/xM0X4+/8KD+LXiXxZqHh/wAbeDodb+G0HiC7lnW1hsWkh+z2Xmkslu9vHKVRf3arY/IADyAf0EV+b/7X3/B0x+zD+xn+07rXwq1xPiJ4i1rwzeHTtZ1DQNIt7jTdMulO2WB3luYpGeNsq/lxuAwK5JBA/SCv57/Fvx/+Kn/BAX9v39tXxR4u/Zj8T/GL4O/HDxTD4im8TBJ7Tw/ZW1xeXs8MUty1ncW7lpNUFu0cjIRJGAN25QQD9rP2LP8AgoD8IP8AgoZ8NpPFXwh8a6b4u0y1kEF5HGklveafLgHZPbyqssZ54LLtbBKlhzXslfyueGvG3/BLf/goN431fxf8TrH4wfsj+IrxnuLrRPCtwmreG7qRm+9bGPTbiSJjkkxiCCJQMKK4H9rn/hjj9gLUPht8WP2IP2hviV42+K/hPxbbXVzpfiTS7mG3FmiSS+d5jadZIyebFHFJCWfzUuDwArZAP64a/N//AILE/wDBxPof/BJD9p/wd8M7r4V658QLrxBoKeJtRvLPV0sv7NsmuLiEGOMwyefIPsk7MrNEoUL8/J2/nz+wX/wS/vv+DkTxp8ev2nviN8RPiV4GN14wl034YzWF3HINGhi3S+W8UiZeCCKazjT7PLDmRLgli2SPrz9m/wD4Ne9X8Kftc6P8Ufjj+054w/aIh0vw7qnhh9L8R6NP51xY31heWTW/2u41C5dIUW+uHVEUYdsgjJyAfpp+zh+0J4W/av8AgR4U+JHgm/8A7S8K+MtOi1PTpyu1/Lcco6/wyI25HU8qysDyK7avjf8A4I2/8Epdb/4JK/CrxV4Hn+MuvfFHwnqeoJeeH9MvtJXT4fC8e6ZpUiAmlLtM0qs5GxC0e4RqWYn7IoAKKKKACiiigAooooAKKKKACiiigAr80f8Agv5/wTg+Jnxl8QfDX9pr9ntof+F5/AF3urfThD5k3iPTw/m/Z0HSR42M2ITjzUuZlB3FVb9LqKAPkH/gjv8A8Fd/B/8AwVl+Alxq1hat4a+InhMx2fjHwtMT5uk3LbgJIy3L28hjk2MfmBVlYBl5+E/+CxPxl8Vf8Fqv+CgWj/sH/B3VFs/A/he4XWPix4mhhFxFZNbsreR6HyGKLtyN9zIiHaIWNe5ft2f8G2lh+0J+1nrHxu+Cvx4+IH7OHxC8WOz+Ibjw/E8ttflo1R2iW3uLSWF5CpaUmZ1kZidiksT9Df8ABJj/AIJFeBf+CTfwm1rSdA1bVPGPjHxhdrf+J/Feqxql5rEyg7VCgt5cKlpGVC7tulcs7E8AHnf7Xv8AwbZ/so/tX/DD+yY/hzpfgPxRY6OulaV4m8NobC6tGQKI554ImSC8k+UBmuEd2UkB1OGX5d/YA/4M9fBv7Iv7VXh34g+PPifovxo8O6DHdiXwjrHw9gj0/U3mtpYEacTXdyjLGZfNVTHnfHGQRtr9mKKAKmg6DY+FdDs9L0uytNN03ToEtrS0tYVhgtYkUKkaIoCqqqAAoAAAAFW6KKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//Z"
}
Return JSon Response: Sample

Return Data:

{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "File imported Successfully in SharePro"
}

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:
{  
"key": "<<RestAPI Key>>", * mandatory
"BoCode": "<<BO Code>>" * mandatory
OR UCC | SUBCD | BenAcNum

"CompanyId": "<<Company Code>>" 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.

Nominee Details

"NomineeNo": "<<01 to 03>>", * mandatory
"FirstName", * mandatory
"MidName":,
"LastName", * mandatory
"Title",
"Suffix",
"FatherNm",
"Addr1", * mandatory
"Addr2",
"Addr3",
"City",
"PinCode", * mandatory
"State", * mandatory
"GSTStateCode", (West Bengal : WB) Please refer
to getStateCodeList
call to get a list of States with the broker.
"Country", (Like: India) * mandatory
"pCntrycd", (For India : IN )
"Mobile",
"Fax",
"Pan",
"ITCircle", (IT Circle / Ward / District)
"Email",
"MinorFlag", (“Y” - Yes, “N” - No | If Yes then need to pass
minor nominee guardian details)
"MinorDOB", (Minor Date of Birth)
"Relation", "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
"SharePer",
"ResSecFlag"

**Minor Nominee Guardian Details**
If MinorFlag send “Y”: Yes then need to
pass Minor Nominee Guardian details
"gFirstName", * mandatory
"gMidName":,
"gLastName", * mandatory
"gTitle",
"gSuffix",
"gFatherNm",
"gAddr1", * mandatory
"gAddr2",
"gAddr3",
"gCity",
"gPinCode", * mandatory
"gState", * mandatory
"gGSTStateCode", (West Bengal : WB) Please refer to
getStateCodeList call to get a list of States with the broker.
"gCountry", (Like: India) * mandatory
"gpCntrycd", (For India : IN )
"gMobile",
"gFax",
"gPan",
"gITCircle", (IT Circle / Ward / District)
"gEmail",
"gMinorFlag", (“Y” - Yes, “N” - No)
"gMinorDOB",
"gRelation", "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
}
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"BoCode": "CM00000021",
"NomineeNo": "01",
"FirstName": "Partha",
"MidName": "",
"LastName": "Jana",
"Title": "",
"Suffix": "",
"FatherNm": "GD",
"Addr1": "17/80",
"Addr2": "Garia",
"Addr3": "Boubagan",
"City": "Kolkata",
"PinCode": "700084",
"State": "West Bengal",
"Country": "India",
"Mobile": "8545054652",
"Fax": "",
"Pan": "",
"ITCircle": "Garia",
"Email": "mithun@abc.com",
"MinorFlag": "N",
"MinorDOB": "",
"Relation": "02",
"SharePer": "100",
"ResSecFlag": ""
}
JSon Response:
{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "CDSL Client Nominee updated Successfully"
}

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:
{  
"key": "<<RestAPI Key>>", * mandatory
"BoCode": "<<BO Code>>" * mandatory
OR UCC | SUBCD | BenAcNum
"CompanyId": "<<Company Code>>" 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.
"Email": "<<Primary Email>>", * mandatory
"OldEmail": "<<Validate with any Old Email>>",
"secEmail": "<<Secondary Email>>",
"pEmail": "<<Permanent Address Email>>",
"CheckEmailAlreadyExists": "<<Search whether email id is mapped?>"
}
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"BoCode": "CM00000021",
"Email": "MNUSHAM010@GMAIL.COM",
"secEmail": "ANUSHAM009@GMAIL.COM",
"CheckEmailAlreadyExists": "1"
}
JSon Response:
{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "Email updated Successfully"
}
Email already exists Error
{
"success": 0,
"message": {
"message": "Email already exists!",
"searchEmailResult": [
{
"CompanyId"
"BranchID"
"BoCode"
"UCC"
"BenAcNum"
"PAN"
"FirstName"
"MidName"
"LastName"
"Email"
"secEmail"
"pEmail"
}
]
}
}
{
"success": 0,
"message": {
"message": "Email already exists!",
"searchEmailResult": [
{
"CompanyId": "05",
"BranchID": "HO",
"BoCode": "CA00000014",
"UCC": "SSL0008",
"BenAcNum": "",
"PAN": "ARFPM9512K",
"FirstName": "ANUSHA",
"MidName": "",
"LastName": "MOORTHY",
"Email": "ANUSHAM009@GMAIL.COM",
"secEmail": "",
"pEmail": "ANUSHAM009@GMAIL.COM"
}
]
}
}

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:
{  
"key": "<<RestAPI Key>>", * mandatory
"BoCode": "<<BO Code>>" * mandatory
OR UCC | SUBCD | BenAcNum
"CompanyId": "<<Company Code>>" 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.

"Mobile": "<<Primary Mobile>>", * mandatory
"OldMobile": "<<Validate with any Old Mobile>>",
"secMobile": "<<Secondary Mobile>>",
"CheckMobileAlreadyExists": "<<Search whether Mobile is mapped?>"
}
{
"key": "ezhDMEI5ND4MLE3YwNH0=",
"BoCode": "CM00000021",
"Mobile": "8095555590",
"secMobile": "8095555591",
"CheckMobileAlreadyExists": "1"
}
JSon Response:
{
"success": <<1:Success, 0: Failure>>,
"message":”<<Message>>"
}
{
"success": 1,
"message": "Mobile updated Successfully"
}
Mobile already exists Error
{
"success": 0,
"message": {
"message": "Mobile already exists!",
"searchMobileResult": [
{
"CompanyId"
"BranchID"
"BoCode"
"UCC"
"BenAcNum"
"PAN"
"FirstName"
"MidName"
"LastName"
"Mobile"
"secMobile"
}
]
}
}
{
"success": 0,
"message": {
"message": "Mobile already exists!",
"searchMobileResult": [
{
"CompanyId": "05",
"BranchID": "HO",
"BoCode": "CA00000014",
"UCC": "SSL0008",
"BenAcNum": "",
"PAN": "ARFPM9512K",
"FirstName": "ANUSHA",
"MidName": "",
"LastName": "MOORTHY",
"Mobile": "8095555590",
"secMobile": ""
}
]
}
}