Annexure B – Web API file structure
Annexure B – Web API file structure
January 2025
Notice
The contents, ideas and concepts presented herein are proprietary and
confidential. Duplication and disclosure to others in whole, or in part is
prohibited.
Table of Contents
Common Authentication For All APIs...................................................................6
Common Authentication & Authorization Logic...............................................6
API URL.........................................................................................................7
Order Entry (PUR/RED) Service API......................................................................8
Sample Request Json :................................................................................11
Sample Response Json :.............................................................................11
Switch Order Entry Service API..........................................................................13
Sample Request Json :................................................................................15
Sample Response Json :.............................................................................15
XSIP Registration Service API.............................................................................17
Sample Request Json :................................................................................19
Sample Response Json :.............................................................................20
(X)SIP Topup Registration Service API................................................................22
Sample Response Json :.............................................................................23
Sample Response Json :.............................................................................23
SIP Registration Service API...............................................................................25
Sample Request Json :................................................................................27
Sample Response Json :.............................................................................28
STP Registration Service API..............................................................................29
Sample Request Json :................................................................................31
Sample Response Json :.............................................................................32
SWP Registration Service API.............................................................................33
Sample Request Json :................................................................................35
Sample Response Json :.............................................................................35
Order Cancellation ( Normal / Switch ) Service API............................................37
Sample Request Json :................................................................................37
Sample Response Json :.............................................................................38
UCC Registration API..........................................................................................39
Sample Request Json :................................................................................49
Sample Response Json :.............................................................................52
SIP Cancellation Service API..............................................................................56
Sample Request Json :................................................................................57
Sample Response Json :.............................................................................57
XSIP Cancellation Service API............................................................................58
Sample Request Json :................................................................................59
Sample Response Json :.............................................................................59
DAILY XSIP Cancellation Service API..................................................................60
Sample Request Json :................................................................................61
Sample Response Json :.............................................................................61
STP Cancellation Service API.............................................................................62
Sample Request Json :................................................................................62
Sample Response Json :.............................................................................63
Client Bank Detail API........................................................................................64
Sample Request Json :................................................................................64
Sample Response Json :.............................................................................65
Mandate Registration API..................................................................................66
Sample Request Json :................................................................................67
Sample Response Json :.............................................................................67
Scan Mandate Image Upload API.......................................................................68
Sample Request Json :................................................................................68
Sample Response Json(Success) :..............................................................68
Sample Response Json(Failure) :................................................................68
UTR No Update on Purchase Order API..............................................................69
1. Every Member users who have access to Member Desk can access API
2. User ID would be same as used for Member Desk.
3. IP Address must be validated against User (Need to whitelist your IP with NSE)
4. Role based access invalidated for each API. (i.e. If user can not access Client
Registration Entry module then Client Registration API is not accessible to respective
user.)
5. Authentication parameters must be passed as request header
6. If the login is not successful then error code “403 FORBIDDEN” will be sent with error
Message “Invalid authorization header or IP Address not mapped with user.”
7. If the login is successful then Proceed for actual API Business Logic processing
Request Headers
Sr
Header Name Type Value/ Remark
No.
1 Content-Type varchar application/json
2 memberId INT 1
base64(Login User ID: Encrypted
BASIC
3 Authorization Password)
For eg.
========
eg. 90E9c0485ty54g864e5aae05a34d356f|34533412321
API URL
Type : Post
MANDAT
ORY/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDAT TYPE
ORY
Unique reference number from
the member. Number can be
incremental for each
order_ref_numb
Optional VARCHAR 19 order(000001,
er
000002,….). The number can be
reset the next day.
Optional
Scheme code should be exist
and NOT disable in system
scheme_code Mandatory VARCHAR 20 Amc of scheme should be active
Amc of scheme should be
mapped with given member
Values : P = Purchase, R =
Redemption
trxn_type Mandatory VARCHAR 1 value is not other than P/R
Purchase OR redemption is
allowed on given amc
Values : FRESH/ADDITIONAL
buy_sell_type Mandatory VARCHAR 10 value is not other than
FRESH/ADDITIONAL
client_code Mandatory VARCHAR 10 Client should present in system
for given member
Client is active in system
Validation of client tax status like
NRI of some countries not
of physical
redemption transactions. If the
flag is “Y”, then
the amount and units fields will
be blank. In case
of demat, keep it as blank.
redemption_unit Conditiona Mandatory for demat redemption
DECIMAL 15,3
s l order.
sub_broker_arn Optional VARCHAR 20 Should start with ARN-
bank_ref_no Optional VARCHAR 25
Mandatory for redemption.
Conditiona
account_no VARCHAR 20 Should available in client’s bank
l
details registered with NSE.
mobile_no Optional NUMBER 10
email Optional VARCHAR 50
mandate_id Optional NUMBER 13
filler1 Optional VARCHAR
Should be blank.
trxn_order_id Optional NUMBER 12 Unique Exchange Trxn No. in API
response
Should be blank.
Values : TRXN FAILED
trxn_status Optional VARCHAR 15
/TRXN SUCCESS in API
response.
Should be blank.
trxn_remark Optional VARCHAR 255
Trxn remarks in API response.
{
"transaction_details":
[
{
"order_ref_number": "",
"scheme_code": "AXBDGP-GR",
"trxn_type": "P",
"buy_sell_type": "FRESH",
"client_code": "H30350",
"demat_physical": "C",
"order_amount": "2000",
"folio_no": "",
"remarks": "ADD THROUGH API",
"kyc_flag": "Y",
"sub_broker_code": "",
"euin_number": "E123456",
"euin_declaration": "Y",
"min_redemption_flag": "N",
"dpc_flag": "Y",
"all_units": "N",
"redemption_units": "",
"sub_broker_arn": "",
"bank_ref_no": "5434232",
"account_no": "343434334",
"mobile_no": "",
"email": "",
"mandate_id": "",
"filler1": "",
"trxn_order_id": "432160000001",
"trxn_status": "TRXN SUCCESS",
"trxn_remark": ""
}
]
}
Type : Post
MANDAT
ORY/ NON FIELD
SIZE DESCRIPTION
FIELD NAME MANDAT TYPE
ORY
Unique reference number from
the member. Number can be
incremental for each
order_ref_numb
Optional VARCHAR 19 order(000001,
er
000002,….). The number can be
reset the next day.
Optional
from_scheme_c
Mandatory VARCHAR 20 Switch out scheme code
ode
to_scheme_cod
Mandatory VARCHAR 20 Switch in scheme code
e
Values : FRESH/ADDITIONAL
buy_sell_type Mandatory VARCHAR 10 Value should not be other than
FRESH/ADDITIONAL
Client should present in system
for given member
client_code Mandatory VARCHAR 10
Client should active in system
"sub_broker_arn": "",
"mobile_no": "",
"email": "",
"filler1": "",
"filler2": "",
"filler3": ""
"trxn_so_order_id": "432160000002",
"trxn_si_order_id": "432160000003",
"trxn_status": "TRXN SUCCESS",
"trxn_remark": ""
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
reg_data Mandatory List of Object 50 Orders
table
allowed in
single
request
MANDAT
ORY/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDAT TYPE
ORY
amc_code Mandatory VARCHAR 50 AMC code of given scheme
sch_code Mandatory VARCHAR 20 Scheme code for XSIP
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
bank_ref_no Optional VARCHAR 25
1. Must be D or P2. Must match
with sip transaction mode3. client
trans_mode Mandatory VARCHAR 20
depository is PHYSICAL then
DEMAT not allowed
dp_txn_mode Mandatory VARCHAR 1 Values : C = CDSL Demat, N =
NSDL Demat, P = Physical
For limited membership if Client
Tax Status is Minor or NRI then
its AOF status must be verified.
For physical each holders PAN
must have AOF image is either
uploaded or Accepted by RTA
For Physical if FATCA check is
required by RTA for given
scheme then Check FATCA of
each holders should be either
uploaded or Should not be
Rejected.
Format DD/MM/YYYY.
Past date is not allowed.
start_date Mandatory VARCHAR 10
Day of date must be within
allowed dates for SIP.
Values :
WEEKLY/ MONTHLY/
QUARTERLY/
frequency_type Mandatory VARCHAR 20 SEMI-ANNUALLY /ANNUALLY/
DAILY
Must be allowed for given
scheme code.
frequency_allow
Mandatory VARCHAR 1 Value Must be 1. 1=Rolling.
ed
Amount for SIP
Must be within minimum and
installment_amo maximum amount allowed for
Mandatory DECIMAL 12,2
unt given scheme.
Must be a multiplier of given
scheme.
Values : 1=Active, 0=Inactive
status Mandatory NUMBER 1
Must be 1
member_code Mandatory VARCHAR 20
folio_no Optional VARCHAR 15 existing folio no if any
sip_remarks Optional VARCHAR 100
Mandatory in case of frequency
other than DAILY.
Conditiona Must be blank in case of DAILY.
installment_no NUMBER
l Must be between MIN and MAX
instalment no allowed for given
scheme.
If member have not opted for
convenience_fe
Optional VARCHAR 10,2 convenience Fee then
e
convenience fee must be zero.
xsip_mandate_i Clients mandate number.
Optional NUMBER
d Must be approved mandate.
sub_broker_cod
Optional VARCHAR 15
e
E+6 Numberic
Mandatory if EUIN Declaration is
Conditiona
euin_number VARCHAR 7 Y
l
EUIN
should start with E.
euin_declaration Mandatory VARCHAR 1 Values : Y, N.
dpc_flag Mandatory VARCHAR 1 Values : Y, N. It should be Y.
Values : Y, N.
first_order_toda
Mandatory VARCHAR 1 If Y then first order will be
y
generated on Current date.
primary_holder_
Optional VARCHAR 10
mobile
primary_holder_
Optional VARCHAR 50
email
filler_1 Optional VARCHAR Keep it blank
filler_2 Optional VARCHAR Keep it blank
filler_3 Optional VARCHAR Keep it blank
filler_4 Optional VARCHAR Keep it blank
filler_5 Optional VARCHAR Keep it blank
Should be blank.
reg_id Optional NUMBER 15 Unique Exchange XSIP
Registration No. in API response
Should be blank.
Values :
reg_status Optional VARCHAR 15
REG_SUCCESS,REG_FAILED.
in API response
reg_remark Optional VARCHAR 200 Should be blank.
{
"reg_data": [
{
"amc_code": "AXISMUTUALFUND_MF",
"sch_code": "AXIOGP-GR",
"client_code": "H30350",
"bank_ref_no": "671297212",
"trans_mode": "D",
"dp_txn_mode": "C",
"start_date": "10/08/2023",
"frequency_type": "MONTHLY",
"frequency_allowed": "1",
"installment_amount": "3000",
"status": "1",
"member_code": "4079",
"folio_no": "",
"sip_remarks": "",
"installment_no": "12",
"convenience_fee": "10",
"xsip_mandate_id": "12",
"sub_broker_code": "",
"euin_number": "E399871",
"euin_declaration": "Y",
"dpc_flag": "Y",
"first_order_today": "N",
"isip_mandate": "",
"sub_broker_arn": "",
"end_date": "",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]",
"filler_1": "",
"filler_2": "",
"filler_3": "",
"filler_4": "",
"filler_5": ""
}
]
}
{
"reg_data":
[
{
"amc_code": "AXISMUTUALFUND_MF",
"sch_code": "AXIOGP-GR",
"client_code": "H30350",
"bank_ref_no": "671297212",
"trans_mode": "D",
"dp_txn_mode": "C",
"start_date": "10/08/2023",
"frequency_type": "MONTHLY",
"frequency_allowed": "1",
"installment_amount": "3000",
"status": "1",
"member_code": "4079",
"folio_no": " ",
"sip_remarks": " ",
"installment_no": "12",
"convenience_fee": "10",
"xsip_mandate_id": "12",
"sub_broker_code": " ",
"euin_number": "E399871",
"euin_declaration": "Y",
"dpc_flag": "Y",
"first_order_today": "N",
"isip_mandate": " ",
"sub_broker_arn": " ",
"end_date": " ",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]",
"filler_1": " ",
"filler_2": " ",
"filler_3": " ",
Version 1.7 Page 20
NSEIL – Mutual Fund Service System Protocol for Non-NEAT Front End
Type : Post
1) Mandatory
Refer
2) Maximum 50
reg_data Mandatory List of Object Following
Orders allowed in
table
single request
MANDAT
ORY/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDAT TYPE
ORY
must be be available in logged in
member with active status and
client_code Mandatory VARCHAR 10
depository status must be active
in case of demat transaction
req_type Mandatory VARCHAR 4 ‘SIP’ OR ‘XSIP’
Register Topup on (X)SIP
Registration Number.
sip_reg_no Mandatory VARCHAR 15
Must not be TOP UP SIP/XSIP
Registration no.
installment_amo Existing (X)SIP installment
Mandatory DECIMAL 12,2
unt Amount.
topup_frequenc Values : ANNUALLY
Mandatory VARCHAR 20
y Only annually alllowed
Topup amount That is added for
each topup_frequency duration.
topup_amount Mandatory DECIMAL 12,2 Max. Topup Amount must be
between MIN and MAX allowed
instalment amount.
Format DD/MM/YYYY.
Only future date allowed.
Day of date must be same as
start_date Mandatory VARCHAR 10
base SIP.
Can not be smaller than BASE
SIP Start Date
end_date Mandatory VARCHAR 10 Format : DD/MM/YYYY
{
"reg_data": [
{
"client_code": "K0281",
"req_type": "SIP",
"sip_reg_no": 202412021000001,
"installment_amount": 1000,
"topup_frequency": "ANNUALLY",
"topup_amount": 500,
"start_date": "05/12/2024",
"end_date": "05/12/2025",
"internal_ref_no": "",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]"
}
]
}
{
"reg_data": [
{
"client_code": "K0281",
"req_type": "SIP",
"sip_reg_no": 202412021000001,
"installment_amount": 1000,
"topup_frequency": "ANNUALLY",
"topup_amount": 500,
"start_date": "05/12/2024",
"end_date": "05/12/2025",
"internal_ref_no": "",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]",
"reg_id": "123456",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
reg_data Mandatory List of Object 50 Orders
table
allowed in
single
request
MANDAT
ORY/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDAT TYPE
ORY
amc_code Mandatory VARCHAR 50 AMC code of given scheme
sch_code Mandatory VARCHAR 20 Scheme code for XSIP
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
internal_ref_no Optional VARCHAR 20
1. Must be D or P2. Must match
with sip transaction mode3. client
trans_mode Mandatory VARCHAR 20
depository is PHYSICAL then
DEMAT not allowed
dp_txn_mode Mandatory VARCHAR 1 Values : C = CDSL Demat, N =
NSDL Demat, P = Physical
For limited membership if Client
Tax Status is Minor or NRI then
its AOF status must be verified.
For physical each holders PAN
must have AOF image is either
uploaded or Accepted by RTA
For Physical if FATCA check is
required by RTA for given
scheme then Check FATCA of
each holders should be either
uploaded or Should not be
Rejected.
Format DD/MM/YYYY.
Past date is not allowed.
start_date Mandatory VARCHAR 10
Day of date must be within
allowed dates for SIP.
Values :
WEEKLY/ MONTHLY/
QUARTERLY/
frequency_type Mandatory VARCHAR 20 SEMI-ANNUALLY /ANNUALLY/
DAILY
Must be allowed for given
scheme code.
frequency_allow
Mandatory VARCHAR 1 Value Must be 1. 1=Rolling.
ed
Amount for SIP
Must be within minimum and
installment_amo maximum amount allowed for
Mandatory DECIMAL 12,2
unt given scheme.
Must be a multiplier of given
scheme.
Values : 1=Active, 0=Inactive
status Mandatory NUMBER 1
Must be 1
member_code Mandatory VARCHAR 20
folio_no Optional VARCHAR 15 existing folio no if any
sip_remarks Optional VARCHAR 200
Mandatory in case of frequency
other than DAILY.
Conditiona Must be blank in case of DAILY.
installment_no NUMBER
l Must be between MIN and MAX
instalment no allowed for given
scheme.
Clients mandate number.
sip_mandate_id Optional NUMBER
Must be approved mandate.
sub_broker_cod
Optional VARCHAR 15
e
E+6 Numberic
Mandatory if EUIN Declaration is
Conditiona
euin_number VARCHAR 7 Y
l
EUIN
should start with E.
euin_declaration Mandatory VARCHAR 1 Values : Y, N.
dpc_flag Mandatory VARCHAR 1 Values : Y, N. It should be Y.
Values : Y, N.
first_order_toda
Mandatory VARCHAR 1 If Y then first order will be
y
generated on Current date.
primary_holder_
Optional VARCHAR 10
mobile
primary_holder_
Optional VARCHAR 50
email
filler_1 Optional VARCHAR Keep it blank
filler_2 Optional VARCHAR Keep it blank
filler_3 Optional VARCHAR Keep it blank
filler_4 Optional VARCHAR Keep it blank
filler_5 Optional VARCHAR Keep it blank
Should be blank.
reg_id Optional NUMBER 15 Unique Exchange SIP
Registration No. in API response
Should be blank.
Values :
reg_status Optional VARCHAR 15
REG_SUCCESS,REG_FAILED.
in API response
reg_remark Optional VARCHAR 200 Should be blank.
{
"reg_data": [
{
"amc_code": "AXISMUTUALFUND_MF",
"sch_code": "AXIOGP-GR",
"client_code": "H30350",
"internal_ref_no": "671297212",
"trans_mode": "D",
"dp_txn_mode": "C",
"start_date": "10/08/2023",
"frequency_type": "MONTHLY",
"frequency_allowed": "1",
"installment_amount": "3000",
"status": "1",
"member_code": "4079",
"folio_no": "",
"sip_remarks": "",
"installment_no": "12",
"sip_mandate_id": "12",
"sub_broker_code": "",
"euin_number": "E399871",
"euin_declaration": "Y",
"dpc_flag": "Y",
"first_order_today": "N",
"sub_broker_arn": "",
Version 1.7 Page 27
NSEIL – Mutual Fund Service System Protocol for Non-NEAT Front End
"end_date": "",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]",
"filler_1": "",
"filler_2": "",
"filler_3": "",
"filler_4": "",
"filler_5": ""
}
]
}
{
"reg_data":
[
{
"amc_code": "AXISMUTUALFUND_MF",
"sch_code": "AXIOGP-GR",
"client_code": "H30350",
"internal_ref_no": "671297212",
"trans_mode": "D",
"dp_txn_mode": "C",
"start_date": "10/08/2023",
"frequency_type": "MONTHLY",
"frequency_allowed": "1",
"installment_amount": "3000",
"status": "1",
"member_code": "4079",
"folio_no": "",
"sip_remarks": "",
"installment_no": "12",
"sip_mandate_id": "12",
"sub_broker_code": "",
"euin_number": "E399871",
"euin_declaration": "Y",
"dpc_flag": "Y",
"first_order_today": "N",
"sub_broker_arn": "",
"end_date": "",
"primary_holder_mobile": "9574898779",
"primary_holder_email": "[email protected]",
"filler_1": "",
"filler_2": "",
"filler_3": "",
"filler_4": "",
"filler_5": "",
"reg_id": "202308081000002",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
Type : Post
1)
Mandatory
2) Maximum
Refer Following
reg_data Mandatory List of Object 50 Orders
table
allowed in
single
request
MANDATOR
Y/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDATOR TYPE
Y
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
from_scheme_
Mandatory VARCHAR 20 Switch out scheme code
code
to_scheme_co
Mandatory VARCHAR 20 Switch in scheme code
de
Values : FRESH/ADDITIONAL
buy_sell_type Mandatory VARCHAR 10 Value should not be other than
FRESH/ADDITIONAL
Values : P = Physical, D = Demat
For limited membership if Client
Tax Status is Minor or NRI then
its AOF status must be verified.
For physical each holders PAN
must have AOF image is either
transaction_mo
Mandatory VARCHAR 1 uploaded or Accepted by RTA
de
For Physical if FATCA check is
required by RTA for given
scheme then Check FATCA of
each holders should be either
uploaded or Should not be
Rejected.
n
remarks Optional VARCHAR 200
"reg_data":
[
{
"client_code": "H30350",
"from_scheme_code": "PSAD-DR",
"to_scheme_code": "PSAG-GR",
"buy_sell_type": "Additional",
"transaction_mode": "C",
"folio_no": " ",
"internal_ref_number": "STP374698",
"start_date": "28/08/2023",
"frequency_type": "Monthly",
"no_of_transfers": "12",
"to_date": "",
"installment_amount": "",
"installment_units": "10",
"first_order_today": "Y",
"sub_broker_code": "24542",
"euin_declaration": "Y",
"euin_number": "E123456",
"remarks": "",
"sub_broker_arn_code": "",
"mobile": "9892837654",
"email": "[email protected]"
}
]
}
{
"reg_data":
[
{
"client_code": "H30350",
"from_scheme_code": "PSAD-DR",
"to_scheme_code": "PSAG-GR",
"buy_sell_type": "Additional",
"transaction_mode": "C",
"folio_no": " ",
"internal_ref_number": "STP374698",
"start_date": "28/08/2023",
"frequency_type": "Monthly",
"no_of_transfers": "12",
"to_date": "",
"installment_amount": "",
"installment_units": "10",
"first_order_today": "Y",
"sub_broker_code": "24542",
"euin_declaration": "Y",
"euin_number": "E123456",
"remarks": "",
"sub_broker_arn_code": "",
"mobile": "9892837654",
"email": "[email protected]",
"reg_id": "202308081000003",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
reg_data Mandatory List of Object 50 Orders
table
allowed in
single
request
MANDATOR
Y/ NON FIELD
FIELD NAME SIZE DESCRIPTION
MANDATOR TYPE
Y
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
scheme_code Mandatory VARCHAR 20 scheme code for SWP
Values : P = Physical, D =
Demat
For limited membership if Client
Tax Status is Minor or NRI then
its AOF status must be verified.
For physical each holders PAN
must have AOF image is either
trans_mode Mandatory VARCHAR 1
uploaded or Accepted by RTA
For Physical if FATCA check is
required by RTA for given
scheme then Check FATCA of
each holders should be either
uploaded or Should not be
Rejected.
Mandatory in case of Physical
folio_no Conditional VARCHAR 15
transaction mode
internal_ref_n
Optional VARCHAR 10
o
start_date Mandatory VARCHAR 10 Format DD/MM/YYYY.
{
"reg_data":
[
{
"client_code": "K102",
"scheme_code": "BS41A-DP",
"trans_mode": "D",
"folio_no": "9105208524",
"internal_ref_no": "SWP111112",
"start_date": "28/08/2023",
"no_of_withdrawals": "12",
"frequency_type": "Monthly",
"installmenamount": "5000",
"installment_units": "100",
"first_order_today": "N",
"sub_broker_code": "1461",
"euin_declaration": "Y",
"euin_number": "E213200",
"remarks": "",
"sub_broker_arn": "",
"mobile": "9909011973",
"email": "[email protected]",
"account_no": "0226564545"
}
]
}
{
"reg_data":
[
{
"client_code": "K102",
"scheme_code": "BS41A-DP",
"trans_mode": "D",
"folio_no": "9105208524",
"internal_ref_no": "SWP111112",
"start_date": "28/08/2023",
"no_of_withdrawals": "12",
"frequency_type": "Monthly",
"installmenamount": "5000",
"installment_units": "100",
"first_order_today": "N",
"sub_broker_code": "1461",
"euin_declaration": "Y",
"euin_number": "E213200",
"remarks": "",
"sub_broker_arn": "",
"mobile": "9909011973",
"email": "[email protected]",
"account_no": "0226564545",
"reg_id": "202308081000004",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
can_data Mandatory List of Object 50 Orders
table
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
order_no Mandatory VARCHAR 12 Order no. To be cancelled
remarks Mandatory VARCHAR 500 Order cancellation remarks
Should be blank.
Values : CAN FAILED
can_status Optional VARCHAR 15
/CAN SUCCESS in API
response.
Should be blank.
can_remark Optional VARCHAR 255 Cancellation remarks in API
response.
{
"can_data":
[
{
"client_code": "4100030",
"order_no": "433120000008",
"remarks": "switch cancel 433110000018"
}
]
}
{
"reg_data":
[
{
"client_code": "4100030",
"order_no": "433120000008",
"remarks": "SWITCH CANCEL 433110000018",
"can_status": "CAN FAILED",
"can_remark": "CLIENT CODE : 4100030 does not exist."
}
]
}
Type : Post
1) Mandatory
List of Refer 2) Maximum 50
reg_details Mandatory
Object Following table Records allowed in
single request
MANDATORY/
SR FIELD
FIELD NAME SIZE NON REMARKS
NO TYPE
MANDATORY
VARCHA
1 client_code 10 MANDATORY
R
primary_holder_first_na VARCHA
2 70 MANDATORY
me R
primary_holder_middle_ VARCHA
3 MANDATORY
name R
primary_holder_last_na VARCHA
4
me R
VARCHA
5 tax_status 2 MANDATORY REFER TAX STATUS
R
MANDATORY FOR
CONDITIONA INDIVIDUAL AND
VARCHA
6 gender 1 L MINOR
R
MANDATORY CLIENTS
M/F/O/T
primary_holder_dob_inc
7 DATE 10 MANDATORY DD/MM/YYYY
orporation
VARCHA REFER OCCUPATION
8 occupation_code 2 MANDATORY
R CODE
VARCHA REFER
9 holding_nature 2 MANDATORY
R HOLDING(SI/JO/AS)
CONDITIONA MANDATORY IF
second_holder_first_na VARCHA
10 70 L MODE OF HOLDING
me R
MANDATORY JO/AS
CONDITIONA MANDATORY IF
second_holder_middle_ VARCHA
11 L MODE OF HOLDING
name R
MANDATORY JO/AS
CONDITIONA MANDATORY IF
second_holder_last_na VARCHA
12 L MODE OF HOLDING
me R
MANDATORY JO/AS
VARCHA
13 third_holder_first_name 70 OPTIONAL
R
third_holder_middle_na VARCHA
14 OPTIONAL
me R
MANDATORY IF
CONDITIONA
VARCHA THIRD HOLDER
15 third_holder_last_name L
R FIRST NAME
MANDATORY
ENTERED
MANDATORY IF
CONDITIONA
SECOND HOLDER
16 second_holder_dob DATE 10 L
NAME MENTIONED
MANDATORY
DD/MM/YYYY
MANDATORY IF
THIRD HOLDER
CONDITIONA
NAME
17 third_holder_dob DATE 10 L
MENTIONED
MANDATORY
DD/MM/YYYY
CONDITIONA
VARCHA MANDATORY FOR
18 guardian_first_name 120 L
R MINOR CLIENTS
MANDATORY
CONDITIONA
VARCHA MANDATORY FOR
19 guardian_middle_name L
R MINOR CLIENTS
MANDATORY
CONDITIONA
VARCHA MANDATORY FOR
20 guardian_last_name L
R MINOR CLIENTS
MANDATORY
MANDATORY FOR
21 guardian_dob DATE 10 OPTIONAL MINOR CLIENTS
DD/MM/YYYY
'Y'' OR ''N'' IS
CONDITIONA
primary_holder_pan_ex VARCHA ALLOWED FOR
22 1 L
empt R PRIMARY HOLDER
MANDATORY
PAN EXEMPT.
ONLY ''Y'' OR ''N'' IS
CONDITIONA
second_holder_pan_exe VARCHA ALLOWED FOR
23 1 L
mpt R SECOND HOLDER
MANDATORY
PAN EXEMPT.'
ONLY ''Y'' OR ''N'' IS
CONDITIONA
third_holder_pan_exem VARCHA ALLOWED FOR
24 1 L
pt R GUARDIAN HOLDER
MANDATORY
PAN EXEMPT.'
25 guardian_pan_exempt VARCHA 1 CONDITIONA ONLY ''Y'' OR ''N'' IS
ALLOWED FOR
L
R GUARDIAN HOLDER
MANDATORY
PAN EXEMPT.'
MANDATORY IF
PRIMARY HOLDER
CONDITIONA
VARCHA PAN
26 primary_holder_pan 10 L
R EXEMPT FLAG N.
MANDATORY
CLIENT MASTER
VALIDATION
MANDATORY IF
SECONDARY
CONDITIONA
VARCHA HOLDER PAN
27 second_holder_pan 10 L
R EXEMPT FLAG N.
MANDATORY
CLIENT MASTER
VALIDATION
MANDATORY IF
SECONDARY
CONDITIONA HOLDER PAN
VARCHA
28 third_holder_pan 10 L EXEMPT FLAG N.
R
MANDATORY CLIENT MASTER
VALIDATION
MANDATORY IF
GUARDIAN PAN
CONDITIONA
VARCHA EXEMPT
29 guardian_pan 10 L
R FLAG N.
MANDATORY
CLIENT MASTER
VALIDATION
MANDATORY IF
PRIMARY HOLDER
CONDITIONA
primary_holder_exempt VARCHA PAN
30 2 L
_category R EXEMPT FLAG Y.
MANDATORY
REFER PAN EXEMPT
CATEGORY
MANDATORY IF
SECOND HOLDER
CONDITIONA
second_holder_exempt_ VARCHA PAN
31 2 L
category R EXEMPT FLAG Y.
MANDATORY
REFER PAN EXEMPT
CATEGORY
MANDATORY IF
CONDITIONA THIRD HOLDER PAN
third_holder_exempt_ca VARCHA
32 2 L EXEMPT FLAG Y.
tegory R
MANDATORY REFER PAN EXEMPT
CATEGORY
MANDATORY IF
CONDITIONA GUARDIAN PAN
guardian_exempt_categ VARCHA
33 2 L EXEMPT FLAG Y.
ory R
MANDATORY REFER PAN EXEMPT
CATEGORY
VARCHA D/P , D=Demat,
34 client_type 1 MANDATORY
R P=Physical
VARCHA
44 micr_no_1 9 OPTIONAL
R
CONDITIONA
VARCHA
45 ifsc_code_1 11 L
R
MANDATORY
CONDITIONA
VARCHA
46 default_bank_flag_1 1 L Y/N
R
MANDATORY
ONLY ''SB'', ''CB'',''NE''
OR ''NO'' VALUES
VARCHA ARE ALLOWED FOR
47 account_type_2 2 OPTIONAL
R ACCOUNT TYPE 2.
REFER ACCOUNT
TYPE
CONDITIONA MANDATORY IF
VARCHA
48 account_no_2 40 L CLIENT ACC TYPE 2
R
MANDATORY IS AVAILABLE
MANDATORY IF
VARCHA CLIENT ACC TYPE 2
49 micr_no_2 9 OPTIONAL
R IS AVAILABLE AND
IFSC NOT AVAILABLE
MANDATORY IF
CONDITIONA
VARCHA CLIENT ACC TYPE 2
50 ifsc_code_2 11 L
R IS AVAILABLE AND
MANDATORY
MICR NOT AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
51 default_bank_flag_2 1 L CLIENT ACC TYPE 2
R
MANDATORY IS AVAILABLE (Y/N)
VARCHA REFER ACCOUNT
52 account_type_3 2 OPTIONAL
R TYPE
CONDITIONA MANDATORY IF
VARCHA
53 account_no_3 40 L CLIENT ACC TYPE 3
R
MANDATORY IS AVAILABLE
MANDATORY IF
VARCHA CLIENT ACC TYPE 3
54 micr_no_3 9 OPTIONAL
R IS AVAILABLE AND
IFSC NOT AVAILABLE
MANDATORY IF
CONDITIONA
VARCHA CLIENT ACC TYPE 3
55 ifsc_code_3 11 L
R IS AVAILABLE AND
MANDATORY
MICR NOT AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
56 default_bank_flag_3 1 L CLIENT ACC TYPE 3
R
MANDATORY IS AVAILABLE (Y/N)
VARCHA REFER ACCOUNT
57 account_type_4 2 OPTIONAL
R TYPE
CONDITIONA MANDATORY IF
VARCHA
58 account_no_4 40 L CLIENT ACC TYPE 4
R
MANDATORY IS AVAILABLE
MANDATORY IF
VARCHA CLIENT ACC TYPE 4
59 micr_no_4 9 OPTIONAL
R IS AVAILABLE AND
IFSC NOT AVAILABLE
MANDATORY IF
CONDITIONA
VARCHA CLIENT ACC TYPE 4
60 ifsc_code_4 11 L
R IS AVAILABLE AND
MANDATORY
MICR NOT AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
61 default_bank_flag_4 1 L CLIENT ACC TYPE 4
R
MANDATORY IS AVAILABLE (Y/N)
VARCHA REFER ACCOUNT
62 account_type_5 2 OPTIONAL
R TYPE
MANDATORY IF
CONDITIONA
CLIENT ACC TYPE 5
VARCHA L
63 account_no_5 40 IS
R MANDATORY
AVAILABLE
MANDATORY IF
CONDITIONA CLIENT ACC TYPE 5
VARCHA L IS
65 ifsc_code_5 11
R MANDATORY AVAILABLE AND MICR
NOT AVAILABLE
MANDATORY IF
CONDITIONA CLIENT ACC TYPE 5
VARCHA
66 default_bank_flag_5 1 L IS
R
MANDATORY AVAILABLE (Y/N)
SIZE OF RESIDENCE
PHONE FOR INDIA
VARCHA SHOULD BE
76 resi_phone 15 OPTIONAL
R BETWEEN 1 TO 15.'
NOT MANDATORY
FOR NRI
77 resi_fax VARCHA 15 OPTIONAL SIZE OF RESIDENCE
R FAX FOR INDIA
SHOULD BE
BETWEEN 1 TO 15.
NOT MANDATORY
FOR NRI
SIZE OF OFFICE
PHONE FOR INDIA
VARCHA SHOULD BE
78 office_phone 15 OPTIONAL
R BETWEEN 1 TO 15.
NOT MANDATORY
FOR NRI
SIZE OF OFFICE FAX
FOR INDIA SHOULD
VARCHA BE BETWEEN 1 TO
79 office_fax 15 OPTIONAL
R 15.
NOT MANDATORY
FOR NRI
MAXIMUM LENGTH
VARCHA
80 email 50 MANDATORY ALLOWED FOR
R
EMAIL IS 50
P-PHYSICAL/E-
81 communication_mode CHAR 1 MANDATORY
EMAIL/M-MOBILE
CONDITIONA MANDATORY FOR
VARCHA L NRI, EXCEPT FOR
82 foreign_address_1 40
R MANDATORY SEAFARER. REFER
TAX STATUS
VARCHA
83 foreign_address_2 40 OPTIONAL
R
VARCHA
84 foreign_address_3 40 OPTIONAL
R
VARCHA
85 foreign_address_city 35 OPTIONAL
R
CONDITIONA
foreign_address_pincod VARCHA L MANDATORY FOR
86 10
e R MANDATORY NRI/NRO
foreign_address_off_ph VARCHA
91 15 OPTIONAL
one R
VARCHA
92 foreign_address_off_fax 15 OPTIONAL
R
CONDITIONA MANDATORY FOR
VARCHA L INDIVIDUAL.
93 indian_mobile_no 10
R MANDATORY OPTIONAL FOR NON
INDIVIDUAL AND NRI.
CONDITIONA
VARCHA
94 nominee_1_name 40 L
R
MANDATORY
CONDITIONA MANDATORY IF
VARCHA 40
95 nominee_1_relationship L CLIENT NOMINEE
R 2
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
96 nominee_1_applicable NUMBER 5,2 L CLIENT NOMINEE
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
97 nominee_1_minor_flag 1 L CLIENT NOMINEE
R
MANDATORY AVAILABLE
MANDATORY IF
CONDITIONA
NOMINEE MINOR
98 nominee_1_dob DATE L
FLAG Y DD/MM/YYYY
MANDATORY
CONDITIONA MANDATORY IF
VARCHA
99 nominee_1_guardian 35 L NOMINEE MINOR
R
MANDATORY FLAG Y
VARCHA
100 nominee_2_name 40 OPTIONAL
R
CONDITIONA MANDATORY IF
VARCHA 40
101 nominee_2_relationship L NOMINEE 2
R 2
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
102 nominee_2_applicable NUMBER 5,2 L NOMINEE 2
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
L NOMINEE 2
103 nominee_2_dob DATE
MANDATORY AVAILABLE
DD/MM/YYYY
CONDITIONA MANDATORY IF
VARCHA
104 nominee_2_minor_flag 1 L NOMINEE 2
R
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
105 nominee_2_guardian 35 L NOMINEE 2
R
MANDATORY AVAILABLE
VARCHA
106 nominee_3_name 40 OPTIONAL
R
107 nominee_3_relationship VARCHA 40 CONDITIONA MANDATORY IF
R 2 L NOMINEE 3
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
108 nominee_3_applicable NUMBER 5,2 L NOMINEE 3
MANDATORY AVAILABLE
MANDATORY IF
CONDITIONA
NOMINEE 3
109 nominee_3_dob DATE L
AVAILABLE
MANDATORY
DD/MM/YYYY
CONDITIONA MANDATORY IF
VARCHA
110 nominee_3_minor_flag 1 L NOMINEE 3
R
MANDATORY AVAILABLE
CONDITIONA MANDATORY IF
VARCHA
111 nominee_3_guardian 35 L NOMINEE 3
R
MANDATORY AVAILABLE
(K/C/B/E) (K - KRA
COMPLIANT C-
CKYC COMPLIANT B-
primary_holder_kyc_typ
112 CHAR 1 MANDATORY BIOMETRIC KYC
e
E- AADHAAR EKYC
PAN)
CONDITIONA MANDATORY IF
primary_holder_ckyc_nu VARCHA
113 14 L PRIMARY HOLDER
mber R
MANDATORY KYC TYPE 'C'
(K/C/B/E) (K - KRA
COMPLIANT C-
second_holder_kyc_typ CKYC COMPLIANT B-
114 CHAR 1 OPTIONAL
e BIOMETRIC KYC
E- AADHAAR EKYC
PAN
CONDITIONA MANDATORY IF
second_holder_ckyc_nu VARCHA
115 14 L SECOND HOLDER
mber R
MANDATORY KYC TYPE 'C'
(K/C/B/E) (K - KRA
COMPLIANT C-
CKYC COMPLIANT B-
116 third_holder_kyc_type CHAR 1 OPTIONAL
BIOMETRIC KYC
E- AADHAAR EKYC
PAN)
CONDITIONA MANDATORY IF
third_holder_ckyc_numb VARCHA
117 14 L THIRD HOLDER KYC
er R
MANDATORY TYPE 'C'
118 guardian_kyc_type CHAR 1 OPTIONAL
CONDITIONA MANDATORY IF
VARCHA
119 guardian_ckyc_number 14 L GUARDIAN KYC
R
MANDATORY TYPE 'C'
CONDITIONA MANDATORY IF
primary_holder_kra_exe VARCHA
120 10 L PRIMARY HOLDER
mpt_ref_no R
MANDATORY PAN EXEMPT
CONDITIONA MANDATORY IF
second_holder_kra_exe VARCHA
121 10 L SECOND HOLDER
mpt_ref_no R
MANDATORY PAN EXEMPT
CONDITIONA MANDATORY IF
third_holder_kra_exemp VARCHA
122 10 L THIRD HOLDER PAN
t_ref_no R
MANDATORY EXEMPT
CONDITIONA
MANDATORY IF
guardian_exempt_ref_n VARCHA L
123 10 GUARDIAN PAN
o R MANDATORY
EXEMPT
MANDATORY FOR
NON INDIVIDUAL
VARCHA
127 lei_no 20 OPTIONAL & HUF FOR ORDERS
R
ABOVE RS.50
CRORES
CONDITIONA DD/MM/YYYY.
128 lei_validity DATE L MANDATORY IF LEI
MANDATORY NO IS GIVEN
VARCHA
129 mobile_declaration_flag 2 OPTIONAL
R
VARCHA
130 email_declaration_flag 2 OPTIONAL
R
131 nomination_opt CHAR 1 OPTIONAL Y/N
W - WET SIGNATURE;
CONDITIONA E - ESIGN;
nomination_authenticati L O - OTP
132 CHAR 1
on MANDATORY AUTHENTICATION
MANDATORY IF
NOMINATION OPT Y
VARCHA SIZE OF NOMINEE 1
133 nominee_1_pan 10 OPTIONAL
R PAN MUST BE 10.'
SIZE OF NOMINEE 1
nominee_1_guardian_p VARCHA
134 10 OPTIONAL GUARDIAN PAN
an R
MUST BE 10.'
VARCHA SIZE OF NOMINEE 2
135 nominee_2_pan 10 OPTIONAL
R PAN MUST BE 10.'
SIZE OF NOMINEE 2
nominee_2_guardian_p VARCHA
136 10 OPTIONAL GUARDIAN PAN
an R
MUST BE 10.
{
"reg_details": [
{
"client_code": "500231",
"primary_holder_first_name": "ASHOKFIRST",
"primary_holder_middle_name": "ASHOKMIDDLE",
"primary_holder_last_name": "ASHOKLAST",
"tax_status": "01",
"gender": "M",
"primary_holder_dob_incorporation": "03-08-1991",
"occupation_code": "01",
"holding_nature": "JO",
"second_holder_first_name": "SECONFIRST",
"second_holder_middle_name": "SECONDMIDDLE",
"second_holder_last_name": "SECONDLAST",
"third_holder_first_name": "THIRDFIRST",
"third_holder_middle_name": "THIRDMIDDLE",
"third_holder_last_name": "THIRDLAST",
"second_holder_dob": "01/01/1995",
"third_holder_dob": "01/01/1996",
"guardian_first_name": "",
"guardian_middle_name": "",
"guardian_last_name": "",
"guardian_dob": "",
"primary_holder_pan_exempt": "N",
"second_holder_pan_exempt": "N",
"third_holder_pan_exempt": "N",
"guardian_pan_exempt": "N",
"primary_holder_pan": "AAAPA1234A",
"second_holder_pan": "BBBPB1234B",
"third_holder_pan": "CCCPC1234C",
"guardian_pan": "",
"primary_holder_exempt_category": "",
"second_holder_exempt_category": "",
"third_holder_exempt_category": "",
"guardian_exempt_category": "",
"client_type": "D",
"pms": "N",
"default_dp": "NSDL",
"cdsl_dpid": "",
"cdslcltid": "",
"cmbp_id": "12345666",
"nsdldpid": "IN123456",
"nsdlcltid": "12345668",
"account_type_1": "CB",
"account_no_1": "1",
"micr_no_1": "",
"ifsc_code_1": "SBIN0000018",
"default_bank_flag_1": "N",
"account_type_2": "SB",
"account_no_2": "22",
"micr_no_2": "",
"ifsc_code_2": "SBIN0000018",
"default_bank_flag_2": "Y",
"account_type_3": "",
"account_no_3": "",
"micr_no_3": "",
"ifsc_code_3": "",
"default_bank_flag_3": "",
"account_type_4": "",
"account_no_4": "",
"micr_no_4": "",
"ifsc_code_4": "",
"default_bank_flag_4": "",
"account_type_5": "",
"account_no_5": "",
"micr_no_5": "",
"ifsc_code_5": "",
"default_bank_flag_5": "",
"cheque_name": "MY CHEQUE NAME",
"div_pay_mode": "01",
"address_1": "ADDRESS_1",
"address_2": "ADDRESS_2",
"address_3": "ADDRESS_3",
"city": "MUMBAI",
"state": "MA",
"pincode": "400008",
"country": "INDIA",
"resi_phone": "123123123",
"resi_fax": "321321321",
"office_phone": "789789789",
"office_fax": "987987987",
"email": "[email protected]",
"communication_mode": "E",
"foreign_address_1": "",
"foreign_address_2": "",
"foreign_address_3": "",
"foreign_address_city": "",
"foreign_address_pincode": "",
"foreign_address_state": "",
"foreign_address_country": "",
"foreign_address_resi_phone": "",
"foreign_address_fax": "",
"foreign_address_off_phone": "",
"foreign_address_off_fax": "",
"indian_mobile_no": "9876543210",
"nominee_1_name": "NOMINEE 1 NAME",
"nominee_1_relationship": "KISHAN M PRAJAPATI MADHI SURAT",
"nominee_1_applicable": "100",
"nominee_1_minor_flag": "N",
"nominee_1_dob": "",
"nominee_1_guardian": "",
"nominee_2_name": "",
"nominee_2_relationship": "",
"nominee_2_applicable": "",
"nominee_2_dob": "",
"nominee_2_minor_flag": "",
"nominee_2_guardian": "",
"nominee_3_name": "",
"nominee_3_relationship": "",
"nominee_3_applicable": "",
"nominee_3_dob": "",
"nominee_3_minor_flag": "",
"nominee_3_guardian": "",
"primary_holder_kyc_type": "C",
"primary_holder_ckyc_number": "1234567891",
"second_holder_kyc_type": "K",
"second_holder_ckyc_number": "",
"third_holder_kyc_type": "",
"third_holder_ckyc_number": "",
"guardian_kyc_type": "",
"guardian_ckyc_number": "",
"primary_holder_kra_exempt_ref_no": "",
"second_holder_kra_exempt_ref_no": "",
"third_holder_kra_exempt_ref_no": "",
"guardian_exempt_ref_no": "",
"aadhaar_updated": "Y",
"mapin_id": "1234567887654320",
"paperless_flag": "Z",
"lei_no": "1234567890abcdpefdsa",
"lei_validity": "20/05/2025",
"mobile_declaration_flag": "SE",
"email_declaration_flag": "SE",
"nomination_opt": "Y",
"nomination_authentication": "O",
"nominee_1_pan": "ASKAP2345AADS",
"nominee_1_guardian_pan": "ASKPP2345A",
"nominee_2_pan": "ASKPP2345A",
"nominee_2_guardian_pan": "ASKPP2345A",
"nominee_3_pan": "ASKPP2345A",
"nominee_3_guardian_pan": "ASKPP2345A",
"second_holder_email": "[email protected]",
"second_holder_email_declaration": "SE",
"second_holder_mobile": "9823456723",
"second_holder_mobile declaration": "{{second_holder_mobile declaration}}",
"third_holder_email": "[email protected]",
"third_holder_email_declaration": "SE",
"third_holder_mobile": "9823456723",
"third_holder_mobile_declaration": "SE",
"reg_id": "",
"reg_status": "",
"reg_remark": "",
"consent_flag": ""
}
]
}
{
"reg_details": [
{
"client_code": "500231",
"primary_holder_first_name": "ASHOKFIRST",
"primary_holder_middle_name": "ASHOKMIDDLE",
"primary_holder_last_name": "ASHOKLAST",
"tax_status": "01",
"gender": "M",
"primary_holder_dob_incorporation": "03-08-1991",
"occupation_code": "01",
"holding_nature": "JO",
"second_holder_first_name": "SECONFIRST",
"second_holder_middle_name": "SECONDMIDDLE",
"second_holder_last_name": "SECONDLAST",
"third_holder_first_name": "THIRDFIRST",
"third_holder_middle_name": "THIRDMIDDLE",
"third_holder_last_name": "THIRDLAST",
"second_holder_dob": "01/01/1995",
"third_holder_dob": "01/01/1996",
"guardian_first_name": " ",
"guardian_middle_name": " ",
"guardian_last_name": " ",
"resi_fax": "321321321",
"office_phone": "789789789",
"office_fax": "987987987",
"email": "[email protected]",
"communication_mode": "E",
"foreign_address_1": " ",
"foreign_address_2": " ",
"foreign_address_3": " ",
"foreign_address_city": " ",
"foreign_address_pincode": " ",
"foreign_address_state": " ",
"foreign_address_country": " ",
"foreign_address_resi_phone": " ",
"foreign_address_fax": " ",
"foreign_address_off_phone": " ",
"foreign_address_off_fax": " ",
"indian_mobile_no": "9876543210",
"nominee_1_name": "NOMINEE 1 NAME",
"nominee_1_relationship": "KISHAN M PRAJAPATI MADHI SURAT",
"nominee_1_applicable": "100",
"nominee_1_minor_flag": "N",
"nominee_1_dob": " ",
"nominee_1_guardian": " ",
"nominee_2_name": " ",
"nominee_2_relationship": " ",
"nominee_2_applicable": " ",
"nominee_2_dob": " ",
"nominee_2_minor_flag": " ",
"nominee_2_guardian": " ",
"nominee_3_name": " ",
"nominee_3_relationship": " ",
"nominee_3_applicable": " ",
"nominee_3_dob": " ",
"nominee_3_minor_flag": " ",
"nominee_3_guardian": " ",
"primary_holder_kyc_type": "C",
"primary_holder_ckyc_number": "1234567891",
"second_holder_kyc_type": "K",
"second_holder_ckyc_number": " ",
"third_holder_kyc_type": " ",
"third_holder_ckyc_number": " ",
"guardian_kyc_type": " ",
"guardian_ckyc_number": " ",
"primary_holder_kra_exempt_ref_no": " ",
"second_holder_kra_exempt_ref_no": " ",
"third_holder_kra_exempt_ref_no": " ",
"guardian_exempt_ref_no": " ",
"aadhaar_updated": "Y",
"mapin_id": "1234567887654320",
"paperless_flag": "Z",
"lei_no": "1234567890ABCDPEFDSA",
"lei_validity": "20/05/2025",
"mobile_declaration_flag": "",
"email_declaration_flag": "",
"nomination_opt": "",
"nomination_authentication": "",
"nomination1_pan": "",
"nomination1_guardian_pan": "",
"nomination2_pan": "",
"nomination2_guardian_pan": "",
"nomination3_pan": "",
"nomination3_guardian_pan": "",
"second_holder_email": "",
"second_holder_email_declaration": "",
"second_holder_mobile": "",
"second_holder_mobile_declaration": "",
"third_holder_email": "",
"third_holder_email_declaration": "",
"third_holder_mobile": "",
"third_holder_mobile_declaration": "",
"consent_flag": " ",
"reg_id": "752789",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
can_data Mandatory List of Object 50 SIPs
table
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
SIP Registration Number To be
sip_reg_no Mandatory VARCHAR 15
cancelled
SIP cancellation remarks
remarks Mandatory VARCHAR 100 Two digit “Error Code” as below
table or 13:(Reason)
Should be blank.
Values : CAN_FAILED
can_status Optional VARCHAR 15
/CAN_SUCCESS in API
response.
Should be blank.
can_remark Optional VARCHAR 255 Cancellation remarks in API
response.
{
"can_data":
[
{
"client_code": "1001",
"sip_reg_no": "1747",
"remarks": "13:(SIP cancel 1747)"
}
]
}
{
"reg_data":
[
{
"client_code": "1001",
"sip_reg_no": "1747",
"remarks": "13:(SIP CANCEL 1747)",
"can_status": "CAN_FAILED",
"can_remark": "Invalid SIP registration number"
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
can_data Mandatory List of Object 50 XSIPs
table
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
XSIP Registration Number To be
xsip_reg_no Mandatory VARCHAR 15
cancelled
DD/MM/YYYY
Daily xsip only. Must be
xsip_cancel Conditional
DATE minimum T+3
_date Mandatory
Working Days from the date
of cancellation initiation.
XSIP cancellation remarks
remarks Mandatory VARCHAR 100 Two digit “Error Code” as below
table or 13:(Reason)
Should be blank.
Values : CAN_FAILED
can_status Optional VARCHAR 15
/CAN_SUCCESS in API
response.
Should be blank.
can_remark Optional VARCHAR 255 Cancellation remarks in API
response.
{
"can_data":
[
{
"client_code": "1001",
"xsip_reg_no": "1747",
"remarks": "13:(SIP cancel 1747)"
}
]
}
{
"reg_data":
[
{
"client_code": "1001",
"xsip_reg_no": "1747",
"remarks": "13:(SIP cancel 1747)",
"can_status": "CAN_FAILED",
"can_remark": "Invalid XSIP registration number"
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following 50 Daily
can_data Mandatory List of Object
table XSIPs
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
XSIP Registration Number To be
xsip_reg_no Mandatory VARCHAR 15
cancelled
DD/MM/YYYY
Daily xsip only. Must be minimum
xsip_cancel_
Mandatory DATE T+3
date
Working Days from the date of
cancellation initiation.
XSIP cancellation remarks
remarks Mandatory VARCHAR 100 Two digit “Error Code” as below
table or 13:(Reason)
Should be blank.
Values : CAN_FAILED
can_status Optional VARCHAR 15
/CAN_SUCCESS in API
response.
Should be blank.
can_remark Optional VARCHAR 255 Cancellation remarks in API
response.
{
"can_data":
[
{
"client_code": "1001",
"xsip_reg_no": "1747",
"xsip_cancel_date": "25/01/2025",
"remarks": "13:(SIP cancel 1747)"
}
]
}
{
"reg_data":
[
{
"client_code": "1001",
"xsip_reg_no": "1747",
"xsip_cancel_date": "25/01/2025",
"remarks": "13:(SIP cancel 1747)",
"can_status": "CAN_FAILED",
"can_remark": "Invalid XSIP registration number"
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
can_data Mandatory List of Object 50 STPs
table
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client should active in system
STP Registration Number To be
stp_reg_no Mandatory VARCHAR 15
cancelled
remarks Mandatory VARCHAR 100 STP cancellation remarks
Should be blank.
Values : CAN_FAILED
can_status Optional VARCHAR 15
/CAN_SUCCESS in API
response.
Should be blank.
can_remark Optional VARCHAR 255 Cancellation remarks in API
response.
{
"can_data":
[
{
"client_code": "1001",
"stp_reg_no": "1747",
"remarks": "STP cancel 1747"
}
]
}
{
"reg_data":
[
{
"client_code": "1001",
"stp_reg_no": "1747",
"remarks": "STP CANCEL 1747",
"can_status": "CAN_FAILED",
"can_remark": "Invalid STP registration number"
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
bank_dtl Mandatory List of Object 50 Records
table
allowed in
single
request
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client Code Mandatory VARCHAR 20 Unique client code (UCC)
Account
Mandatory VARCHAR 2 As per Account Type Master
Type
Account
Mandatory VARCHAR 2 As per Account Type Master
Type
Account No Mandatory VARCHAR 40 Bank account number
MICR No Optional NUMERIC 9 MICR if available
IFSC Code Mandatory VARCHAR 11 Bank ifsc code
{
"bank_dtl": [
{
"client_code": "K0281",
"action_type": "ADD",
"account_type": "SB",
"account_no": "311242065229",
"micr_no": "",
"ifsc_code": "KKBK0000872"
},
{
"client_code": "A0145",
"action_type": "DEL",
"account_type": "CB",
"account_no": "00101229769449",
"micr_no": "",
"ifsc_code": "SBIN0004193"
}
]
}
{
"bank_dtl": [
{
"client_code": "K0281",
"action_type": "ADD",
"account_type": "SB",
"account_no": "311242065229",
"micr_no": "",
"ifsc_code": "KKBK0000872",
"status": "SUCCESS",
"error_remark": ""
},
{
"client_code": "A0145",
"action_type": "DEL",
"account_type": "CB",
"account_no": "00101229769449",
"micr_no": "",
"ifsc_code": "SBIN0004193",
"status": "FAIL",
"error_remark": "bank not found"
}
]
}
Type : Post
1)
Mandatory
2) Maximum
Refer Following
reg_data Mandatory List of Object 50 Records
table
allowed in
single
request
MANDATORY/
FIELD
NON SIZE DESCRIPTION
FIELD NAME TYPE
MANDATORY
Unique client code
client_code Mandatory VARCHAR 10
(UCC)
If Physical Then Either
amount Conditional DECIMAL 15,2 Units Or Amount is
Mandatory
X = Physical/Scan, E/N
mandate_type Mandatory VARCHAR 1
= eNACH
account_no Mandatory VARCHAR 40 Bank account number
As per Account Type
ac_type Mandatory VARCHAR 2
Master (SB/CB/NE/NO)
ifsc_code Mandatory VARCHAR 11 Bank ifsc code
micr_no Optional NUMERIC 9 MICR if available
format DD/MM/YYYY
start_date Mandatory DATE
No past date allowed
end_date Mandatory DATE format DD/MM/YYYY
mmember_mandate
Optional VARCHAR 20
_no
{
"reg_data": [
{
"client_code": "500231",
"amount": "100000",
"mandate_type": "X",
"account_no": "1234567890",
"ac_type": "SB",
"ifsc_code": "SBIN0000018",
"micr_code": "",
"start_date": "07/03/2024",
"end_date": "15/09/2025",
"member_mandate_no": "112233"
}
]
}
{
"reg_data": [
{
"client_code": "500231",
"amount": "100000",
"mandate_type": "X",
"account_no": "1234567890",
"ac_type": "SB",
"ifsc_code": "SBIN0000018",
"micr_code": " ",
"start_date": "07/03/2024",
"end_date": "15/09/2025",
"member_mandate_no": "112233",
"reg_id": "2024030710018",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
MANDATORY/
FIELD
NON SIZE DESCRIPTION
FIELD NAME TYPE
MANDATORY
Unique client code
client_code Mandatory VARCHAR 10
(UCC)
Scan madate
mandate_id Mandatory NUMERIC 15 registration number of
the given UCC
Allowed Values :
image_type Mandatory VARCHAR 4
jpg/jpeg/tif/tiff/pdf
BYTE Byte Array of image.
file_bytes Mandatory
ARRAY Max File size 2MB
{
"client_code":"K0281",
"mandate_id":"751518",
"image_type":"image/tiff",
"file_bytes":[12,5,15,81,109,70,122,90,83,65,50,84,100,72,74,108,89,87,48,61]
}
Type : Post
1)
Mandatory
2) Maximum
utr_details Refer Following
Mandatory List of Object 50 Records
table
allowed in
single
request
MANDATORY/
FIELD
NON SIZE DESCRIPTION
FIELD NAME TYPE
MANDATORY
Unique client code
client_code Mandatory VARCHAR 10
(UCC)
bank_name Mandatory VARCHAR 100 Invester bank name.
{
"utr_details": [
{
"client_code": "K0281",
"bank_name": "Kotak Mahindra bank",
"account_no": "0123456522",
"ifsc": "KKBK0000872",
"utr_no": "150983120614",
"transfer_date": "29/04/2024",
"order_id": "441200000008"
}
]
}
Sample Response Json :
{
"utr_details": [
{
"client_code": "K0281",
"bank_name": "Kotak Mahindra bank",
"account_no": "0123456522",
"ifsc": "KKBK0000872",
"utr_no": "150983120614",
"transfer_date": "29/04/2024",
"order_id": "441200000008",
"status": 100,
"message": ""
}
]
}
status : 100 - success, 101 – failure
Type : Post
MANDATORY/
FIELD
NON SIZE DESCRIPTION
FIELD NAME TYPE
MANDATORY
Exchnage sip
sip_reg_id Mandatory NUMERIC 15
registration no
Umrn of the active
umrn Mandatory VARCHAR 20
mandate.
remark Optional VARCHAR 100
{
"sip_reg_id": 202404291005001,
"umrn": "KBID7010000088990011",
"remark": "request by member"
}
Reports API
URL: https://{{API URL}}/nsemfdesk/api/v2/reports/PROV_ORDERS
URL: https://{{API URL}}/nsemfdesk/api/v2/reports/ORDER_STATUS
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Format :YYYY-MM-DD (Maximum
From Date Mandatory DATE 10
Date range should be 7 days )
Format :YYYY-MM-DD (Maximum
To Date Mandatory DATE 10
Date range should be 7 days )
VALUES : P(Purchase), R
Trans Type Mandatory VARCHAR 3
(Redemption), ALL
VALUES : ALL,NRM, SIP,
Order Type Mandatory VARCHAR 3
XSP,STP
Sub Order VALUES : ALL, NRM,
Mandatory VARCHAR 5
Type SPOR,SWH,STP
{
"from_date": "2023-11-10",
"to_date": "2023-11-16",
"trans_type": "ALL",
"order_type": "ALL",
"sub_order_type": "ALL"
}
"order_time": "02:00:00",
"order_id": "433180000002",
"settlement_id": "2023105",
"client_code": "H30350",
"first_applicant_name": "HIREN AHIR",
"scheme_code": "AXBDDD-DR",
"scheme_name": "AXIS BANKING & PSU DEBT FUND - DAILY DIVIDEND
REINVESTMENT",
"isin": "INF846K01CC8",
"transaction_type": "P",
"amount": "0",
"quantity": "0",
"transaction_mode": "DEMAT",
"DP_Folio_No": "1234567812345678",
"folio_no": "-",
"login_id": "0",
"order_status": "VALID",
"order_remark": "PROVISIONAL ORDER",
"sip_reference_no": " ",
"settlement_type": "T1",
"order_type": "SI",
"sip_registration_no": "1762",
"sip_registration_date": "13/07/2023",
"sub_broker_code": "24542",
"euin_code": "E479425",
"euin_declaration_flag": "Y",
"all_units": "N",
"dpc_flag": "Y",
"order_sub_type": "STP",
"first_order": "N",
"investment_type": "ADDITIONAL",
"member_remark": "-",
"kyc_declaration_flag": "Y",
"min_redemption_flag": "N",
"sub_broker_arn_code": "ARN-256868",
"bank_ref_no": "-",
"account_no": "-",
"mobile_no": "9892837654",
"email": "[email protected]",
"mandate_id": "-",
"second_holder_email": "[email protected]",
"second_holder_mobile": "9909999091",
"third_holder_email": "[email protected]",
"third_holder_mobile": "9909999092"
}
],
"error_remark": ""
}
"member_id": "4079",
"order_date": "14/11/2023",
"order_time": "03:00:00",
"order_id": "433180000005",
"settlement_id": "2023105",
"client_code": "H30350",
"first_applicant_name": "HIREN AHIR",
"scheme_code": "ESARDP-DR-L1",
"scheme_name": "ESSEL ARBITRAGE FUND-REGULAR PLAN NORMAL
DIVIDEND REINVESTMENT",
"isin": "INF959L01EY7",
"transaction_type": "P",
"amount": "200000",
"quantity": "0.000",
"transaction_mode": "DEMAT",
"DP_Folio_No": "1234567812345678",
"folio_no": " ",
"login_id": " ",
"order_status": "INVALID",
"order_remark": "NOT GONE FOR COLLECTION",
"sip_reference_no": "BANKREFNO",
"settlement_type": "L1",
"order_type": "XSP",
"sip_registration_no": "66",
"sip_registration_date": "11/07/2023",
"sub_broker_code": "SUBBRCODE",
"euin_code": "E123456",
"euin_declaration_flag": "Y",
"all_units": "N",
"dpc_flag": "Y",
"order_sub_type": "NRM",
"first_order": "N",
"investment_type": "FRESH",
"member_remark": " ",
"kyc_declaration_flag": "Y",
"min_redemption_flag": "N",
"sub_broker_arn_code": "ARN-1234",
"bank_ref_no": " ",
"account_no": " ",
"mobile_no": "8160677850",
"email": "[email protected]",
"mandate_id": "4",
"second_holder_email": "[email protected]",
"second_holder_mobile": "9909999091",
"third_holder_email": "[email protected]",
"third_holder_mobile": "9909999092"
}
],
"error_remark": ""
}
Type : Post
Request Headers : As per Common Authentication For All APIs
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
From Date Mandatory DATE 10 Format :YYYY-MM-DD
To Date Mandatory DATE 10 Format :YYYY-MM-DD
Client Code Mandatory VARCHAR 20
Exchange mandate registration
Mandate ID Optional VARCHAR 15
number
If mandate id provided then other perameters are optional.
Sample Request Json :
{
"from_date": "2024-01-15",
"to_date": "2024-01-30",
"client_code": "K0281",
"mandate_id":""
}
Sample Response Json :
{
"response_status": "S",
"report_data_total": "1",
"report_data": [
{
"mandateId": "2024012510001",
"clientCode": "K0281",
"clientName": "krushanakant desai",
"memberCode": "70790",
"bankName": "HDFC BANK",
"bankBranch": "KOLKATA - STEPHEN HOUSE BBD BAG",
"amount": "200000",
"registrationDate": "25/01/2024",
"status": "APPROVED",
"umrnNo": "HDFC7010000088990010",
"remarks": " ",
"approvedDate": "27/01/2024",
"bankAccountNumber": "50100101675862",
"mandateCollectionType": "ENACH",
"mandateType": "X",
"dateOfUpload": " ",
"startDate": "25/01/2024",
"endDate": "31/12/2050"
}
],
"error_remark": ""
}
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Type of Products, refer below
productType Mandatory VARCHAR 15
table
productRefId Mandatory VARCHAR 15 For product ID refer below table
{
"productType": "PUR",
"productRefId": "443300100912",
"firstHolderLink": "https://nseinvest.com/mf/51ae3912",
"secondHolderLink": "",
"thirdHolderLink": "",
"errorMessage": ""
}
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
PAN of the Reporting Person -
PAN_RP M Character 10
Investor / Guardian.
PAN Exempt KYC Ref No. of the
PEKRN O Character 10 Investor/Guardian - Mandatory if
PAN is not provided
Name of the Investor / Guardian -
INV_NAME M Character 70
Mandatory
Format: DD/MM/YYYY
DOB O Date Date of Birth/ Date of
Incorporation
FR_NAME O Character 70
SP_NAME O Character 70
Tax Status of the investor - Refer
TAX_STATU Tax Status Master
M Character 3
S Identify Individual/ Non individual
using this Value
This is to indicated data sources
whether it is obtained
DATA_SRC M Character 3
Electronically or through physical
request; Values - 'E' / 'P'
1 - Residential or Business; 2 -
ADDR_TYP
M Character 1 Residential; 3 - Business; 4 -
E
Registered Office; 5 - Unspecified
PO_BIR_IN
M Character 60 Place of Birth/ Incorporation
C
CO_BIR_IN M Character 50 Country of Birth/ Incorporation
C
TAX_RES1 M Character 50 Residence Country
Tax Payer Identification Number /
TPIN1 M Character 20
other Equivalent Number
Type of Identification document to
ID1_TYPE M Character 2 be provided - Refer Identification
Type master
Refer Country/Nationality master
TAX_RES2 O Character 50 enclosed and provide values
accordingly
Tax Payer Identification Number /
TPIN2 O Character 20
other Equivalent Number
Type of Identification document to
ID2_TYPE O Character 2 be provided - Refer Identification
Type master
Refer Country/Nationality master
TAX_RES3 O Character 50 enclosed and provide values
accordingly
Tax Payer Identification Number /
TPIN3 O Character 20
other Equivalent Number
Type of Identification document to
ID3_TYPE O Character 2 be provided - Refer Identification
Type master
Refer Country/Nationality master
TAX_RES4 O Character 50 enclosed and provide values
accordingly
Tax Payer Identification Number /
TPIN4 O Character 20
other Equivalent Number
Type of Identification document to
ID4_TYPE O Character 2 be provided - Refer Identification
Type master
SRCE_WEA Refer Source of wealth Sheet for
M Character 3
LT values to be populated
01 - Foreign Exchange / Money
Changer Services
02 - Gaming / Gambling / Lottery
CORP_SER M for Non- Services [e.g. casinos, betting
Character 2
VS Individuals syndicates]
03 - Money laundering / Pawning
04 – to be blank if the same is not
applicable
App_Income_code as indicated in
INC_SLAB M Character 5 the app_income master to be
provided
Provide the net worth of the
NET_WORT M for Non- investor only if the same is
Numeric 19, 2
H Individuals Corporate Category [INR. In
Lacs]
{
"reg_details": [
{
"pan_rp": "BVYPD3824K",
"pekrn": "avdfert123",
"inv_name": "MoinTest",
"dob": "19/02/2019",
"fr_name": "",
"sp_name": "",
"tax_status": "01",
"data_src": "P",
"addr_type": "5",
"po_bir_inc": "Kanbhai",
"co_bir_inc": "TC",
"tax_res1": "AU",
"tpin1": "MOINAU",
"id1_type": "e1",
"tax_res2": "",
"tpin2": "",
"id2_type": "B",
"tax_res3": "",
"tpin3": "",
"id3_type": "",
"tax_res4": "",
"tpin4": "",
"id4_type": "",
"srce_wealt": "08",
"corp_servs": "01",
"inc_slab": "31",
"net_worth": "12345678901234567",
"nw_date": "01/01/2019",
"pep_flag": "N",
"occ_code": "44",
"occ_type": "O",
"exemp_code": "M",
"ffi_drnfe": "FFI",
"giin_no": "12345",
"spr_entity": "ABC",
"giin_na": "AF",
"giin_exemc": "1",
"nffe_catg": "A",
"act_nfe_sc": "07",
"nature_bus": "MOHAMMADHANIFBHAI GULAMMUSTAFA",
"rel_listed": "TATA",
"exch_name": "O",
"ubo_appl": "N",
"ubo_count": "",
"ubo_name": "",
"ubo_pan": "",
"ubo_nation": "",
"ubo_add1": "",
"ubo_add2": "",
"ubo_add3": "",
"ubo_city": "",
"ubo_pin": "",
"ubo_state": "",
"ubo_cntry": "",
"ubo_add_ty": "",
"ubo_ctr": "",
"ubo_tin": "",
"ubo_id_ty": "",
"ubo_cob": "",
"ubo_dob": "",
"ubo_gender": "",
"ubo_fr_nam": "",
"ubo_occ": "",
"ubo_occ_ty": "",
"ubo_tel": "",
"ubo_mobile": "",
"ubo_code": "",
"ubo_hol_pc": "",
"sdf_flag": "Y",
"ubo_df": "N",
"aadhaar_rp": "",
"new_change": "",
"log_name": "Moin Kapadia",
"filler1": "",
"filler2": ""
}
]
}
"giin_na": "AF",
"giin_exemc": "1",
"nffe_catg": "A",
"act_nfe_sc": "07",
"nature_bus": "MOHAMMADHANIFBHAI GULAMMUSTAFA",
"rel_listed": "TATA",
"exch_name": "O",
"ubo_appl": "N",
"ubo_count": " ",
"ubo_name": " ",
"ubo_pan": " ",
"ubo_nation": " ",
"ubo_add1": " ",
"ubo_add2": " ",
"ubo_add3": " ",
"ubo_city": " ",
"ubo_pin": " ",
"ubo_state": " ",
"ubo_cntry": " ",
"ubo_add_ty": " ",
"ubo_ctr": " ",
"ubo_tin": " ",
"ubo_id_ty": " ",
"ubo_cob": " ",
"ubo_dob": " ",
"ubo_gender": " ",
"ubo_fr_nam": " ",
"ubo_occ": " ",
"ubo_occ_ty": " ",
"ubo_tel": " ",
"ubo_mobile": " ",
"ubo_code": " ",
"ubo_hol_pc": " ",
"sdf_flag": "Y",
"ubo_df": "N",
"aadhaar_rp": " ",
"new_change": " ",
"log_name": "MOIN KAPADIA",
"filler1": " ",
"filler2": " ",
"reg_id": "491531",
"reg_status": "REG_SUCCESS",
"reg_remark": " "
}
]
}
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code Mandatory VARCHAR 10 for given member
Client is active in system
file_name Mandatory VARCHAR 40
document_ty 40 Static Value : IMAGE
Mandatory VARCHAR
pe 3 Values : NRM/RIA
file_data Mandatory VARCHAR Base64 Encoded Image data
{
"message": "Image Uploaded Successfully.",
"status": "100"
}
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
file_name Mandatory VARCHAR 40
PAN Should be of Non-Individual
pan_no Mandatory VARCHAR 10
or HUF
file_data Mandatory VARCHAR Base64 Encoded Image data
{
"message": "Image Uploaded Successfully.",
"status": "100"
}
ELOG Upload
URL: https://{{API URL}}/nsemfdesk/api/v2/registration/eLOG
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Client should present in system
client_code mandatory Character 20 for given member
Client is active in system
primary_hold
mandatory Character 10
er_pan
primary_hold
er_ip_addres mandatory Character 100 ex. 192.168.70.89
s
primary_hold
mandatory Character 20 DD-MON-YY HH:MM:SS
er_log_date
second_hold
non mandatory Character 10
er_pan
second_hold
conditional If, second_holder_pan entered
er_ip_addres Character 100
mandatory then mandatory
s
If, second_holder_pan entered
second_hold conditional
Character 20 then mandatory
er_log_date mandatory
DD-MON-YY HH:MM:SS
third_holder_
non mandatory Character 10
pan
third_holder_ conditional If, third_holder_pan entered then
Character 100
ip_address mandatory mandatory
If, third_holder_pan entered then
third_holder_ conditional
Character 20 mandatory
log_date mandatory
DD-MON-YY HH:MM:SS
{
"client_code":"10016115",
"primary_holder_pan":"ABCPD1234H",
"primary_holder_ip_address":"192.168.71.197",
"primary_holder_log_date":"17-JUL-24 16:10:39",
"second_holder_pan":"BBCPD1234G",
"second_holder_ip_address":"192.168.71.197",
"second_holder_log_date":"17-JUL-24 16:10:39",
"third_holder_pan":"CBCPD1234I",
"third_holder_ip_address":"192.168.71.197",
"third_holder_log_date":"17-JUL-24 16:10:39",
"elog_status":"100",
"elog_status_message":"eLog Uploaded Successfully!!"
}
URL: https://{{API
URL}}/nsemfdesk/api/v2/reports/MEMBER_FUND_ALLOCATION/ORDER_WISE
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
from_date Mandatory DATE 10 Format :DD-MM-YYYY
to_date Mandatory DATE 10 Format : DD-MM-YYYY
Comma separated max 50 Client
client_code Optional CHAR
Code allowed.
pg_bank_ref Comma separated max 50 order
Optional CHAR
no id allowed.
{
"from_date": "10-11-2023",
"to_date": "10-11-2024",
"client_code": "",
"pg_bank_refno":""
}
"settledorders": "",
"allotmentorders": "",
"clientname": "SIMBENE",
"bankname": "HDFC BANK",
"ifsccode": "HDFC0010012",
"remitteraccountno": "343434334",
"taxstatus": "INDIVIDUAL",
"accounttype": "SB",
"refundamount": " ",
"refunddate": " ",
"refundutr": " "
}
],
"error_remark": ""
}
URL: https://{{API
URL}}/nsemfdesk/api/v2/reports/MEMBER_FUND_ALLOCATION/AGE_WISE
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
date Mandatory DATE 10 Format :DD-MM-YYYY
Comma separated max 50 Client
client_code Optional CHAR
Code allowed.
settlement_t As per settlement type master.
Optional CHAR
ype Default : all
amc_code Optional CHAR As per amc Master.
scheme_cod
Optional CHAR As per scheme master
e
{
"date": "30-04-2024",
"client_code": "",
"settlement_type": "all",
"amc_code": "AXISMUTUALFUND_MF",
"scheme_code": ""
}
"orderno": "440080000034",
"settlementno": "2024006",
"settlementtype": "T1",
"mode_funds_initiated_received": " ",
"bank_where_funds_received": " ",
"clientcode": "1009",
"clientname": "BHAVI DESAI",
"schemecode": "AXIOGP-GR",
"schemename": "AXIS CREDIT RISK FUND - GROWTH",
"isin": "INF846K01PO5",
"buyvalue": "4000",
"dp_transaction_mode": "N",
"dp_folio_no": "IN12345612345668",
"foliono": " ",
"entryby": "BHAVI",
"orderstatus": "payment_not_initiated",
"funds_received_status": "C",
"date_of_receipt_of_funds": " ",
"credit_confirmation_on_date": " ",
"referenceno": " ",
"groupid": " ",
"accountno": " ",
"refund_utr_no": " ",
"refund_amount": " ",
"refund_date": " "
}
],
"error_remark": ""
}
Type : Post
MANDATORY/
FIELD
FIELD NON SIZE DESCRIPTION
TYPE
NAME MANDATORY
Order Date, Payout Date, Fund
report_type Mandatory CHAR 20
Transfer Date
from_date Mandatory DATE 10 Format :DD-MM-YYYY
Format : DD-MM-YYYY.
to_date Mandatory DATE 10
30 days gap between two dates
As per amc Master.
amc_code Optional CHAR
Defatul : all
comma separated max 50 order
id allowed.
order_id Optional CHAR
Ignore other filters if this filter
applied.
{
"report_type": "Order Date",
"from_date": "25-04-2024",
"to_date": "25-04-2024",
"amc_code": "",
"order_id": "441160000046,441160000047"
}
Else Blank
"order_id": "440990050029",
"order_date": "08 APR 2024",
"allotted_amount": "50000.0000",
"stt": "0",
"tax": " ",
"funds_payout_date": "09 APR 2024",
"settlement_type": "T1",
"settlement_id": "2024069",
"isin": "INF247L01585",
"funds_payout_status": "P",
"funds_transfer_date": " ",
"account_no": " ",
"neft_number": " ",
"reason_for_rejection1": " ",
"alt_account_no": " ",
"neft_number2": " ",
"reason_for_rejection2": " ",
"final_payout_date_client": " ",
"date_of_amt_refund_to_amc": " ",
"neft_rtgs_details_amt_refunded": " "
}
],
"error_remark": ""
}
Type : Post
{
"order_ids": "",
"from_date": "21-03-2024",
"to_date": "28-03-2024",
"order_type": "ALL",
"sub_order_type": "ALL"
}
"amount": "-",
"qty": "100.000",
"membercode": "04079",
"branchcode": "CORPBRANCH",
"userid": "HIREN",
"foliono": "-",
"rtaschemecode": "RTA_SCHEME",
"rtatransactionno": "440990080024",
"clientcode": "H30350",
"clientname": "SIMBENE",
"beneficiaryid": "1234567812345678",
"allottednav": "10.0000",
"allottedqty": "5000.000",
"allottedamt": "50000.00",
"validflag": "Y",
"remarks": "-",
"stt": "0",
"dpcflag": "Y",
"dptrans": "C",
"ordertype": "NRM",
"ordersubtype": "SWH",
"scheme_name": "ADITYA BIRLA SUN LIFE EQUITY SAVINGS FUND -
DIVPAYOUT",
"load_amount": "0",
"tax_amount": "0"
}
],
"error_remark": ""
}
Type : Post
{
"order_ids": "",
"from_date": "21-03-2024",
"to_date": "28-03-2024",
"order_type": "ALL",
"sub_order_type": "ALL"
}
"emailid": "[email protected]"
},
{
"reportdate": "2024-04-08",
"orderno": "440990080025",
"settlementype": "T3",
"settlementid": "2024069",
"orderdate": "2024-04-08",
"schemecode": "ESARQR-DR",
"isin": "INF959L01FC1",
"amount": "50000.00",
"qty": "0.0000",
"memberid": "04079",
"branchcode": "CORPBRANCH",
"userid": "HIREN",
"foliono": " ",
"rtaschemecode": "ARQD",
"rtatransactionno": "440990080024",
"clientcode": "H30350",
"clientname": "SIMBENE",
"beneficiaryid": "1234567812345678",
"allottednav": "10.0000",
"allottedqty": "5000.0000",
"allotmentamt": "50000.00",
"validflag": "Y",
"remarks": " ",
"stt": "0",
"internalreferenceno": " ",
"ordertype": "NRM",
"sipregistrationno": " ",
"sipregdate": " ",
"subbrokercode": "123456",
"euincode": "E123456",
"euindecl": "Y",
"dpcflag": "Y",
"dptrans": "C",
"ordersubtype": "SWH",
"schemename": "ADITYA BIRLA SUN LIFE EQUITY SAVINGS FUND -
DIVPAYOUT",
"stampduty": "0",
"pgbankrefno": " ",
"bankaccno": " ",
"mobileno": "9726977251",
"emailid": "[email protected]"
}
],
"error_remark": ""
}
2FA Report
URL: https://{{API URL}}/nsemfdesk/api/v2/reports/2fa
Type : Post
{
"from_date": "21-01-2025",
"to_date": "28-01-2025",
“Product_type” : “PUR”
"product_id": "",
"client_code": "K123, P147"
}
Type : Post
{
"from_date": "21-01-2025",
"to_date": "28-01-2025",
"client_code": "K123"
}
"third_holder_name": "",
"guardian_name": "",
"primary_holder_pan": "KRUSH1234N",
"primary_holder_kyc_status": "SUCCESS",
"second_holder_pan": "",
"second_holder_kyc_status": "",
"third_holder_pan": "",
"third_holder_kyc_status": "",
"guardian_pan": "",
"created_by": "12301",
"created_at": "28/12/2024 18:20:00",
"first_holder_fatca_exists": "Y",
"first_holder_aof_exists": "Y",
"first_holder_elog_exists": "N",
"first_holder_email": "[email protected]",
"first_holder_mobile_no": "8154900000",
"first_holder_auth_status": "SUCCESS",
"first_holder_auth_remarks": "",
"first_holder_auth_datetime": "29/12/2024 10:20:00",
"second_holder_fatca_exists": "",
"second_holder_aof_exists": "",
"second_holder_elog_exists": "",
"second_holder_email": "",
"second_holder_mobile_no": "",
"second_holder_auth_status": "",
"second_holder_auth_remarks": "",
"second_holder_auth_datetime": "",
"third_holder_fatca_exists": "",
"third_holder_aof_exists": "",
"third_holder_elog_exists": "",
"third_holder_email": "",
"third_holder_mobile_no": "",
"third_holder_auth_status": "",
"third_holder_auth_remarks": "",
"third_holder_auth_datetime": "",
"demat_status": "ACTIVE",
"default_dp": "CDSL",
"cdsl_dpid": "12064000",
"cdsl_cltid": "12345678",
"cmbp_id": "",
"nsdl_dpid": "",
"nsdl_cltid": "",
"bank1_account_type": "SB",
"bank1_account_no": "1122334455",
"bank1_name": "SBI BANK",
"bank1_ifsc": "SBIN00004193",
"bank1_status": "ACTIVE",
"bank2_account_type": "",
"bank2_account_no": "",
"bank2_name": "",
"bank2_ifsc": "",
"bank2_status": "",
"bank3_account_type": "",
"bank3_account_no": "",
"bank3_name": "",
"bank3_ifsc": "",
"bank3_status": "",
"bank4_account_type": "",
"bank4_account_no": "",
"bank4_name": "",
"bank4_ifsc": "",
"bank4_status": "",
"bank5_account_type": "",
"bank5_account_no": "",
"bank5_name": "",
"bank5_ifsc": "",
"bank5_status": ""
}
],
"error_remark": ""
}
Type : Post
{
"from_date": "21-01-2025",
"to_date": "28-01-2025",
“Product_type” : “PUR”
"product_id": "",
"client_code": "K123, P147"
}
"response_status": "S",
"report_data_total": "1",
Version 1.7 Page 110
NSEIL – Mutual Fund Service System Protocol for Non-NEAT Front End
"report_data": [
{
"type": "",
"product_type": "PUR",
"product_id": "450170000001",
"product_reg_datetime": "28/12/2024 15:30:45",
"member_name": "abc member",
"member_code": "00123",
"client_code": "K123",
"primary_holder_name": "krushnakant",
"mode_of_holding": "SI",
"folio_no": "",
"primary_holder_mobile": "8154900000",
"primary_holder_email": "[email protected]",
"primary_holder_authentication_datetime": "28/12/2024 18:00:00",
"primary_holder_authentication_status": "SUCCESS",
"primary_holder_reply_time": "18:00:00",
"second_holder_name": "",
"second_holder_mobile": "",
"second_holder_email": "",
"second_holder_authentication_datetime": "",
"second_holder_authentication_status": "",
"second_holder_reply_time": "",
"third_holder_name": "",
"third_holder_mobile": "",
"third_holder_email": "",
"third_holder_authentication_datetime": "",
"third_holder_authentication_status": "",
"third_holder_reply_time": "",
"mode_of_payment": "UPI",
"payment_account_no": "1122334455",
"payment_datetime": "28/12/2024 19:20:00",
"payment_status": "SUCCESS",
"payment_reference_number": "UPI123456",
"redemption_payment_account_type": "",
"redemption_payout_account_number": "",
"redemption_payout_amount": "",
"redemption_payout_datetime": "",
"redemption_payment_entity": "",
"settlement_number": "2024250",
"reconciliation_datetime": "28/12/2024 19:21:00",
"reconciliation_status": "SUCCESS",
"order_status": "VALID",
"order_remark": "",
"refund_date": "",
"refund_amount": "",
"refund_account_number": "",
"refund_status": "",
"refund_reference_number": "",
"mandate_id": "",
"mandate_registration_datetime": "",
"mandate_authorization_datetime": "",
"mandate_amount": "",
"mandate_type": "",
"mandate_bank_name": "",
"mandate_bank_account_number": "",
"mandate_ifsc": "",
"mandate_from_date": "",
"mandate_to_date": "",
"mandate_status": "",
"mandate_umrn": "",
}
],
"error_remark": ""
}
Change Log
1.2 (December 2023)
Clients Bank Detail API Added
Reports API added