BSE StARMF v2 API

21 April 2025
v0.9.12

1 Background......................................................................................................................... 9
2 Target Audience.................................................................................................................. 10
3 Change Log......................................................................................................................... 11
4 Glossary of Terms............................................................................................................... 18
5 What's New in v2.................................................................................................................19
6 API and Webhooks..............................................................................................................20
6.1 Guidelines.................................................................................................................. 20
6.1.1 How to start....................................................................................................... 20
6.1.2 Conventions...................................................................................................... 20
6.1.3 Request Header................................................................................................ 21
6.1.4 Response Header............................................................................................. 22
6.1.5 JSON request.................................................................................................... 22
6.1.6 JSON response................................................................................................. 22
6.2 API Listing.................................................................................................................. 24
6.2.1 Login..................................................................................................................24
6.2.1.1 Request.................................................................................................... 24
6.2.1.2 Response................................................................................................. 24
6.2.2 UCC...................................................................................................................25
6.2.2.1 Add a new UCC........................................................................................25
6.2.2.2 Modify UCC.............................................................................................. 27
6.2.2.2.1 Modify UCC Validation Rules...........................................................28
6.2.2.2.2 Modify UCC profile.......................................................................... 29
6.2.2.2.3 Update Bank Details........................................................................ 30
6.2.2.2.4 Register nominees...........................................................................30
6.2.2.2.5 Update FATCA for holder.................................................................31
6.2.2.2.6 Update Communication Address..................................................... 32
6.2.2.2.7 Update Foreign Address..................................................................32
6.2.2.2.8 Update Depository Account details................................................. 32
6.2.2.2.9 Update Person Details.....................................................................33
6.2.2.2.10 Update Contact Details..................................................................33
6.2.2.2.11 Update Identifier Details.................................................................34
6.2.2.2.12 Update Contact Details..................................................................34
6.2.2.2.13 UCC Inactive................................................................................. 35
6.2.2.2.14 Update UCC Holder Object........................................................... 35
6.2.2.2.15 Mandatory documents in update................................................... 36
6.2.2.3 List UCC................................................................................................... 36
6.2.2.4 Get UCC................................................................................................... 38
6.2.3 Order................................................................................................................. 39

BSE StARMF v2 API

1
 6.2.3.1 order_new.................................................................................................39
6.2.3.2 order_update............................................................................................ 42
6.2.3.3 order_cancel.............................................................................................45
6.2.3.4 order_list...................................................................................................46
6.2.3.5 order_get.................................................................................................. 48
6.2.4 SxP (SIP/SWP/STP)......................................................................................... 50
6.2.4.1 sxp_register.............................................................................................. 50
6.2.4.2 sxp_cancel................................................................................................53
6.2.4.3 sxp_topup................................................................................................. 54
6.2.4.4 sxp_set_pause......................................................................................... 55
6.2.4.5 sxp_resume.............................................................................................. 56
6.2.4.6 sxp_list......................................................................................................57
6.2.4.7 sxp_get..................................................................................................... 59
6.2.4.8 sxp_get_history........................................................................................ 61
6.2.5 NFT................................................................................................................... 62
6.2.5.1 Nominee Change......................................................................................63
6.2.5.2 Contact change........................................................................................ 64
6.2.5.3 Bank Account change...............................................................................65
6.2.6 Payment Aggregator......................................................................................... 66
6.2.6.1 Submit Payment Aggregation (MIS) report...............................................66
6.2.6.2 Payment Aggregator Get Details..............................................................68
6.2.7 Scheme List.......................................................................................................69
6.2.8 NAV Master List.................................................................................................73
6.2.9 Get Payment Details......................................................................................... 74
6.2.10 List Payment Details........................................................................................78
6.2.11 2FA Link...........................................................................................................82
6.2.12 Mandate Register............................................................................................ 85
6.2.12.1 Mandate Register................................................................................... 85
6.2.13 Mandate Fetch Details.................................................................................... 88
6.2.13.1 Mandate Fetch Details............................................................................88
6.2.14 Mandate List Fetch..........................................................................................90
6.2.14.1 Mandate List Fetch................................................................................. 90
6.2.15 Mandate Modify...............................................................................................93
6.2.15.1 Mandate Modify...................................................................................... 93
6.2.16 Mandate Cancel.............................................................................................. 95
6.2.16.1 Mandate Cancel..................................................................................... 95
6.2.17 Mandate Link...................................................................................................97
6.2.17.1 Mandate Link.......................................................................................... 97
6.2.18 Mandate Delink............................................................................................... 98
6.2.18.1 Mandate Delink.......................................................................................98
6.2.19 Mandate Status Webhook............................................................................... 99
6.2.19.1 Mandate Status Webhook...................................................................... 99
6.2.20 Request Single Payment BSE PG................................................................ 100

BSE StARMF v2 API

2
 6.2.20.1 Request Single Payment BSE PG........................................................100
6.2.20 Request Send Payment Info BSE PG........................................................... 102
6.2.20.1 Request Send Payment Info BSE PG.................................................. 102
6.2.21 Webhook BSE Payment Gateway.................................................................104
6.2.21.1 Webhook BSE Payment Gateway........................................................104
6.3 Webhook Listing.......................................................................................................104
6.3.1 Webhook......................................................................................................... 104
7 Annexure...........................................................................................................................106
7.1 Environments........................................................................................................... 106
7.2 Masters and Enumerated values..............................................................................107
7.2.1 Country List..................................................................................................... 107
7.2.2 Tax Code......................................................................................................... 107
7.2.3 Holding Nature................................................................................................ 107
7.2.4 Bank Account Types........................................................................................107
7.2.5 Transaction Code............................................................................................ 107
7.2.6 Payment Receipt Modes................................................................................. 107
7.3 Objects..................................................................................................................... 107
7.3.1 Member........................................................................................................... 107
7.3.2 Investor............................................................................................................108
7.3.3 Investor_ucc.................................................................................................... 108
7.3.4 Holder.............................................................................................................. 109
7.3.5 bank_account.................................................................................................. 109
7.3.6 depository........................................................................................................ 110
7.3.7 comm_addr......................................................................................................110
7.3.8 addr..................................................................................................................111
7.3.9 contact............................................................................................................. 111
7.3.10 nomination..................................................................................................... 112
7.3.11 Nominee: guardian.........................................................................................112
7.3.12 PAN holder.....................................................................................................113
7.3.13 person............................................................................................................114
7.3.14 ubo_person....................................................................................................114
7.3.15 identifier......................................................................................................... 114
7.3.16 fatca............................................................................................................... 115
7.3.17 ubo.................................................................................................................116
7.3.18 ubo_detail...................................................................................................... 117
7.3.19 npo.................................................................................................................118
7.3.20 aof..................................................................................................................118
7.3.21 aof_ria............................................................................................................118
7.3.22 tax_residency.................................................................................................118
7.3.23 ucc_list_filter_param......................................................................................118
7.3.24 ucc_status_obj...............................................................................................119
7.3.25 status_count_summary_obj...........................................................................119
7.3.26 ucc_status_holder..........................................................................................119

BSE StARMF v2 API

3
 7.3.27 ucc_status_bank_account.............................................................................120
7.3.28 ucc_status_depository...................................................................................120
7.3.29 ucc_status_aof / ucc_status_aof_ria / ucc_status_elog / ucc_status_elog_ria /
ucc_status_fatca...................................................................................................... 120
7.3.30 ucc_status_pan / ucc_status_nominee_2fa................................................. 121
7.3.31 ucc_status_kyc..............................................................................................121
7.3.32 ucc_status_transaction_ready.......................................................................121
7.3.33 info_order...................................................................................................... 122
7.3.34 mem_details.................................................................................................. 122
7.3.35 depository_acct (order/sxp/mandate)............................................................122
7.3.36 bank_acct (order/sxp/mandate).....................................................................122
7.3.37 mem_mandate_info(mandate)...................................................................... 123
7.3.38 order_list_filter_param...................................................................................123
7.3.39 order_holder.................................................................................................. 124
7.3.40 order_src_info............................................................................................... 124
7.3.41 allotment_details........................................................................................... 125
7.3.42 redempt_details.............................................................................................125
7.3.43 refund_details................................................................................................126
7.3.44 refund_hist.....................................................................................................126
7.3.45 history_obj..................................................................................................... 126
7.3.46 rejection_reason............................................................................................127
7.3.47 info_sxp......................................................................................................... 127
7.3.48 sxp_list_filter_param..................................................................................... 127
7.3.49 sxp_special_product......................................................................................128
7.3.50 mandate_list_filter_param............................................................................. 128
7.3.51 investor_mis.................................................................................................. 129
7.3.52 mis_info......................................................................................................... 129
7.3.53 mis_mem_details.......................................................................................... 129
7.3.54 nft_auth......................................................................................................... 130
7.3.55 nominee_change_info................................................................................... 130
7.3.56 contact_info................................................................................................... 132
7.3.57 bank_change_info......................................................................................... 133
7.3.58 scheme_nfo_date_time_detail...................................................................... 134
7.3.59 nfo_payment_details..................................................................................... 135
7.3.60 scheme_interval_lifecycle............................................................................. 135
7.3.61 scheme_lumpsum......................................................................................... 135
7.3.62 scheme_transaction_allowed_options.......................................................... 136
7.3.63 scheme_transaction_mode_allowed............................................................. 136
7.3.64 scheme_transaction_single_details.............................................................. 137
7.3.65 scheme_transaction_units.............................................................................137
7.3.66 scheme_transaction_amounts...................................................................... 137
7.3.67 scheme_installment_numbers.......................................................................138
7.3.68 scheme_systematic....................................................................................... 138

BSE StARMF v2 API

4
 7.3.69 scheme_transaction_allowed_options.......................................................... 139
7.3.70 scheme_sxp_frequency_detail......................................................................140
7.3.71 scheme_systematic_transaction_detail.........................................................140
7.3.72 webhook_ack................................................................................................ 140
7.3.73 sxp_history_filter_param............................................................................... 140
7.3.74 nav_filter_param............................................................................................141
7.3.75 mandate_filter_param................................................................................... 141
7.3.76 scheme_filter_param.....................................................................................141
7.3.77 nft_response_obj...........................................................................................142
7.4 Enums...................................................................................................................... 143
7.4.1 holding_nature.................................................................................................143
7.4.2 tax_status........................................................................................................ 143
7.4.3 rdmp_idcw_pay_mode (Payment mode for redemptions & IDCW).................147
7.4.4 nomination_auth_mode...................................................................................147
7.4.5 comm_mode....................................................................................................147
7.4.6 onboarding...................................................................................................... 147
7.4.7 holder_rank..................................................................................................... 147
7.4.8 occ_code......................................................................................................... 148
7.4.9 auth_mode...................................................................................................... 148
7.4.10 pan_exempt_category...................................................................................148
7.4.11 kyc_type.........................................................................................................149
7.4.12 bank_acc_type.............................................................................................. 149
7.4.13 bank_acc_owner / account_owner................................................................149
7.4.14 depository_code............................................................................................ 149
7.4.15 depository_code (order/sxp/mandate)...........................................................149
7.4.16 whose_contact_number / whose_email_address......................................... 150
7.4.17 contact_type.................................................................................................. 150
7.4.18 nomination_relation....................................................................................... 150
7.4.19 gender........................................................................................................... 151
7.4.20 identifier_type................................................................................................ 151
7.4.21 Country.......................................................................................................... 163
7.4.22 address_type.................................................................................................164
7.4.23 occ_type........................................................................................................ 164
7.4.24 exemption_code............................................................................................ 164
7.4.25 corporate_service_sector.............................................................................. 164
7.4.26 wealth_source............................................................................................... 165
7.4.27 income_slab.................................................................................................. 165
7.4.28 politically_exposed........................................................................................ 165
7.4.29 data_source...................................................................................................165
7.4.30 ffi_drnfe..........................................................................................................165
7.4.31 is_giin_avail...................................................................................................165
7.4.32 nfe_category..................................................................................................166
7.4.33 nfe_sub_category..........................................................................................166

BSE StARMF v2 API

5
 7.4.34 nature_of_relation......................................................................................... 167
7.4.35 fatca_identifier_type...................................................................................... 167
7.4.36 ubo_category.................................................................................................167
7.4.37 ubo_type_code..............................................................................................167
7.4.38 ubo_addr_type.............................................................................................. 168
7.4.39 ucc_status..................................................................................................... 168
7.4.40 ucc_count_status.......................................................................................... 168
7.4.41 order_type..................................................................................................... 168
7.4.42 order_phys_or_demat................................................................................... 168
7.4.43 order_status.................................................................................................. 168
7.4.44 order_source................................................................................................. 169
7.4.45 order_list_status............................................................................................ 169
7.4.46 mandate_type................................................................................................169
7.4.47 mandate_mode............................................................................................. 169
7.4.48 sxp_freq.........................................................................................................169
7.4.49 sxp_type........................................................................................................ 170
7.4.50 sxp_status..................................................................................................... 170
7.4.51 sxp_cancel_reason....................................................................................... 170
7.4.52 special_products_type...................................................................................170
7.4.53 special_products_goal_type..........................................................................171
7.4.54 paymt_mode..................................................................................................171
7.4.55 nct_type.........................................................................................................171
7.4.56 investor_type................................................................................................. 171
7.4.57 mis_type........................................................................................................ 171
7.4.58 mis_status..................................................................................................... 172
7.4.59 2fa_event.......................................................................................................172
7.4.60 scheme_sub_category type.......................................................................... 172
7.4.61 order_lifecycle_status....................................................................................174
7.4.62 sxp_lifecycle_status...................................................................................... 175
7.4.63 wh_event....................................................................................................... 175
7.4.64 wh_event_type.............................................................................................. 178
7.5 Error Codes.............................................................................................................. 178
7.5.1 Order Error Codes........................................................................................... 190
7.5.2 SxP Error Codes............................................................................................. 193
7.5.3 Mandate Error Codes...................................................................................... 195
8 Examples......................................................................................................................... 197
8.1 ucc............................................................................................................................197
8.1.1 add_ucc...........................................................................................................197
8.1.1.1 Request.................................................................................................. 197
8.1.1.2 Response............................................................................................... 201
8.1.2 update_ucc......................................................................................................201
8.1.2.1 update_ucc............................................................................................. 202
8.1.2.1.1 Request......................................................................................... 202

BSE StARMF v2 API

6
 8.1.2.1.2 Response...................................................................................... 202
8.1.2.2 update_ucc: bank account......................................................................202
8.1.2.2.1 Request......................................................................................... 202
8.1.2.2.2 Response...................................................................................... 203
8.1.2.3 update_ucc: holder object...................................................................... 203
8.1.2.3.1 Request......................................................................................... 203
8.1.2.3.2 Response...................................................................................... 204
8.1.3 list_ucc............................................................................................................ 204
8.1.3.1 Request.................................................................................................. 204
8.1.3.2 Response............................................................................................... 205
8.1.4 get_ucc............................................................................................................ 213
8.1.4.1 Request.................................................................................................. 213
8.1.4.2 Response............................................................................................... 213
8.2 Order........................................................................................................................ 220
8.2.1 order_new....................................................................................................... 220
8.2.1.1 Request.................................................................................................. 220
8.2.1.2 Response............................................................................................... 222
8.2.2 order_update................................................................................................... 222
8.2.2.1 Request.................................................................................................. 222
8.2.2.2 Response............................................................................................... 223
8.2.3 order_cancel....................................................................................................224
8.2.3.1 Request.................................................................................................. 224
8.2.3.2 Response............................................................................................... 224
8.2.4 order_list..........................................................................................................225
8.2.4.1 Request.................................................................................................. 225
8.2.4.2 Response............................................................................................... 225
8.2.5 order_get......................................................................................................... 234
8.2.5.1 Request.................................................................................................. 234
8.2.5.2 Response............................................................................................... 234
8.3 SxP...........................................................................................................................238
8.3.1 sxp_register..................................................................................................... 238
8.3.1.1 Request.................................................................................................. 238
8.3.1.2 Response............................................................................................... 240
8.3.2 sxp_cancel...................................................................................................... 240
8.3.2.1 Request.................................................................................................. 240
8.3.2.2 Response............................................................................................... 240
8.3.3 sxp_topup........................................................................................................240
8.3.3.1 Request.................................................................................................. 241
8.3.3.2 Response............................................................................................... 241
8.3.4 sxp_set_pause................................................................................................ 241
8.3.4.1 Request.................................................................................................. 241
8.3.4.2 Response............................................................................................... 242
8.3.5 sxp_resume..................................................................................................... 242

BSE StARMF v2 API

7
 8.3.5.1 Request.................................................................................................. 242
8.3.5.2 Response............................................................................................... 242
8.3.6 sxp_list............................................................................................................ 242
8.3.6.1 Request.................................................................................................. 242
8.3.6.2 Response............................................................................................... 243
8.3.7 sxp_get............................................................................................................ 245
8.3.7.1 Request.................................................................................................. 245
8.3.7.2 Response............................................................................................... 245
8.3.8 sxp_get_history............................................................................................... 247
8.3.8.1 Request.................................................................................................. 247
8.3.8.2 Response............................................................................................... 247
8.4 NFT.......................................................................................................................... 248
8.4.1 Nominee Change............................................................................................ 248
8.4.1.1 Request.................................................................................................. 248
8.4.1.2 Response............................................................................................... 250
8.4.2 Contact Change.............................................................................................. 250
8.4.2.1 Request.................................................................................................. 250
8.4.2.2 Response............................................................................................... 251
8.4.3 Bank Account Change.....................................................................................251
8.4.3.1 Request.................................................................................................. 251
8.4.3.2 Response............................................................................................... 252
8.5 PA MIS..................................................................................................................... 253
8.5.1 upload_mis...................................................................................................... 253
8.5.1.1 Request.................................................................................................. 253
8.5.1.2 Response............................................................................................... 254
8.6 Mandate................................................................................................................... 254
8.6.1 mandate_register............................................................................................ 254
8.6.1.1 Request.................................................................................................. 254
8.6.1.2 Response............................................................................................... 259
8.6.2 mandate_get................................................................................................... 259
8.6.2.1 Request.................................................................................................. 259
8.6.2.2 Response............................................................................................... 259
8.6.3 mandate_list.................................................................................................... 261
8.6.3.1 Request.................................................................................................. 261
8.6.3.2 Response............................................................................................... 262
8.6.4 mandate_update............................................................................................. 265
8.6.4.1 Request.................................................................................................. 265
8.6.4.2 Response............................................................................................... 269
8.6.5 mandate_cancel.............................................................................................. 269
8.6.5.1 Request.................................................................................................. 269
8.6.5.2 Response............................................................................................... 269
8.6.6 mandate_link................................................................................................... 270
8.6.6.1 Request.................................................................................................. 270

BSE StARMF v2 API

8
 8.6.6.2 Response............................................................................................... 270
8.6.7 mandate_delink............................................................................................... 270
8.6.7.1 Request.................................................................................................. 270
8.6.7.2 Response............................................................................................... 271
8.6.8 get_2fa_link..................................................................................................... 271
8.6.8.1 Request.................................................................................................. 271
8.6.8.2 Response............................................................................................... 272
9 Annexure..........................................................................................................................277
9.1 Error Message Parsing in Angular........................................................................... 277
9.2 Scheme List Sample................................................................................................ 278

BSE StARMF v2 API

9
1 Background
This document is an early preview of the expected APIs within the BSE StARMF v2.

2 Target Audience
Members, AMCs, or any other entities registered with BSE StAR MF Platform who integrate with
the platform through APIs.

BSE StARMF v2 API

10
3 Change Log
Ver. Description Date Prepared Approved By
By

v0.1.0 Preview release 31-Mar-2024

v0.1.4 - Renamed ‘foreign_addr’ block to ‘addr’ 08-Jun-2024

- Updated UBO object
- Added NPO Object

v0.1.5 - Added ucc list 11-Jun-2024

- Added ucc get
- Added aof block
- Added NFT APIs
- Added examples

v0.1.6 Refactored structures of FATCA, UBO and NPO 17-Jun-2024

v0.1.7 - Added APIs for Orders, SxP and Mandates 01-Jul-2024

- Added examples.
- Added Object and Enum Links to API listings

v0.1.8 Field changes in mandate 02-Jul-2024

v0.1.9 - Updated error codes for Orders. 05-Jul-2024

- Added error codes for SxP
- Order specs updated to include nomination object
- webhook for ucc updated
- webhook for order updated
- Payment Aggregator MIS specs updated
- Broker code added in mem_details object

v0.2.0 - Renamed field ‘br_code’ to ‘broker_code’ in 16-Jul-2024

mem_details object
- Added filter params in ‘order_list_filter_param’
- Added filter params in ‘mandate_list_filter_param’
- Added example if elog (8.1.2.6)

v0.2.1 - Updated response of order API 31-Jul-2024

v0.2.2 - Added fields ‘nomination_auth_mode’ and 02-Aug-2024

‘nomination_auth_mode’ to order_new and
order_update API
- Increased Max UCC holders from 3 to 5
- added ‘aof_ria’ object to UCC

v0.2.3 - Added field ‘tax_code’ in UCC 08-Aug-2024

- In the Contact section, ‘country_code’,
‘whose_contact_number’ and
‘whose_email_address’ are marked as conditional
mandatory.​
- In the Nomination section, the field
‘nomination_percent’ is marked as conditional
mandatory.

v0.2.4 - Renamed link name in order_new ucc API 14-Aug-2024

- Added agency_code in PA MIS report
- System generated ID for orders changed from
String(UUID) to numeric(16 digits)

BSE StARMF v2 API

11
 v0.2.5 - changed field name of comm_addr and addr 16-Aug-2024
blocks.
- changed ENUM values of acc_owner
- Added ENUM ‘investor_type’ for FATCA
declaration
- Added Minimum and Maximum length validations
for various fields.
- agency_code in PA MIS report API is made
mandatory

v0.2.6 - Added examples of PA MIS 24-Aug-2024

- ‘bank_account’ in ‘depository’ object is mandatory
- added field ‘man_2fa’ in mandate_register
- Update ‘mandate_type’ ENUM
- Added additional parameter ‘parent_client_code’
and ‘is_multi_ucc’ in add_ucc
- Added filter param ‘parent_client_code’ in
‘ucc_list_filter_param’
- Added additional parameter ‘parent_client_code’
in get_ucc()

v0.2.7 - ‘sxp_update’ API is marked as unavailable 03-Sep-2024

- ‘contact_number’ in contact block is made
conditional mandatory
- added API ‘get_2fa_link()’
- added ‘special_product’ block to sxp_register

v0.2.8 - added ‘2fa_link_event’ enum for API 09-Sep-2024

‘get_2fa_link()’
- added ‘login’ API as already present in the
postman collection
- added field ‘status’ in ‘upload_mis’ API

v0.2.9 - added Enum ‘fatca_identifier_type’ for FATCA 16-Sep-2024

declaration
- added field ‘mis_type’ in ‘upload_mis’ API
- added ‘info’ object for ‘upload_mis’ API
- added example of ‘upload_mis’ API

v0.3.0 - added ‘parent_client_code’ in ‘upload_mis’ API 21-Sep-2024

- special products types ENUMs
- added reg_at_after and reg_at_before to
sxp_list_filter_params
- added ‘bank_log’ to identifier_type
- added ‘fatca_identifier_type’ for list of identifiers
for FATCA
- added ‘get_ucc_status_obj’ API
- added declaration type ‘NA’ to whose_email and
whose_contact declaration for UCC

v0.3.1 - added field ‘is_fresh’ to order_new, order_update 24-Sep-2024

and sxp_register APIs
- fields ‘start’ and ‘length’ in list_ucc API is changed
to non-mandatory
- changed mis_type enum value from NEFT_RZP
to NEFT
- changed paymt_mode enum value from ‘DD’ to
‘IFT’
- ‘occ_code’ enum values updated
- removed duplicate Enum ‘fatca_identifier_type’ for
FATCA declaration
- update example of ‘get_ucc_status_obj’ API
- ‘credit_at’ is made optional in ‘upload_mis’ API

BSE StARMF v2 API

12
 v0.3.2 - Modified ‘special_product_goal_type’ for special 08-Oct-2024
products
- Renamed field ‘mem_ord_ref_id’ to
‘mem_sxp_ref_id’ for sxp_register
- Added ‘special_prod_name’ to
‘sxp_special_product’
- Added ‘holder’ block to order_new, order_sxp and
sxp_register API
- added fields reason_cd and reason_cd_msg to
sxp_cancel API

v0.3.3 - ‘fatca’ object in ‘add_ucc’ is made conditional 17-Oct-2024

mandatory
- added ‘nomination’ block to sxp_register
- added ‘nomination’, ‘holder’ and
‘sxp_special_product’ block to sxp_update
- added mandatory identifiers required in case of
ucc update section 6.2.2.2.12
- added ‘sprod’ and ‘topup’ to sxp_type enums
- ‘target_scheme’ and ‘target_amt’ is marked as
conditional mandatory for ‘sxp_special_product’
object

v0.3.4 - Added scheme_list API 29-Oct-2024

- Updated Webhook specs and example for UCC
- Updated Depository Enums for Orders

v0.3.5 - Added sxp_resume API 06-Nov-2024

- Updated scheme list ‘master_scheme_list’ API’s
request parameters and response example

v0.3.6 - Updated field description, and whether fields are 11-Nov-2024

mandatory for upload_mis API.
- Updated investor block for upload_mis API
- Added ‘UPIR’ and ‘IMPS’ paymt_mode for
upload_mis
- Added ‘parent_client_code’ to order_new()

v0.3.7 - Added ‘parent_client_code’ to sxp_register API 14-Nov-2024

- Added ‘parent_client_code’ to mandate_register
API
- Added ‘umrn_ref’ to upload_mis API
- Added NACH to MIS_TYPE
- Removed BANK_AS_MFD from MIS_TYPE
- Updated ‘payment_ref_id’ to be conditional
mandatory.
- Added CHEQUE to MIS_TYPE
- Renamed UPI_RECUR to UPIR
- Removed IMPS from MIS_TYPE
- Updated investor and parent_client_code fields to
be conditional mandatory

v0.3.8 - Added ‘ENACH’ to MIS_TYPE 25-Nov-2024

- Updated description of ‘tax_residency’ object
- Added ‘webhook_ack’ object with description

BSE StARMF v2 API

13
 v0.9.0 - Removed ‘get_ucc_status’ API. 8-Jan-2025
- Removed ‘DRAFT’ watermark
- changed description of error code ‘1020’
- Removed mandate type ‘i-mandate’
- Removed client_code from investor object
- Replaced ‘ucc’ field with ‘investor’ object in
sxp_register, sxp_update, mandate_register APIs
- Removed ‘sxp_update’ API
- Added filter params to ‘sxp_list’ API
- Updated specifications for ‘get_2fa_link’ API
-Updated all examples
- Updated ‘ucc_status_obj’ API. Moved ‘aof’ and
‘aof_ria’ fields from ‘ucc_status_obj’ to
‘ucc_status_holder’ object
- Added ‘order_lifecycle_status’ and
‘sxp_lifecycle_status’ enums
- added investor block to ‘order_cancel’ API
- added new ‘address_type’
- updated mandatory fields in ‘mem_details' object.
- ‘order_new’ and ‘order_update’ API structure has
been refactored.
- Added ‘sxp_get_history’ API
- Added ‘nav_master_list’ API
- Added Annexure(Section 9.1) section to read
error messages in the Angular Code
- Changed Enum values of ‘order_phys_or_demat’
from capital to small letters
- Added ‘get_payment_detail’ API
- Updated Webhook APIs
- Removed Mandate APIs
- Added Request and Response Structures to all
APIs
- Added examples
- Added ‘list_payment_detail’ API

v0.9.1 - Changed the Request/Response parameters of 13-Jan-2025

NFT
- Added 2FA link event for NFT
- Added Data block to webhook structure for NFT
related change
- Added examples
- Updated examples
- Updated webhook structure
- Removed order_webhook section as it is merged
with webhook section

v0.9.2 - Added/Updated examples section 15-Jan-2025

- Changed field ‘dst_bank_acct’ to ‘dest_bank_acct’
in upload_mis API
- Updated response examples in APIs
- Added objects for order_list and order_get API
response
- Added param ‘type’ to sxp_get API

BSE StARMF v2 API

14
 v0.9.3 - Added validation for ckyc field in ucc 20-Jan-2025
- Updated investor_mis object for upload_mis API
- Updated conditional mandatory description for
investor block
- Updated “list_ucc” APIs’ request attribute “status”
to “ucc_status”
- Changed member_code to member in list_ucc
- The list apis’ length attribute has max number of
10000
- Added status_count_summary_obj to list_ucc
response
- Updated enum values for ‘sxp_type’

v0.9.4 - Order_list - expiresat is removed 23-Jan-2025

- Scheme list - added more attributes to response.
- Investor_ucc added to all the UCC APIs and
replaces the Investor block.
- Updated max length for pms_code
- Field in ucc object changed from ‘identifier’ to
‘identifiers’
- order_list_filter_param added json attribute
order_src_type
- order_list_filter_param removed placed_at
-added filter_param in the scheme_list api
-added kyc_passed and mem_details in the
sxp_register service
- updated json request and response payloads
examples with above changes

v0.9.5 - Error code 561 updated. 07-Feb-2025

- New Error code 1023 added.
- Updated upload_mis, If paymt_mode is NEFT,
RTGS, IMPS, Internal Fund Transfer then this field
is optional.
- Added a new sample request for update_ucc for
holder object
- Updated ubo_detail object, removed the
tax_residency and created a new object
ubo_person, and added the same to the ubo_detail
object.
- In sxp register, bank_acct is optional
- Added modify_ucc validation rules table
- src attribute in order_new is optional, depends on
the scheme selected.
- Updated order error messages for error codes -
1579, 1505, 1507 and 1011

v0.9.6 New External APIs added 18-Feb-2025

v0.9.7 Added payload examples for the new External APIs 21-Feb-2025

BSE StARMF v2 API

15
 v0.9.9 -Added more webhook events for Mandate 17-Mar-2025
-Added order_Id, mandate_Id, sxp_reg_num,
payment_ref_id in webhooks consumer
-Added 2 new error codes for SXP Errors
-Updated description of name attribute of
bank_acct to bank name
-Added proper details for Payment Gateway
External API
- Added PAYMENT GATEWAY to wh_event_type
-Added webhook events for payment gateway
-Made the count_only attribute to optional in
sxp_list
-The cmbp_id is mandatory for NSDL but not for
CDSL. Added in the depository object.
- Added Mandate Error Codes
- Added 2 more records to the Scheme List, more
details added to systematic_transaction_detail,
also added missing properties to Scheme List
Response, added systematic_transaction_detail
- Added two error codes - 1024, 1025
-sxp_register - modified the attribute trxn_date
-order_update - member field is optional.
-Added more attributes to scheme_lumpsum
-Added new object
scheme_transaction_allowed_options
-Added more attributes to scheme_systematic
- count_only is optional for order_list
-start is optional for sxp_list

V0.9.1 - The payment gateway webhook is implemented. 24-Mar-2025

0 - Added mem_ord_ref_id for Order web hook
- Changed the description of the Error Code 1503
to application_error.
- Added mis_type - DIRECT DEBIT
- Removed XSIP and ISIP from sxp_type and
made exch_mandate_id conditional for
sxp_register API
-Added more error codes in SXP
-sxp_register API, holder object is now mandatory
- Added new error code “detail_mismatch” in sxp
error codes table
- Added many new relevant error codes

V0.9.1 -name attribute is optional for the bank_acct object 17-April-202

1 -the extension attribute part of contact object is 5
now conditional
-new conditional attribute fax_no added to contact
object
-Added 3 new wh_event for Mandate
-Added dest_acct block in the Mandate Register
Request
- The sample response object of payment
aggregator get details is updated.
- Corrected the JSON attribute name from
client_code to ucc.
- Removed text “Optional for upload_mis” from
bank_acc Object
- Start is optional in order_list api

BSE StARMF v2 API

16
 V0.9.1 -Request Single Payment BSE PG, following 21-April-202
2 changes: 5
-Changed request JSON attribute from
request_method to requested_method
-Added one more value-payment_info_data
-payment_mode attribute changed to array of
attributes
-Added new response, when requested_method
is payment_info_data

-Added new API Request Send Payment Info BSE

PG
- Removed dest_acct block in the Mandate
Register Request as discussed between Purab and
Mansi

BSE StARMF v2 API

17
4 Glossary of Terms
BSE StARMF Platform (the Platform): BSE StAR MF Platform (the Platform): The BSE
StAR MF platform provides various services for registration of investors (UCC), status
enquiry for various actions, change investor (UCC) profile and order fulfilment for the orders
placed by Members on behalf of the investors.

Stakeholder (Entity): In the context of this document, Stakeholders include entities

registered with the BSE StAR MF Platform for the purpose of integrating through APIs
published by the platform.

API: API provided by the platform, and consumed by other stakeholders.

Webhook: API provided by other stakeholders to which the platform sends status,
notifications and other updates depending on various events. All webhook requests will be
explicitly registered as part of the onboarding process / change request process of the
platform. Stakeholders providing a webhook facility must permit incoming requests from the
specific public IP addresses shared by the platform.

Structure of the Webhook would be determined by BSE StARMF.

IP address whitelisting: All incoming API requests and outgoing webhook requests wrt
other stakeholders will be permitted only on explicitly listed static public IP addresses.

For API requests, a stakeholder can provide one or more static public IP addresses from
which requests will be permitted. For Webhook requests, a stakeholder can provide a valid
hostname or a single static public IP address for a call back.

Members integrating through system integrators / ISVs / Other Service Providers must
ensure that the respective service providers also adopt the v2 API Structure.

ISV: Independent Software Vendor.

BSE StARMF v2 API

18
5 What's New in v2
StARMF v2 has a few significant differences compared to v1.

1.​ All API and Webhooks are REST API only, with JSON request and response
parameters.
2.​ Webhooks are being standardised in v2, to send out notifications as and when state
changes e.g. Order or UCC registration.
3.​ Fixed, positional field structure is replaced with a list of attributes within a JSON.
4.​ In v2, partial attribute updates are possible as far as business requirements are met.
5.​ Nested objects are supported instead of individual attributes e.g. bank account detail
is now a JSON object, instead list of individual attributes.
6.​ APIs handle a list instead of multiple positional attributes e.g. "panholder1",
"panholder2", "panholder3" etc. are now replaced with "panholders" list. Similarly,
"bankaccount1", "bankaccount2", and related attributes are now replaced with
"bankaccounts" as a list of object. This provides a flexibility to support additional
holders or bank accounts in the future without changing structure.
7.​ APIs are refactored and made flexible to avoid similar APIs with minor variations.
8.​ Login is via the generally accepted practice of using Bearer token in the request
header.

Members are encouraged to migrate to v2 APIs, which offer higher flexibility and are backed
by a modern architecture. However, in order to ensure least disruption, v1 APIs will be
supported for backward compatibility till v2 API adoption is complete. v2 also maintains
backward compatibility for enumerated values e.g. tax code. Going forward, all
enhancements will be added to v2 only.

BSE StARMF v2 API

19
6 API and Webhooks

6.1 Guidelines

6.1.1 How to start

1.​ Please connect to our API team for a new User ID and Password to your account,
along with other details like your static public
2.​ Wherever webhook facility is opted by a stakeholder, please also provide webhook
URL, API key and secret and
3.​ Please test your application against a sandbox setup, and then only promote your
application to use the production URL.
4.​ List of various URLs, enumerated constants and list of error codes are published in
the Annexure section.
5.​ An example of request and response is provided below description of each API.

6.1.2 Conventions
Unless otherwise explicitly specified,

1.​ All attribute names in the request and response are ASCII characters only. As of now,
all values are ASCII characters only.
2.​ All APIs support POST method only.
3.​ All APIs, except for authentication requests, must carry a bearer token received from
the authentication API. Every Bearer token has an expiry period, decided and
periodically reviewed by the StARMF platform.
4.​ Each API will have an optional attribute named "partnerid" which represents the ISV.
5.​ All input requests and output responses are JSON only.
6.​ All file contents are Base64 encoded.
7.​ All attribute names are lower-case only.
8.​ All API endpoints, attribute names, API key and secrets are case sensitive.
9.​ Attributes expecting enumerated values are defined in the Annexure.
10.​All error responses will have one or more error codes. Error codes are listed in the
annexure.
11.​All attributes within an object, say "bank" object, are mandatory.
12.​Timestamp representations are strictly in ISO 86011 format only, e.g.
"2024-03-12T15:29:59+0530" or any other acceptable timezone.
13.​Date representations, wherever only date is accepted / stored / returned, are as per
the application's timezone in which business operates. As of now, dates are in IST
timezone only. All business dates are in YYYY-MM-DD format only, e.g.
"2024-03-30".
14.​Those attributes which accept a list of objects as a value will have an upper limit on
the number of elements within a list subject to business requirements e.g. Integer of
banks or Integers of nominees or number of orders in a single API request.

1
https://en.wikipedia.org/wiki/ISO_8601

BSE StARMF v2 API

20
 15.​HTTP response codes should not be examined by the caller to decide success or
failure of the call -- any HTTP code in the range 200 to 299 should be accepted as
success. HTTP protocol response codes are supposed to indicate protocol level and
basic transport level issues -- not application level success or failure.
16.​Attribute types in the request and response has this convention:
a.​ Integer: a +ve integer
b.​ Dec(n): Decimal number up to "n" decimal points
c.​ String: A sequence of characters (may have minimum or maximum or both
limits
d.​ Amount: Decimal number rounded to the nearest two decimal points.
e.​ Date: Business date, YYYY-MM-DD format
f.​ Time: ISO 8601 format, YYYY-MM-DDTHH:MI:SSTZ
g.​ Object: A JSON object. An object could be a nested object.
h.​ Enum: One of the permitted values from the list (subject to further validation).
Enumerated constants are defined within the Annexure.
17.​List APIs support various attributes for paging and other features.
a.​ "start": must be a number, min value as 0. This indicates a position within a
list of records matched as per filter, starting with 0 for a first record from the
list. If "start" is higher than the total number of matched records, then results
will be empty, however the total count of matched records will be provided in
the response.
b.​ "length": must be a number between 1 to 10,000. Number of records to be
fetched starting with "start".
c.​ When the number of records expected to be matched are more "length",
multiple calls are required, with "start" value being incremented in multiples of
"length" for each successive call.
d.​ "count_only": Boolean. If true, it will return only the total number of records
matched, not the matched record details. "start" and "length" are ignored
when "count_only" is provided in the request.

As a part of the workflow, some attributes within API requests may trigger verifications or
manual approvals e.g. PAN number or Bank account details. In such cases, "success"
response of the API merely indicates that the request has been accepted; it is syntactically
correct for processing it asynchronously. Wherever possible, API will provide a reference
ID in the immediate response for checking the status via a separate API for status check.

Wherever StARMF provides facility for webhook integration, and such webhooks are
made available by the stakeholders, StARMF platform will also provide such status via
webhooks.

6.1.3 Request Header

JWT: Other than "login" API, all other requests must carry a valid JWT header as follows:
Authorization: Bearer <token>
e.g.

BSE StARMF v2 API

21
Authorization: Bearer ABCPQR

Trace ID: Every JSON request should contain a trace ID for diagnosis. Trace ID is an
opaque string and hopefully unique in time and space. Whole purpose of trace ID is for
diagnosis and does not have any significance to the application.
X-STARMFv2-Trace-ID: <trace-id>
e.g.
X-STARMFv2-Trace-ID: cfb8ed3e-619f-401c-af6e-0e0a8e9a066d

6.1.4 Response Header

Usual HTTP request headers are sent with every response. Important headers for client
application consuming APIs are "Content-encoding" and "Content-type".

6.1.5 JSON request

Each JSON request has the following format.
{
"data": {

}
}

6.1.6 JSON response

Possible values for "status" attribute in response are "success" and "error". If status is an
error, the data object is empty and an additional "message" object is added to the response.

Success response format is as follows:

{
"status": "success",
"data": {
/* Application-specific data payload goes here. */
},
"messages": [] /* Or optional success message */
}

Error response format is as follows:

{
"status": "error",
"data": {},
"messages": [{
"errcode": "toobig",
"msgcode": 235,
"field": "maxdelay",
"vals": [ "7", "3" ]
}, {

BSE StARMF v2 API

22
 "errcode": "missing",
"msgcode": 45,
"field": "fullname"
}]
}

BSE StARMF v2 API

23
6.2 API Listing

6.2.1 Login

6.2.1.1 Request
POST /api/login

{
"data": {
"username": "....",
"password": "...."
}
}

Attribute M List Type Limit Description and example(s)

username Y N String Username provided by StARMF system

password Y N String Password provided by StARMF system

6.2.1.2 Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"access_token":
“"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ6
M3pkb…”
},
"messages": []
}

where
access_token: is the token to be used in consecutive
requests

messages Y Y object []

Error response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object "data": null

messages Y Y object "messages": [

BSE StARMF v2 API

24
 {
"msgid": 672,
"errcode": "login_failed"
}
]

6.2.2 UCC

6.2.2.1 Add a new UCC

Used first time when a new UCC is expected to be registered. Depending on the agreement,
some of the attributes may trigger a verification workflow.

Request
POST /v2/add_ucc

{
"data": {
"member": { … },
"clientcode": "....",
"holders": [ … ]
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

is_multi_ucc N N Boolean Is multiple combination UCC required

parent_client_c C N String Parent Client Code. Mandatory if is_multi_ucc is true

ode

holding_nature Y N Enum Nature of UCC holding holding_nature

tax_status N N Enum Tax status of the UCC Primary holder. tax_status

tax_code Y N Enum Tax code of the UCC Primary holder. tax_status

rdmp_idcw_pay Y N Enum Payment mode for redemptions & IDCW.

_mode rdmp_idcw_pay_mode (Payment mode for redemptions &
IDCW)

is_client_physic Y N Boolean Is the client opting for Physical mode of Holding type
al

is_client_demat Y N Boolean Is the client opting for Demat mode of Holding type

is_nomination_o Y N Boolean Is the nomination opted for by the client?

pted

nomination_aut C N Enum If nomination is opted, then what is the nomination

h_mode authentication mode? nomination_auth_mode

BSE StARMF v2 API

25
 nomination_app C N Object "identifier" object, with only file is mandatory
roval

comm_mode Y N Enum Opted communication mode comm_mode

onboarding Y N Enum Is UCC onboarding with paper or paperless. onboarding

holder Y Y Object 3 List of holders Holder

comm_addr Y N Object Communication address comm_addr

Mandatory for Tax Code where ‘is resident?’ is ‘Y’

foreign_addr C N Object Foreign address(for non-resident). Refer to object type

‘addr’ addr
Mandatory for Tax Code where ‘is resident?’ is ‘N’

depository C Y Object List of depository accounts (for Demat UCC) (Max 5 as of

30 June 2024) depository
Mandatory if ‘is_client_demat’ is true

bank_account Y Y Object List of bank accounts (Max 5 as of 30 June 2024)

bank_account

fatca C Y Object FATCA declaration fatca. Mandatory if ‘is_physical’ is true

pms_client N N Enum Y/N

pms_code C N String Required if "pms_client" = "Y"; max length is 20

aof C N Object Account Opening Form Object aof. Mandatory if

is_physical is true

aof_ria C N Object Account Opening Form Object aof_ria. Mandatory if

is_physical is true

identifiers Y Y Object Allowed Identifiers:

-​ aof
-​ fatca_form
-​ aof_ria
Refer to identifier

Example: add_ucc

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"client_code": "66510005",
"member_code": "xxxx",
"status": //ucc_status
},
}

BSE StARMF v2 API

26
 messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {
"client_code": "66510005",
"member_code": "xxxx"
}

messages Y Y object Array of messages:

{
{
"msgid": 539,
"errcode": "duplicate_record",
"field": "",
"vals": [
"client code”, “member code”"
]
}
}

In this response, the response here means there exists a

record with the same values i.e. client code and member
code.

6.2.2.2 Modify UCC

One or more attributes for UCC can be modified which are permitted for a modification for
members. Please note that a partial number of updates are feasible, and attributes which are
not provided in the payload will remain unchanged. Relevant and frequent business use
cases are provided within this sub-section e.g.
●​ if you are updating bank account details, holder object (or any of its attributes are
not not required)
●​ If you are updating the holder's email address, then holder.holder_rank is
mandatory, but holder.occ_code, holder.auth_mode etc. are optional if those
are not changed.

The same endpoint can be used to update one or more attributes of UCC. For clarity, this
section provides examples for changing different attributes / object types.

BSE StARMF v2 API

27
6.2.2.2.1 Modify UCC Validation Rules

Section Action Mandatory Fields

Depository Add New Account depository_code, dp_id,

client_id, cmbp_id,
bank_account,
account_owner

Depository Delete Account dp_id, client_id

Depository Update Existing Account depository_code, dp_id,

client_id, bank_account

Depository Add Identifier All fields as per Add UCC

block

Depository Delete Identifier Correct identifier file name

and identifier type

Bank Add New Account ifsc_code, bank_acc_num,

bank_acc_type,
account_owner

Bank Update Existing Account ifsc_code,

bank_account_num

Bank Add Identifier All fields as per Add UCC

block

Bank Delete Identifier Correct identifier file name

and identifier type

Indian/Communication Update Address member_code, client_code

Address

Foreign Address Update Address member_code, client_code

FATCA Update Identifier block required

Holder Update Existing Holder is_pan_exempt, holder_rank

Holder Modify Identifier Previous identifier in delete

block

BSE StARMF v2 API

28
 Holder Contact Update Contact Details country_code, contact_type,
email_address,
whose_email_address

Holder Nomination Update Nomination Details holder_rank, pan_exempt

Holder Person Update Holder Person holder_rank, pan_exempt

6.2.2.2.2 Modify UCC profile

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { ... },
"holder": { … }
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

parent_client_c N N String Parent client code if available

ode

holder Y N Object Refer to investor object. UCC details can be modified for a
registered holder on the platform, or directly within RTA
records as a pass through via the platform. Holder

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"client_code": "xxxx",
"member_code": "yyyy",
"parent_client_code": "",
"status": "APPROVED"
}
}

messages Y Y object []

Sample Failure response

BSE StARMF v2 API

29
 Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 1507,
"errcode": "record_not_found"
}
]

6.2.2.2.3 Update Bank Details

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { … },
"bank_account": {
"add": [
{ … bank_account … }
],
"delete": [
{ … bank_account … }
]
}
}
}

Notes

1.​ Only those bank accounts can be deleted which are not linked with any of the DP accounts submitted
as part of UCC. If any of the bank accounts which are linked with DP account, first update DP
account details.

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor

parent_client_c N N String Parent client code if available

ode

bank_account Y Y Object 5 List of Bank Accounts. bank_account

6.2.2.2.4 Register nominees

Note that the Nominee set should be a complete set of nominees.
This means that the nomination percentage across all nominees(max 3 nominees are
allowed) should add up to 100%

BSE StARMF v2 API

30
Note that this updated nomination information will replace existing nomination information on
confirmation by the client.
POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { ... },
"holder": { [
{ … nomination … },
{
… nomination …
“guardian”:{
… “First_name”: …
}
}

]
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

parent_client_c N N String Parent client code if available

ode

holder Y N Object Refer to investor object. UCC details can be modified for a
registered holder on the platform, or directly within RTA
records as a pass through via the platform. Holder

nomination Y Y Object nomination

6.2.2.2.5 Update FATCA for holder

Note that FATCA(optional UBO and NPO) information has to be a complete set. This means
that whatever information is passed in this block will replace existing declaration.
POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { … },
"holder": { … },
"fatca": {
“ubo”: { … },
“npo”: { … }
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

BSE StARMF v2 API

31
 parent_client_c N N String Parent client code if available
ode

holder Y N Object Refer to investor object. UCC details can be modified for a
registered holder on the platform, or directly within RTA
records as a pass through via the platform. Holder

fatca Y Y Object FATCA Object. fatca

6.2.2.2.6 Update Communication Address

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { … },
"comm_addr": {
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

parent_client_c N N String Parent client code if available

ode

comm_addr Y Y Object Address object. comm_addr

6.2.2.2.7 Update Foreign Address

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { … },
"foreign_addr": {
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor

parent_client_c N N String Parent client code if available

ode

foreign_addr Y Object Address object. addr

6.2.2.2.8 Update Depository Account details

POST /v2/update_ucc

BSE StARMF v2 API

32
 {
"data": {
"member": { … },
"investor": { … },
"depository": {
"add": [
{ … depository_account … }
],
"delete": [
{ … depository_account … }
]
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

parent_client_c N N String Parent client code if available

ode

depository_acco Y Y Object 5 List of Depository Accounts. depository

unt

6.2.2.2.9 Update Person Details

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { ... },
"holder": { [
{ … person … }
]
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor

parent_client_c N N String Parent client code if available

ode

holder Y N Object Holder

person Y Y Object person

6.2.2.2.10 Update Contact Details

POST /v2/update_ucc

BSE StARMF v2 API

33
 "data": {
"member": { … },
"investor": { ... },
"holder": { [
{ … contact … }
]
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

holder Y N Object Holder

parent_client_c N N String Parent client code if available

ode

contact Y Y Object contact

6.2.2.2.11 Update Identifier Details

Identifier block is a part of multiple blocks under UCC.
It is part of “holder”, “Nominee”, “guardian of nominee”, “depository_account”,
“bank_account”

POST /v2/

{
"data": {
"member": { … },
"investor": { ... },
"holder": { [
{ … identifier … }
]
}
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

holder Y N Object Holder

parent_client_c N N String Parent client code if available

ode

identifier Y Y Object identifier

6.2.2.2.12 Update Contact Details

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { ... },
"holder": { [

BSE StARMF v2 API

34
 { … contact … }
],
},
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

holder Y N Object Holder

parent_client_c N N String Parent client code if available

ode

contact Y Y Object contact

6.2.2.2.13 UCC Inactive

POST /v2/update_ucc

{
"data": {
"member": { … },
"investor": { ... },
"ucc_status": ""
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

holder Y N Object Holder

parent_client_c N N String Parent client code if available

ode

ucc_status Y Y Object "inactive"

6.2.2.2.14 Update UCC Holder Object

POST /v2/update_ucc
{
"data": {
"member": { … },
"investor": { … },
"holder": {
​ "add": [
​ {}
}
}

Attribute M List Type Limit Description and example(s)

BSE StARMF v2 API

35
member Y N Object Member

investor Y N Object Investor/Client code: UCC

Investor_ucc

holder Y N String Holder object to be updated.

Holder

6.2.2.2.15 Mandatory documents in update

Attribute Mandatory Identifier required

Primary Holder First Name PAN
Primary Holder Middle Name PAN
Primary Holder Last Name PAN
Tax Status PAN
Primary Holder DOB/Incorporation PAN
Second Holder First Name PAN
Second Holder Middle Name PAN
Second Holder Last Name PAN
Third Holder First Name PAN
Third Holder Middle Name PAN
Third Holder Last Name PAN
Guardian First Name PAN
Guardian Middle Name PAN
Guardian Last Name PAN
Primary Holder PAN PAN
Second Holder PAN PAN
Third Holder PAN PAN
Guardian PAN PAN
CDSL DPID CML
CDSL CLTID CML
NSDL DPID CML
NSDLCLTID CML

6.2.2.3 List UCC

Request
POST /v2/list_ucc

{
"data": {
"member": { … },
"investor": { ... },
“ucc_status”: { “ACTIVE” },
“fields”: {“ALL”},
“start”: 0,
“length”: 100
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor N N Object Investor/Client code: UCC Investor_ucc

BSE StARMF v2 API

36
 ucc_status Y N Enum UCC status ucc_status

fields Y Y Object [“ALL”]

start N N Integer Default value 0

length N N Integer Default value 100

filter_param N Y Object ucc_list_filter_param

Example: list_ucc

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
[
{
"member": {
"member_id": ""
},
"investor": {
//Investor
},
"holding_nature": "",
"tax_status": "",
"tax_code": "",
"rdmp_idcw_pay_mode": "",
"is_client_physical": true,
"is_client_demat": false,
"is_nomination_opted": false,
"nomination_auth_mode": "",
"ucc_status": "ACTIVE",
"comm_mode": "",
"onboarding": "",
"holder": [
//Holder
],
"comm_addr": {
//comm_addr
},
"foreign_addr": {
//addr
},
"bank_account": [
{
//bank_account
}
],
"fatca": [
//fatca
],
"identifiers": [],
"ucc_status_obj": {
//ucc_status_obj

BSE StARMF v2 API

37
 }
], “status_count_summary”: [
{
//status_count_summary_obj
}
]
}

messages Y Y object []

6.2.2.4 Get UCC

Request
POST /v2/get_ucc

{
"data": {
"member": { … },
"investor": { ... },
}
}

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor_ucc

parent_client_c N N String Parent Client Code

ode

Example: get_ucc

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
{

"member_code": {
"member_id": ""
},
"investor": {
//Investor
},
"holding_nature": "",
"tax_status": "",
"tax_code": "",
"rdmp_idcw_pay_mode": "",
"is_client_physical": true,
"is_client_demat": false,
"is_nomination_opted": false,
"nomination_auth_mode": "",
"ucc_status": "ACTIVE",

BSE StARMF v2 API

38
 "comm_mode": "",
"onboarding": "",
"holder": [
//Holder
],
"comm_addr": {
//comm_addr
},
"foreign_addr": {
//addr
},
"bank_account": [
{
//bank_account
}
],
"fatca": [
//fatca
],
"identifiers": [],
"ucc_status_obj": {
//ucc_status_obj
}
}

messages Y Y object []

6.2.3 Order

6.2.3.1 order_new
Place a new order for ‘sip’, ‘stp’, ‘swp’, ‘nfo’ or ‘lumpsum’
Request
POST /v2/order_new

{
"data": {
"orders":[
"clientcode": "....",
/* … more … */
]
}
}

Attribute M List Type Limit Description and example(s)

member Y N String Member code.

mem_details N N Object Member Details mem_details

investor Y N Object Client code of the UCC. Investor

parent_client_c N N String Parent Client code

ode

mem_ord_ref_id Y N String Order reference provided by member. ​

Minimum Length=1 | Maximum Length=32
Allowed values: Numbers and hyphen

BSE StARMF v2 API

39
 type Y N Enum order_type

src N N Enum This specifies the source. Order_source

Note: This will only be available in response APIs

reg_no N N String This specifies the registration number for the sxp.
Note: This will only be available in response APIs

scheme Y N String Scheme

amount C N Number When the field ‘all_unit’ is true, the amount value is
optional.

cur Y N String The currency for the amount. E.g. “INR”

is_units N N Boolean Specified if the amount will represent unit

all_units N N Boolean If true then amount will be 0 and is_unit will be true

folio C N String Mandatory in case of ‘physical’ order.

In case of Lumpsum_Purchase, Lumpsum_Redeem,
Switch and on first purchase type of transaction this can be
optional. ​
Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

is_fresh Y N Boolean Is the order a fresh order for a specific scheme within the
existing folio

min_redeem_fla N N Boolean Applicable only for redemption.

g If Yes, then minimum units allowed for redemption in the
scheme will be considered.

phys_or_demat Y N Enum order_phys_or_demat

dest_folio C N String In case of STP or switch this is to be specified.

Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

dest_scheme C N String In case of STP or switch this is to be specified.

payment_ref_id N N String Payment Reference ID

bank_rcpt_id N N String Bank Receipt ID

email N N String Email ID

mobnum N N String Mobile Number

exch_mandate_ N N Number Exchange Mandate ID

id

kyc_passed N N Boolean Is KYC passed

depository_acct C N Object Depository Account depository_acct

bank_acct C N Object Bank Account bank_acct

dpc N N Boolean Specifies if it is direct payout to client

BSE StARMF v2 API

40
 is_nomination_o N N Boolean Is the nomination opted for by the client?
pted Relevant only when Nomination is being provided at order
level

nomination_aut C N Enum If nomination is opted, then what is the nomination

h_mode authentication mode? Nomination_auth_mode​
Here only “O” is allowed in case of orders

nomination C N Object Nomination Object nomination

Mandatory if ‘is_nomination_opted’ is true

holder N Y Object 3 Object order_holder

special_product N N Object Special product

Example: order_new

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"items": [
{
"mem_ord_ref_id": "12312312",
"id": 5000000000000001
},
{
"mem_ord_ref_id": "1234567",
"id": 5000000000000002
}
]
},
"messages": []
}

where
id: numeric order id generated by system
mem_ord_ref_id: id generated by member
Here both orders were accepted by exchange and therefore
the API returned system generated order IDs.

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

BSE StARMF v2 API

41
 {
"status": "error",
"data": {
"items": [
{
"mem_ord_ref_id": "5451-54675-542-544573",
"id": 5000000000000003,
"status": "success"
}
]
},
"messages": [
{
"msgid": 1505,
"errcode": "id_not_exist",
"field": "5451-54675-542-544572.member",
"vals": [
"MBR0010"
]
}
]
}

In this response, there were two orders of which one was

successfully processed and the other had an error.
1.​ For the order with mem_ord_ref_id
5451-54675-542-544573, the request was
successful.
2.​ For the with mem_ord_ref_id
5451-54675-542-544572, there is error:
-​ The member code “MBR0010” does not
exist.

6.2.3.2 order_update
Update an order for ‘sip’, ‘stp’, ‘swp’, ‘nfo’, or ‘lumpsum’
Request
POST /v2/order_update

{
"data": {
"id": "....",
/* … more … */
}
}

Attribute M List Type Limit Description and example(s)

member N N String Member code

Note: This field cannot be changed in the order_update API
Only Member users are allowed to update order. And for
members, the same is retrieved from the member’s login
token only.

mem_details N N Object Member Details mem_details

investor Y N Object Client code of the UCC. Investor

parent_client_c N N String Parent Client code

BSE StARMF v2 API

42
 ode

id Y N Number Order ID from StarMF system

mem_ord_ref_id Y N String Order reference provided by member

Minimum Length=1 | Maximum Length=32
Allowed values: Numbers and hyphen

type Y N Enum order_type

src N N Enum This specifies the source. Order_source

Note: This will only be available in response APIs

reg_no N N String This specifies the registration number for the sxp.
Note: This will only be available in response APIs

scheme Y N String Scheme

amount C N Number When the field ‘all_unit’ is true, the amount value is
optional.

cur Y N String The currency for the amount. E.g. “INR”

is_units N N Boolean Specified if the amount will represent unit

all_units N N Boolean If true then amount will be 0 and is_unit will be true

folio C N String Mandatory in case of ‘physical’ order.

In case of Lumpsum_Purchase, Lumpsum_Redeem,
Switch and on first purchase type of transaction this can be
optional
Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

is_fresh Y N Boolean Is the order a fresh order for a specific scheme within the
existing folio

phys_or_demat Y N Enum order_phys_or_demat

dest_folio C N String In case of STP or switch this is to be specified.

Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

dest_scheme C N String In case of STP or switch this is to be specified.

payment_ref_id N N String Payment Reference ID

bank_rcpt_id N N String Bank Receipt ID

email N N String Email ID

mobnum N N String Mobile Number

exch_mandate_ N N Number Exchange Mandate ID

id

kyc_passed N N Boolean Is KYC passed

depository_acct Y N Object Depository Account depository_acct

BSE StARMF v2 API

43
 bank_acct Y N Object Bank Account bank_acct

dpc N N Boolean specifies if it is direct payout to client

is_nomination_o Y N Boolean Is the nomination opted for by the client?​

pted Relevant only when Nomination is being provided at order
level

nomination_aut C N Enum If nomination is opted, then what is the nomination

h_mode authentication mode? Nomination_auth_mode​
Here only “O” is allowed in case of orders

nomination N N Object Nomination Object nomination

holder N Y Object 3 Object order_holder

special_product N N Object Special product

Example: order_update

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"success_id": [
5000000000000001
]
},
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 1579,
"errcode": "invalid",
"field": "id",
"vals": [
"partial payment is done hence update is not
allowed",
"135792468"
]

BSE StARMF v2 API

44
 }
]

6.2.3.3 order_cancel
Cancel an open order
Request
POST /v2/order_cancel

{
"data": {
"id": “...”,
“remark” : ”...”
}
}

Attribute M List Type Limit Description and example(s)

id Y N Number Order ID generated by BSE StarMF system

investor Y N Object Client code of the UCC. Investor

remark N N String Remarks for order cancellation

Example: order_cancel

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": 5000000000000002 ,
"investor": Investor,
"settlement_no": “”
},
}

Note: In above settlement_no will optionally be available if

the Order has matched with Either the MIS or with the Bank
Statement.

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

BSE StARMF v2 API

45
 messages Y Y object Array of messages:

[
{
"msgid": 1507,
"errcode": "record_not_found"
}
]

6.2.3.4 order_list
Request
POST /v2/order_list

{
"data": {
“status”: { “” },
“fields”: {“ALL”},
“start”: 0,
“length”: 100
}
}

Attribute M List Type Limit Description and example(s)

fields Y Y Object [“ALL”]

count_only N N Boolean Will return only count of records if the value is true. By
default the value is false. So, if the value is not specified,
the default value of false is taken.

start N N Integer It is optional and default value is 0

length Y N Integer 100

filter_param N Y Object Refer to order_list_filter_param

Example: order_list

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"total_count": 1,
"lists": [
{
"id": 1234567890123,
"exch_order_id": "...",
"type": "...",
"mem_ord_ref_id": "...",
"investor": Investor,
"member": "...",

BSE StARMF v2 API

46
 "scheme": "...",
"amount": "...",
"cur": "...",
"is_units": "...",
"all_units": "...",
"is_fresh": "...",
"folio_num": "...",
"phys_or_demat": "...",
"settlement_no": "...",
"rta_txn_no": "...",
"rta_remark": "...",
"reg_no": "...",
"payment_ref_id": "...",
"payment_aggr_code": "...",
" settement_date": "...",
"settlement_type": "...",
"pg_ref_no": "...",
"fund_receipt_date": "...",
"status": order_lifecycle_status,
"mem_2fa": "...",
"mem_2fa_action_at": "...",
"mem_paymt": "...",
"email": "...",
"mobnum": "...",
"placed_at": "...",
"exch_mandate_id": 0,
"kyc_passed": true,
"tracker_id": "...",
"dpc": true,
"remarks": "",
"dest_scheme": "",
"matched_pa_ids": 0,
"pa_matched_at": "",
"matched_bank_rcpt": null,
"bank_matched_at": "",
"full_matched_at": "",
"rta_resp_at": "",
"rta_resp": null,
"dp_resp": null,
"refund_details": null,
"threshold_isapproved": false,
"expires_at": "",
"order_added_at": "",
"dest_folio": "",
"client_code": "...",
"holding_nature": "...",
"is_client_demat": true,
"is_client_physical": false,
"member_code": "..",
"primary_holder_name": "...",
"tax_status": "...",
"ucc_status": "...",
"nomination": [nomination],
"holder": [Holder],
"info": {
"min_redeem_flag": "...",
"src": "...",
"reg_no": "...",
"mem_details": mem_details
},
"order_src_info": order_src_info,
"depository_acct": depository_acct,

BSE StARMF v2 API

47
 "bank_acct": bank_acct,
"rejection_reason": rejection_reason,
"history": [ history_obj ],
"allotment_details": allotment_details,
"redempt_details":allotment_details,
" refund_details": refund_details
}
]
}
}

messages Y Y object []

Response

6.2.3.5 order_get
Request
POST /v2/order_get

{
"data": {
"id": “17ae19fe-73e5-47d4-8afa-66ace884c3d5”,
“filter_param” : {
”open_close”: “o”
}
}

Attribute M List Type Limit Description and example(s)

id Y N Number Order ID generated by BSE StarMF system

open_close N N Enum order_status

Example: order_get

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": 1234567890123,
"exch_order_id": "...",
"type": "...",
"mem_ord_ref_id": "...",
"investor": Investor,
"member": "...",
"scheme": "...",
"amount": "...",
"cur": "...",
"is_units": "...",
"all_units": "...",
"is_fresh": "...",
"folio_num": "...",
"phys_or_demat": "...",

BSE StARMF v2 API

48
 "settlement_no": "...",
"rta_txn_no": "...",
"rta_remark": "...",
"reg_no": "...",
"payment_ref_id": "...",
"payment_aggr_code": "...",
" settement_date": "...",
"settlement_type": "...",
"pg_ref_no": "...",
"fund_receipt_date": "...",
"status": order_lifecycle_status,
"mem_2fa": "...",
"mem_2fa_action_at": "...",
"mem_paymt": "...",
"email": "...",
"mobnum": "...",
"placed_at": "...",
"exch_mandate_id": 0,
"kyc_passed": true,
"tracker_id": "...",
"dpc": true,
"remarks": "",
"dest_scheme": "",
"matched_pa": null,
"pa_matched_at": "",
"matched_bank_rcpt": null,
"bank_matched_at": "",
"full_matched_at": "",
"rta_resp_at": "",
"rta_resp": null,
"dp_resp": null,
"refund_details": null,
"threshold_isapproved": false,
"expires_at": "",
"order_added_at": "",
"dest_folio": "",
"expiresat": "",
"client_code": "...",
"holding_nature": "...",
"is_client_demat": true,
"is_client_physical": false,
"member_code": "..",
"primary_holder_name": "...",
"tax_status": "...",
"ucc_status": "...",
"nomination": [nomination],
"holder": [Holder],
"manually_upadated_at": "",
"manually_updated_by": "",
"threshold_rejected_by": "",
"threshold_rejected_at": "",
"match_bank_rcpt_id":0,
"info": {
"min_redeem_flag": "...",
"src": "...",
"reg_no": "...",
"mem_details": mem_details
},
"order_src_info": order_src_info,
"depository_acct": depository_acct,
"bank_acct": bank_acct,
"rejection_reason": rejection_reason,

BSE StARMF v2 API

49
 "history": [ history_obj ],
"allotment_details": allotment_details,
"redempt_details":allotment_details,
" refund_details": refund_details
}
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{

}
]

6.2.4 SxP (SIP/SWP/STP)

SxP covers SIP (including XSIP and ISIP), SWP and STP new registrations and updates.

6.2.4.1 sxp_register
POST /v2/sxp_register

{
"data": {
"sxp_type": “...”,
“mem_ord_ref_id” : “...”,
/* … more … */

}
}

Attribute M List Type Limit Description and example(s)

sxp_type Y N Enum sxp_type

mem_sxp_ref_i N N String Order reference provided by member

d Minimum Length=1 | Maximum Length=32
Allowed values: Numbers and hyphen

investor Y N Object Client code of the UCC. Investor

member Y N String Member code

parent_client_c N N String Parent Client code

ode

BSE StARMF v2 API

50
 src_scheme Y N String Source Scheme

dest_scheme N N String Destination Scheme

amc_code N N String AMC Code

exch_mandate_ C N Number Exchange Mandate ID - mandatory to register XSIP, else

id optional

amount Y N Number Amount of money. In case of “swp”, amount of money or

units.

cur Y N String The currency for the amount. E.g. “INR”

isunits N N Boolean Specified if the amount will represent unit

all_units N N Boolean If true then amount will be 0 and is_unit will be true

src_folio N N String Source Folio Number

Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

dest_folio N N String Destination Folio Number

Minimum Length=1 | Maximum Length=28
Allowed values: Numbers and “/”(followed by 2 digits)
E.g. 123456/11

is_fresh Y N Boolean Is the order a fresh order for a specific scheme within the
existing folio

dpc N N Boolean Specifies if it is direct payout to client

phys_or_demat Y N Enum order_phys_or_demat

start_date Y N Date The date when the sxp start is triggered. (YYYY-MM-DD)
e.g. "2024-04-30"

ninstallments C N Number Specify number of instalments, end date is calculated

based on this value except for freq of type daily, omitted
when freq type is daily.

end_date C N Date Last trigger date of sxp, mandatory for freq of type daily.
(YYYY-MM-DD) e.g. "2024-04-30"

freq M N Enum sxp_freq

txn_date N N Number If the “freq” is “w” then txn_date will indicate day of the
week
else
txn_date will indicate the date of the period.
This field will be ignored if the “freq” is “d”. If the “freq” is
daily then it is optional, for all the other “freq”, it is
mandatory.

payment_ref_id N N String Value will be given in case of sip, first order placed.

info N N Object info_sxp

depository_acct Y N Object Depository Account depository_acct

bank_acct N N Object Bank Account bank_acct

BSE StARMF v2 API

51
 email N N String Email Address

mobnum N String Mobile Number

first_order_toda N N Boolean when specified then the start_date for the reg should be
y today

brokerage N N Number brokerage amount should be less than or equal to 2.5

percent of the instalment amount

nomination N N Object Nomination Object nomination

holder M Y Object 3 Object order_holder

special_product N N Object Special product

remark N N String Remarks

Minimum Length=1 | Maximum Length=128

kyc_passed N N Boolean Can have true or false values

mem_details N N Object "mem_details": {

"euin": "E345671",
"euin_flag": true,
"sub_br_code": "IN456789",
"sub_br_arn": "ARN-435674",
"partner_id": ""
}

Example: sxp_register
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": "3c206cd3-0d45-4305-98d8-81728c663825"
}
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,

BSE StARMF v2 API

52
 "errcode": "required",
"field": "ucc",
"vals": [ ]
}
]

6.2.4.2 sxp_cancel
Cancel an open order
POST /v2/sxp_cancel

{
"data": {
"reg_no": “...”
}
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String Sxp registration no generated by the starMF system

reason_cd Y N Enum Refer to sxp_cancel_reason

reason_cd_msg C N String Cancel reason. Mandatory if reason_cd=13

sxp_type Y N Enum sxp_type

Example: sxp_cancel
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": "3c206cd3-0d45-4305-98d8-81728c663825"
}
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",

BSE StARMF v2 API

53
 "field": "reason_cd",
"vals": [ ]
}
]

6.2.4.3 sxp_topup
Top Up and existing ‘sip’, ‘stp’ or ‘swp’ order
POST /v2/sxp_topup

{
"data": {
"reg_no": "f15d48ea-1dad-4434-85be-e427061819ba",
"mem_sxp_ref_id": "5465-5465-54-5446",
"amount": 1000,
"cur": "INR",
"start_date": "2023-03-16",
"end_date": null,
"freq": "w",
"txn_date": 1,
"payment_ref_id": "",
"remark": "any comment",
"first_order_today": true,
"email": "...",
"mobnum": "..."
}
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String The registration number for the sxp_type.

mem_sxp_ref_i N N String Provided by Member.

d

amount Y N float Amount of money

cur Y N String The currency for the amount. In case of swp and stp is only
meaningful if isunits is false.id

start_date Y N String The date when the sxp start trigger.

end_date C N String Last trigger date of sxp.

Mandatory for freq of type daily.

ninstallments C N int Specify number of installments, end date is calculated

based on this value except for freq of type daily, omitted
when freq type is daily.

freq Y N String This is enum, with allowed value for only h for halfyearly
and y for yearly.

txn_date N N int Indicate payment date. values from 1-28 only

payment_ref_id N N String Value will be given in case of sip, first order placed.

remark N N String Should be added in source_info

first_order_toda N N boolean When specified then the start_date for the reg should be

BSE StARMF v2 API

54
 y today

email N N String Email ID of the investor

mobnum N N String Mobile Number of the investor

Example: sxp_topup
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"top_up_id": "..."
},
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "reg_no"
}
]

6.2.4.4 sxp_set_pause
Pause an running ‘sip’, ‘stp’ or ‘swp’ order
POST /v2/sxp_set_pause

{
"data": {
"reg_no": “”,
“ninstallments” : ”...”,
“paused_from” : ”...”
}
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String The registration number for the sxp_type.

BSE StARMF v2 API

55
 ninstallments Y N String Number of installments.
Minimum and Maximum values for this must be as per
scheme master

paused_from Y N Date pause start date (YYYY-MM-DD) e.g. "2024-04-30"

Example: sxp_set_pause
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": "..."
},
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "reg_no"
}
]

6.2.4.5 sxp_resume
Resume an paused ‘sip’, ‘stp’ or ‘swp’ order
POST /v2/sxp_resume

{
"data": {
"reg_no": “”,
“resume_reason” : ”...” }
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String The registration number for the sxp_type.

resume_reason N N String Reason to resume the sxp

BSE StARMF v2 API

56
Example:
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"id": "..."
},
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "reg_no"
}
]

6.2.4.6 sxp_list
POST /v2/sxp_list

{
"data": {
“status”: { “” },
“fields”: {“ALL”},
“count_only” :false,
“start”: 0,
“length”: 100
}
}

Attribute M List Type Limit Description and example(s)

fields Y Y Object [“ALL”]

count_only N N Boolean Will return only count of records if the value is true. By
default the value is false. So, if the value is not specified,
the default value of false is taken.

start N N Integer The default value of start is 0, if no value is specified.

BSE StARMF v2 API

57
 length Y N Integer 100

filter_param N Y Object sxp_list_filter_param

Example: sxp_list
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"lists": [
{
"sxp_type": "SIP",
"mem_sxp_ref_id": "...",
"ucc": "...",
"member": "...",
"src_scheme": "...",
"dest_scheme": "...",
"amc_code": "...",
"exch_mandate_id": 0,
"amount": 3234,
"cur": "...",
"src_folio": "",
"dest_folio": "",
"phys_or_demat": "...",
"is_units": false,
"dpc": false,
"start_date": "...",
"end_date": "...",
"freq": "...",
"txn_date": 23,
"info": {
"mem_details": {
"euin_flag": true,
"mem_type": "...",
"partner_id": "...",
"sub_br_arn": "...",
"sub_br_code": "..."
}
},
"depository_acct": {
"client_id": "",
"depository": "",
"dp_id": ""
},
"bank_acct": {
"ifsc": "",
"name": "",
"no": "",
"type": ""
},
"remark": "...",
"email": "...",
"mobnum": "...",
"brokerage": 0,
"kyc_passed": false,
"special_product": {

BSE StARMF v2 API

58
 "goal_amt": 0,
"goal_type": "",
"sip_tenure": 0,
"special_prod_name": "",
"special_prod_type": "",
"target_amt": 0,
"target_scheme": ""
},
"holder": {},
"nomination": {},
"next_due_date": "...",
"previous_paid_date": "...",
"n_installment_paid": 0,
"total_amt_paid": 0,,
"npauses": "",
"paused_from": "",
"paused_till": "",
"next_schedule_at": "",
"npayments_missed": "",
"invalidated_at": "",
"invalidate_reason": ""
"sprod_sxp": {},
"status": sxp_lifecycle_status
}
]
},
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "fields"
}
]

6.2.4.7 sxp_get
POST /v2/sxp_get

{
"data": {
"reg_no": “123123”
}
}

BSE StARMF v2 API

59
 Attribute M List Type Limit Description and example(s)

reg_no Y N String SXP Registration No

sxp_type Y N Enum sxp_type

Example: sxp_get
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"sxp": {
"sxp_type": "XSIP",
"mem_sxp_ref_id": null,
"referenced_from": null,
"ucc": "CLT0526",
"member": "0526",
"src_scheme": "KJSEDR2-DP",
"dest_scheme": "",
"amc_code": "SSS",
"exch_mandate_id": 500000003,
"amount": 4700,
"cur": "zxzzz",
"src_folio": "",
"dest_folio": "",
"phys_or_demat": "P",
"is_units": false,
"dpc": true,
"start_date": "2024-09-10",
"end_date": "2024-09-17",
"freq": "w",
"txn_date": 1,
"info": {
"mem_details": {
"euin_flag": true,
"mem_type": "STOCK_BROKER",
"partner_id": "partner_id",
"sub_br_arn": "arn",
"sub_br_code": "code"
}
},
"depository_acct": depository_acct,
"bank_acct": bank_acct,
"remark": "any comment",
"email": "xxx@gmail.com",
"mobnum": "+919985",
"ref_type": null,
"brokerage": 0,
"kyc_passed": false,
"special_product": null,
"holder": null,
"nomination": null,
"next_due_date": "2024-09-10T00:00:00Z",
"previous_paid_date": "",
"n_installment_paid": 0,
"total_amt_paid": 0,

BSE StARMF v2 API

60
 "npauses": "",
"paused_from": "",
"paused_till": "",
"next_schedule_at": "",
"npayments_missed": "",
"invalidated_at": "",
"invalidate_reason": ""
},
"sprod_sxp": {},
"status": sxp_lifecycle_status
}
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "reg_no"
}
]

6.2.4.8 sxp_get_history
POST /v2/sxp_get_history

{
"data": {
"reg_no": “123123”
}
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String SXP Registration No

fields Y Y Object [“ALL”]

filter_param N Y Object sxp_history_filter_param

Example: sxp_get
Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

BSE StARMF v2 API

61
 data Y Y object {
"data": {
"lists": [
{
"all_units": false,
"amount": 1000,
"cur": "...",
"date": "...",
"dest_folio": "...",
"dest_scheme": "...",
"folio": "...",
"history": [
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."
},
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."
}
],
"id": 5000000172,
"is_units": false,
"mem_ord_ref_id": "...",
"member": "...",
"payment_ref_id": "...",
"phys_or_demat": "...",
"regst_no": "...",
"src_scheme": "...",
"status": "...",
"txn_type": "...",
"ucc": "..."
}
]
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "reg_no"
}
]

BSE StARMF v2 API

62
6.2.5 NFT
The process for NFT is as follows:
1.​ The member will send a request to StARMF system.
2.​ Members will receive the system generated request ID.
3.​ StARMF system will fetch details from the respective RTA and send a link for 2FA to
the client.
4.​ Once the client approves the 2FA, the request will be sent to the RTA and the
response from RTA will be sent to the Member via Webhook.
5.​ The member can check the status of the request by sharing the system request ID in
the API request as received in step 2.

6.2.5.1 Nominee Change

POST /v2/nft_nominee_change
{
"data": {
"nft_auth": { … },
"nominee_change_info": {"..."}
}
OR
"data": {
"request_id": "…"
}

Attribute M List Type Limit Description and example(s)

nft_auth Y N Object nft_auth

nominee_chang Y N Object nominee_change_info

e_info

request_id N N String Request ID generated by the System.

If request ID is passed, the system will check for existing
requests and provide responses. It’ll not make the API call
to RTA.

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"request_id": "..."
},
}

messages Y Y object []

BSE StARMF v2 API

63
 Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "rta"
}
]

6.2.5.2 Contact change

POST /v2/nft_contact_change
{
"data": {
"nft_auth": { … },
"contact_info": {"..."}
}
OR
"data": {
"request_id": "…"
}

Attribute M List Type Limit Description and example(s)

nft_auth Y N Object nft_auth

contact_info Y N Object contact_info

request_id N N String Request ID generated by the System.

If request ID is passed, the system will check for existing
requests and provide responses. It’ll not make the API call
to RTA.

Response

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"request_id": "..."
},
}

BSE StARMF v2 API

64
 messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "rta"
}
]

6.2.5.3 Bank Account change

POST /v2/nft_bank_account_change
{
"data": {
"nft_auth": { … },
"bank_change_info": {"..."}
}
OR
"data": {
"request_id": "…"
}
}

Attribute M List Type Limit Description and example(s)

nft_auth Y N Object nft_auth

bank_change_i Y N Object bank_change_info

nfo

request_id N N String Request ID generated by the System.

If request ID is passed, the system will check for existing
requests and provide responses. It’ll not make the API call
to RTA.

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"request_id": "..."
},

BSE StARMF v2 API

65
 }

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "rta"
}
]

6.2.6 Payment Aggregator

6.2.6.1 Submit Payment Aggregation (MIS) report

If the same request is submitted more than once for the same payment_ref_id, then
subsequent requests will be ignored.
Request
POST /v2/upload_mis

{
"data": [
{
"member": “ …”,
"clientcode": "....",
"amount": ,
}
]
}

"data": list of objects. Attributes for each object described below. The Maximum number of objects in the list is
5000 (will be fine tuned later).

Attribute M List Type Limit Description and example(s)

payment_ref_id C N String PG Reference no/ Mandate ID/Transaction ref ID.​

Blank only in case of NEFT mis_type.
MandateID in case of XSIP and OTM mis_type
Deposit Challan No in case of CHEQUE mis_type
If the attribute paymt_mode is NEFT, RTGS, IMPS, Internal
Fund Transfer then this field is optional.

agency_code Y N String Agency Code for instance RZP/ICI/RCB/TCP ( 3

characters)

mis_type Y N Enum Type of MIS being uploaded. mis_type

BSE StARMF v2 API

66
 member C N String Member code. If paymt_mode is NEFT, RTGS, IMPS,
Internal Fund Transfer then this field is optional.

investor C N Object Investor (UCC/pan holder details). Investor_mis . If

paymt_mode is NEFT, RTGS, IMPS, Internal Fund Transfer
then this field is optional.

parent_client_c N N String Parent Client Code. If paymt_mode is NEFT, RTGS, IMPS,

ode Internal Fund Transfer then this field is optional.

amount Y N amount Amount received from client as reported by bank. Max 2

decimal are allowed

credit_dt Y N Date Date on which amount credited - dd-mmm-yyyy

credit_at N N Time Time at which amount credited HH:MI:SS

(PA can put exact time, or 00:00:00 if time is not tracked by
PA)

bank_txn_ref Y N String Bank UTR no / Cheque no

umrn_ref C N String UMRN

src_bank_acc Y N Object Investor's bank account details from which fund received.
bank_acct

dest_bank_acc Y N Object Clearing Corp's bank account details to which fund was
transferred. bank_acct

exchorder_num C N String Order number issued by StARMF platform

(In case of Lumpsum Txn)

paymt_mode Y N Enum Payment Receipt Mode. paymt_mode

custom_ref_nu C N String Additional reference number provided by investor's bank,

m else empty

info N N Object { "investor_name": "..." } (this object is only for informational

purpose, and will not be interpreted for order processing).

remark C N String 255 Remarks (only printable characters allowed, it has no

significance on business logic)

status C N Enum mis_status

Response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object "data": mis_status

messages Y Y object []

Sample Failure response

BSE StARMF v2 API

67
 Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "agency_code"
}
]

6.2.6.2 Payment Aggregator Get Details

Request
POST /v2/get_mis_detail
{
"data": {
"payment_ref_id": { … }
}
}

Attribute M List Type Limit Description and example(s)

payment_ref_id C N String Payment reference number

utrn_no C N String UTRN

Any one of the above two are mandatory in the API.

Response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object "data": {

"payment_ref_id": "...",
"agency_code": "...",
"mis_type": "...",
"member": "...",
"investor": {
"ucc": "...",
"panholders": "",
"holding_nature": "..."
},
"parent_client_code": "...",
"amount": ...,
"credit_dt": "...",
"credit_at": "...",
"bank_txn_ref": "...",

BSE StARMF v2 API

68
 "umrn_ref": "",
"src_bank_acc": {
"no": "...",
"ifsc": "...",
"name": "...",
"type": "..."
},
"dest_bank_acc": {
"no": "...",
"ifsc": "...",
"name": "...",
"type": "..."
},
"exchorder_num": "...",
"paymt_mode": "...",
"custom_ref_num": "...",
"info": {
"investor_name": ""
},
"remark": "...",
"status": "..."
}
Note all fields in the response is same as upload_mis API
request.

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "payment_ref_id"
}
]

6.2.7 Scheme List

Request
POST /v2/master_scheme_list

{
"data": {
“status”: { “” },
“fields”: {“ALL”},
“count_only” :false,
“search”: {
"value": "..."
},

BSE StARMF v2 API

69
 “start”: 0,
“length”: 100
}
}

Attribute M List Type Limit Description and example(s)

fields Y Y Object [“ALL”]

count_only Y N Boolean Will return only count of records, if the value is true

search N N Object Value attribute for the text search.

{
“value”: “schemename”
}
// This is a partial plain text search.

start Y N Integer 0

length Y N Integer 100

filter_param N Y Object "filter_param": {

"scheme_amc_name": "",
"scheme_category": "",
"scheme_sub_category": "",
"investment_mode": "",
"scheme_option": "",
"scheme_plan": "",
"scheme_isin": "",
"settlement_days": "",
"transaction_allowed": ""
},

Response
Sample Scheme List Sample
Attribute M List Type Limit Description and example(s)

parent_scheme Y N String Parent Scheme Code e.g. "B-EQT-ELSS"

_code

parent_scheme Y N String Parent Scheme Name e.g. "Aditya Birla Sun Life ELSS Tax
_name Saver Fund"

name Y N String Scheme Name. e.g. "ADITYA BIRLA SUN LIFE ELSS TAX
SAVER FUND - REGULAR PLAN -IDCW PAYOUT"

scheme_plan Y N Enum “Direct”

“Regular”

scheme_option Y N Enum “Growth”

“IDCW Payout”
“IDCW Reinvestment”

scheme_option N N Enum “DAILY“

_frequency “FORTNIGHTLY“
“WEEKLY“
“MONTHLY“
“QUARTERLY“
“HALF YEARLY“
“ANNUALLY”

BSE StARMF v2 API

70
 scheme_addon N N Enum “Insurance”
“Health Insurance”
“Credit Card”

scheme_transa Y Y Object Refer scheme_transaction_mode_allowed

ction_mode_allo
wed

scheme_isin Y N String ISIN of scheme e.g. "INF209K01090"

scheme_amfi_c N N String AMFI code of scheme

ode

scheme_bse_co Y N String BSE scheme code. E.g. "02-DP"

de

scheme_cpc_co Y N String Channel Partner Scheme Code.

de

scheme_amc_n Y N String Scheme name at AMC. e.g. "ADITYA BIRLA SUN LIFE
ame MUTUAL FUND"

scheme_rta_na Y N String RTA Scheme Code

me

scheme_sub_ca Y N Enum Refer scheme_sub_category type

tegory

scheme_sector N N Enum “Agriculture”

“Infrastructure”
“Technology”
…

scheme_bench N N Enum “BSE100”

mark “BSE_SMALLCAP”
“BSE_MIDCAP”
“BSE_SENSEX_50”
…

scheme_face_v Y N Integer Face Value of Scheme

alue

scheme_offer_s N N Enum “NFO”

tatus “OPEN”
“CLOSED”

scheme_offer_t Y N Enum “OPEN_ENDED”

ype “CLOSED_ENDED”
“INTERVAL”

scheme_invest Y N String ”ACTIVE”

ment_mode “PASSIVE”

scheme_redem Y N Enum “T1”

ption_settlemen “T2”
t_days “T3”
“T4”
“T4”
“T6”
“T7”
“T8”
“T9”
“T10”

BSE StARMF v2 API

71
 scheme_nfo_da N Y Object Y Refer scheme_nfo_date_time_detail
te_time_detail

nfo_payment_d N Y Object Y Refer nfo_payment_details

etails

nfo_open_date N N String NFO Open date

nfo_close_date N N String NFO Close date

nfo_allotment_d N N String NFO Allotment Date

ate

reopen_date N N String Reopen Date for scheme

scheme_interval N Y Object Y Refer scheme_interval_lifecycle

_lifecycle

scheme_last_or N N String Scheme Last Order Closure Date

der_closure_dat
e

scheme_final_cl N N String Scheme Final Closure Date

osure_date

scheme_entry_l N N String Scheme Order Entry Load

oad

scheme_entry_l N N String Scheme Order Entry Load Remarks

oad_remarks

scheme_exit_lo N N String Scheme Exit Load

ad

scheme_exit_lo N N String Scheme Exit Load Remarks

ad_remarks

scheme_lockin_ N N Integer Scheme Lockin Period.

period

scheme_lockin_ N N Integer “Months”

period_type “Days”
“Years”

lumpsum Y Y Object Refer scheme_lumpsum

systematic Y Y Object Refer scheme_systematic

scheme_catego N N String Category of the scheme

ry

amc_active_flag N N Boolean AMC is active or not

is_active N N Boolean If the scheme is active or not

scheme_amc_ Y Y String “NH32”

code

scheme_rta_c Y Y String “NH1”

ode

sip_flag Y N Boolean false

BSE StARMF v2 API

72
 stp_in_flag Y N Boolean false

stp_out_flag Y N Boolean false

switch_in_flag Y N Boolean false

switch_out_fla Y N Boolean false

g

swp_flag Y N Boolean false

systematic_tr Y N Object {[
ansaction_det "scheme_sxp_installment_numbers": {
ail "scheme_sxp_max_installments": 100000,
"scheme_sxp_min_installments": 1
},
"scheme_transaction_amt": {
"scheme_transaction_max_amt": 1000000,
"scheme_transaction_min_adtnl_amt": null,
"scheme_transaction_min_amt": 1,
"scheme_transaction_mult_amt": 1
},
"scheme_transaction_units": {
"scheme_transaction_max_unit": 1000000,
"scheme_transaction_min_unit": 1,
"scheme_transaction_mult_unit": 1
}
}

6.2.8 NAV Master List

Request
POST /v2/nav_master_list
{

"count_only" : false,
"start" : 0,
"length" : 50
"filter_param" : {
"nav_date" : "01-Jan-2020",
"bse_scheme_code" : "ARDD-DR"
}
}

Attribute M List Type Limit Description and example(s)

count_only Y N Boolean Will return count of records, if the value is true

fields Y Y Object [“ALL”]

start Y N Integer 0

length Y N Integer 100

filter_param N Y Object nav_filter_param

BSE StARMF v2 API

73
Response
The response of the API will contain a List of Orders that matches the information passed.
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object "data": {

"count": 1,
"lists": [
{
"nav_date": "06-Jan-2025",
"bse_scheme_code": "ARDD-DR",
"isin": "INF754K01BQ6",
"scheme_name": "EDELWEISS BALANCED
ADVANTAGE FUND - DIRECT PLAN QUARTERLY IDCW
REINVESTMENT",
"nav": 11.25,
"rta_scheme_code": "..."
}
]
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[{
"errid": 517,
"errcode": "missing",
"field": "nav_date"
}]

6.2.9 Get Payment Details

Request
POST /v2/get_payment_detail
{
"data": {
“bank_txn_ref”:””,
“order_id”: “”,
“payment_ref_id”: “”
}
}

BSE StARMF v2 API

74
 Attribute M List Type Limit Description and example(s)

bank_txn_ref C N String Bank UTR no

order_id C N String StaRMF Generated Order ID

payment_ref_id C N String Payment reference ID

In the above API, at least one of the above 3 fields is required.

Only one field can be passed.

Response
The response of the API will contain a List of Orders that matches the information passed.
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {
"order_list": [
{
"id": 1234567890123,
"exch_order_id": "...",
"type": "...",
"mem_ord_ref_id": "...",
"investor": {
"ucc": "..."
},
"member": "...",
"scheme": "...",
"amount": "...",
"cur": "...",
"is_units": "...",
"all_units": "...",
"is_fresh": "...",
"folio_num": "...",
"phys_or_demat": "...",
"settlement_no": "...",
"rta_txn_no": "...",
"rta_remark": "...",
"reg_no": "...",
"payment_ref_id": "...",
"payment_aggr_code": "...",
" settement_date": "...",
"settlement_type": "...",
"pg_ref_no": "...",
"fund_receipt_date": "...",
"status": "order_lifecycle_status",
"info": {
"min_redeem_flag": "...",
"src": "...",
"reg_no": "...",
"mem_details": {
"broker_arn": "...",
"euin_flag": "...",
"euin": "...",
"sub_br_code": "...",

BSE StARMF v2 API

75
 "sub_br_arn": "...",
"partner_id": "...",
"mem_type": "...",
"broker_code": "..."
}
},
"mem_2fa": "...",
"mem_2fa_action_at": "...",
"mem_paymt": "...",
"order_src_info": {
"src_isin": "...",
"src_sch_rta_code": "...",
"src_sch_opt": "..",
"sip_rgdt": "..",
"sip_fq": "...",
"sip_st_dt": "...",
"sip_end_dt": "..."
},
"email": "...",
"mobnum": "...",
"placed_at": "...",
"exch_mandate_id": 0,
"kyc_passed": true,
"tracker_id": "...",
"depository_acct": {
"depository": "...",
"dp_id": "...",
"client_id": "...."
},
"bank_acct": {
"ifsc": "....",
"no": "....",
"type": "....",
"name": "....",
"branch_name": "....",
"bank_city": "...."
},
"dpc": true,
"remarks": "",
"dest_scheme": "",
"matched_pa": null,
"pa_matched_at": "",
"matched_bank_rcpt": null,
"bank_matched_at": "",
"full_matched_at": "",
"rejection_reason": {
"by": "",
"reason": ""
},
"rta_resp_at": "",
"rta_resp": null,
"dp_resp": null,
"refund_details": null,
"threshold_isapproved": false,
"expires_at": "",
"order_added_at": "",
"history": [
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."

BSE StARMF v2 API

76
 }
],
"dest_folio": "",
"expiresat": "",
"nomination": [],
"holder": [],
"client_code": "...",
"holding_nature": "...",
"is_client_demat": true,
"is_client_physical": false,
"member_code": "..",
"primary_holder_name": "...",
"tax_status": "...",
"ucc_status": "...",
"allotment_details": {
"allotment_date ": "...",
"allotment_partial_full": "...",
"allotment_units": "...",
"short_units": "...",
"allotment_amount": "...",
"allotment_nav": "...",
"nav_date": "...",
"folio": "...",
"stt": "...",
"stamp_duty": "..."
},
"redempt_details": {
"redempt_date": "...",
"redempt_units": "...",
"redempt_amount": "...",
"redempt_nav": "...",
"nav_date": "...",
"folio": "...",
"tds": "...",
"exit_load": "...",
"payout_date": "...",
"payout_utr": "...",
"bank_acct": "...",
"paymt_mode": "...",
"dispatch_ref_no": "..."
},
" refund_details": {
"refund_receipt_date": "...",
"refund_amount": "...",
"interest_amount": "...",
"total_amount": "...",
"refund_due_date": "...",
"refund_hist": [
{
"refund_release_date": "...",
"refund_status": "...",
"refund_utr": "...",
"reversal_date": "...",
"reversal_utr": "..."
}
]
}
}
]
},
}

BSE StARMF v2 API

77
 messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "bank_txn_ref"
}
]

6.2.10 List Payment Details

Request
POST /v2/list_payment_detail
{
"data": [{
“bank_txn_ref”:””,
“order_id”: “”,
“payment_ref_id”: “”
}]
}

Attribute M List Type Limit Description and example(s)

bank_txn_ref C N String Bank UTR no

order_id C N String StaRMF Generated Order ID

payment_ref_id C N String Payment reference ID

In the above API, at least one of the above 3 fields is required.

Only one field can be passed.
In the List API, a maximum of 50 objects can be passed.

Response
The response of the API will contain a List of Orders that matches the information passed.
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"data": {

BSE StARMF v2 API

78
 "payment_detail": [
{
"bank_txn_ref": "1231231231",
"order_id": "",
"payment_ref_id": "",
"order_list": [
{
"id": 1234567890123,
"exch_order_id": "...",
"type": "...",
"mem_ord_ref_id": "...",
"investor": {
"ucc": "..."
},
"member": "...",
"scheme": "...",
"amount": "...",
"cur": "...",
"is_units": "...",
"all_units": "...",
"is_fresh": "...",
"folio_num": "...",
"phys_or_demat": "...",
"settlement_no": "...",
"rta_txn_no": "...",
"rta_remark": "...",
"reg_no": "...",
"payment_ref_id": "...",
"payment_aggr_code": "...",
" settement_date": "...",
"settlement_type": "...",
"pg_ref_no": "...",
"fund_receipt_date": "...",
"status": "order_lifecycle_status",
"info": {
"min_redeem_flag": "...",
"src": "...",
"reg_no": "...",
"mem_details": {
"broker_arn": "...",
"euin_flag": "...",
"euin": "...",
"sub_br_code": "...",
"sub_br_arn": "...",
"partner_id": "...",
"mem_type": "...",
"broker_code": "..."
}
},
"mem_2fa": "...",
"mem_2fa_action_at": "...",
"mem_paymt": "...",
"order_src_info": {
"src_isin": "...",
"src_sch_rta_code": "...",
"src_sch_opt": "..",
"sip_rgdt": "..",
"sip_fq": "...",
"sip_st_dt": "...",
"sip_end_dt": "..."
},
"email": "...",

BSE StARMF v2 API

79
 "mobnum": "...",
"placed_at": "...",
"exch_mandate_id": 0,
"kyc_passed": true,
"tracker_id": "...",
"depository_acct": {
"depository": "...",
"dp_id": "...",
"client_id": "...."
},
"bank_acct": {
"ifsc": "....",
"no": "....",
"type": "....",
"name": "....",
"branch_name": "....",
"bank_city": "...."
},
"dpc": true,
"remarks": "",
"dest_scheme": "",
"matched_pa": null,
"pa_matched_at": "",
"matched_bank_rcpt": null,
"bank_matched_at": "",
"full_matched_at": "",
"rejection_reason": {
"by": "",
"reason": ""
},
"rta_resp_at": "",
"rta_resp": null,
"dp_resp": null,
"refund_details": null,
"threshold_isapproved": false,
"expires_at": "",
"order_added_at": "",
"history": [
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."
}
],
"dest_folio": "",
"expiresat": "",
"nomination": [],
"holder": [],
"client_code": "...",
"holding_nature": "...",
"is_client_demat": true,
"is_client_physical": false,
"member_code": "..",
"primary_holder_name": "...",
"tax_status": "...",
"ucc_status": "...",
"allotment_details": {
"allotment_date ": "...",
"allotment_partial_full": "...",
"allotment_units": "...",
"short_units": "...",

BSE StARMF v2 API

80
 "allotment_amount": "...",
"allotment_nav": "...",
"nav_date": "...",
"folio": "...",
"stt": "...",
"stamp_duty": "..."
},
"redempt_details": {
"redempt_date": "...",
"redempt_units": "...",
"redempt_amount": "...",
"redempt_nav": "...",
"nav_date": "...",
"folio": "...",
"tds": "...",
"exit_load": "...",
"payout_date": "...",
"payout_utr": "...",
"bank_acct": "...",
"paymt_mode": "...",
"dispatch_ref_no": "..."
},
" refund_details": {
"refund_receipt_date": "...",
"refund_amount": "...",
"interest_amount": "...",
"total_amount": "...",
"refund_due_date": "...",
"refund_hist": [
{
"refund_release_date": "...",
"refund_status": "...",
"refund_utr": "...",
"reversal_date": "...",
"reversal_utr": "..."
}
]
}
}
]
}
]
}
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,

BSE StARMF v2 API

81
 "errcode": "required",
"field": "bank_txn_ref"
}
]

6.2.11 2FA Link

Request
POST /v2/get_2fa_link
{
"data": {
[
{
"event": “...”,
“order”:”...”
},{
"event": “...”,
“sxp”:”...”
},{
"event": “...”,
“mandate”:”...”
},{
"event": “...”,
“investor”:{},
“parent_client_code”:””
}
]
}
}

Attribute M List Type Limit Description and example(s)

event Y N Enum 2fa_event

For events ‘ucc_ auth’ / ‘ucc_elog’ / ‘ucc_nomination’

investor C N Object Investor/Client code: UCC Investor

Mandatory for events ‘ucc_auth’ / ‘ucc_elog’ /
‘ucc_nomination’

parent_client_c C N String Parent Client Code.

ode If available, then pass for events ‘ucc_auth’ / ‘ucc_elog’ /
‘ucc_nomination’

member C N String Member code

For events ‘order’

order C N String Order ID

Mandatory for event ‘order’

For events ‘sxp’

sxp C N String SxP registration number

Mandatory for event ‘sxp’/’sxp_topup’

For events ‘mandate’

BSE StARMF v2 API

82
 mandate C N String Mandate registration number
Mandatory for event ‘mandate’

For events ‘nfo’

nfo C N String NFO Order ID

Mandatory for event ‘nfo’

For events ‘nft_nominee’ / ‘nft_contact’ / ‘nft_bank_acc’

request_id C N String Request ID generated by the systems

Response

Attribute M List Type Limit Description and example(s)

member Y N Object Member

investor Y N Object Investor/Client code: UCC Investor

parent_client_c C N String Parent Client Code.

ode

action Y Y Object {
"status": "success",
"data": [
{
"member": "0103",
"investor": {
"client_code": "123456006",
"pan_holder": null,
"holding_nature": ""
},
"parent_client_code": "",
"action": {
"msgcode": "",
"at": "2024-11-05T12:45:47.792797Z",
"event": "verify_order_new",
"event_object": [
{
"holder_rank": "",
"pan": "",
"2fa_url": "www.google.com"
}
]
}
},
{
"member": "0103",
"investor": {
"client_code": "",
"pan_holder": null,
"holding_nature": ""
},
"parent_client_code": "",
"action": {
"msgcode": "",
"at": "2024-12-18T16:00:44.28054Z",
"event": "verify_sxp_reg",
"event_object": [
{

BSE StARMF v2 API

83
 "holder_rank": "",
"pan": "",
"2fa_url":
"http://localhost:8082/s4/2fa_view_object/sxp/22ec71d9-50f
1-4257-a813-956af06d4824"
}
]
}
},
{
"member": "0103",
"investor": {
"client_code": "1234560041",
"pan_holder": null,
"holding_nature": ""
},
"parent_client_code": "",
"action": {
"msgcode": "",
"at": "2024-12-15T11:48:08.271328Z",
"event": "verify_mandate_cancel",
"event_object": [
{
"holder_rank": "",
"pan": "",
"2fa_url":
"http://localhost:8082/s4/2fa_view_object/mandate/0a48a5
82-581d-4c15-b5a4-a299676af087"
}
]
}
},
{
"member": "MBR00100",
"investor": {
"client_code": "ucc45",
"pan_holder": null,
"holding_nature": ""
},
"parent_client_code": "",
"action": {
"msgcode": "",
"at": "2025-01-15T17:35:19.25622Z",
"event": "UCC_ELOG",
"event_object": [
{
"holder_rank": "1",
"pan": "NOTPA0008A",
"2fa_url":
"http://localhost:8080/2fa_view_object/ffa1adf5-33e6-4ad6-
848e-f5dd12895cf0"
}
]
}
}
],
"messages": null
}

Sample Failure response

Attribute M List Type Limit Description and example(s)

BSE StARMF v2 API

84
 status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

[
{
"msgid": 522,
"errcode": "required",
"field": "event"
}
]

6.2.12 Mandate Register

6.2.12.1 Mandate Register

Request
POST /mandate_register
{
"data": {
"investor": {
"ucc": "8kr4EBmr"
// "pan_holders": [
// ""
// ],
// "holding_nature": "SI"
},
"member":"0103",

"mem_details": {
"euin": "",
"euin_flag": true,
"sub_br_code": "code",
"sub_br_arn": "arn",
"partner_id": "partner_id"
},

// "parent_client_code": "87654678",
"investor_bank_details": {
"ifsc": "UTIB0000145",
"no": "6986598569865",
"type": "SA",
"name": "John Doe",
"branch": "Ghansoli",
"vpa": [
"7558329269@ybl"
]
},

"mem_mandate_info": {
"member_mandate_id": "MM123456789",
"mandate_status_date": "2024-02-12T10:30:00Z",
"umrn_number": "UMRN987654321",
"utility_code": "UTL000123",

BSE StARMF v2 API

85
 "sponsor_code": "SPN456789"
},

"amount": 100,
"start_date": "2025-02-18",
"valid_till": "2065-02-15",
"reg_date": "2023-02-15",
"type": "U",
"mode": "DD",
"frequency": "AS AND WHEN PRESENTED",
"request_type": "Entry"
}
}

Attribute M List Type Limit Description and example(s)

investor Y N Object Client code of the UCC. Investor

member N N String Member code

mem_details N N Object "mem_details": {

"euin": "E345671",
"euin_flag": true,
"sub_br_code": "IN456789",
"sub_br_arn": "ARN-435674",
"partner_id": ""
}

investor_bank_ Y N Object Bank Account bank_acct

details

mem_mandate_ N N Object mem_mandate_info(mandate)

info

amount Y N Decimal Maximum amount for the mandate

start_date Y N Date Start Date of the mandate

valid_till Y N Date End date of the mandate

reg_date Y N Date Registration Date

type Y N String Mandate Types: (N (ENACH), X(NACH), U(UPI))

mode Y N String ACH or DD

frequency N N String Frequency of the mandate

request_type N N String REGISTRATION or ENTRY

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

BSE StARMF v2 API

86
 data Y Y object {
"status": "success",
"data": {
"investor": {
"ucc": "8kr4EBmr"
},
"member": "0103",
"exch_mandate_id": 8
},
"messages": null
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": {
"investor": {
"ucc": "CLNT0285"
},
"member": "0103"
},
"messages": [
{
"msgid": 3579,
"errcode": "invalid",
"field": "request_type",
"vals": [
"Entr1y"
]
}
]
}

BSE StARMF v2 API

87
6.2.13 Mandate Fetch Details

6.2.13.1 Mandate Fetch Details

Request
POST /mandate_get

{
"data": {
"exch_mandate_id": 18
}
}

Attribute M List Type Limit Description and example(s)

exch_mandate_ Y N Integer Mandate id from the exchange

id

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"status": "success",
"data": {
"exch_mandate_id": 18,
"investor_bank_details": {
"no": "980000000000",
"vpa": [
"7558329269@ybl"
],
"ifsc": "ABHY0065002",
"name": "John Doe",
"type": "SA",
"branch": "Ghansoli",
"micr_code": ""
},
"max_txn_amt": 3007,
"cur": "INR",
"valid_till": "2065-02-15T00:00:00Z",
"status": "C",
"start_date": "2025-02-15T00:00:00Z",
"reg_date": "2025-02-15T00:00:00Z",
"type": "N",
"ucc": "CLNT10082",
"member": "0103",
"cancelled_at": "2025-02-15T16:58:45Z",
"created_at": "2025-02-15T16:58:45Z",
"details": {
"field1": "",

BSE StARMF v2 API

88
 "blod_id": ""
},
"others": {
"mem": {
"member_id": "",
"broker_code": ""
},
"mode": "ACH",
"status": {
"RC": {
"when":
"2025-02-15T16:57:00.28559441+05:30"
}
},
"investor": {
"ucc": "CLNT10082"
},
"frequency": "MONTHLY",
"debit_type": "Maximum",
"client_name": "",
"request_type": "ENTRY",
"mem_mandate_info": {
"umrn_number": "UMRN987654321",
"sponsor_code": "SPN456789",
"utility_code": "UTL000123",
"member_mandate_id": "MM123456789",
"mandate_status_date": "2024-02-12T10:30:00Z"
}
},
"audit_trail": [
{
"msg": "Mandate registered successful 2FA
Pending",
"user": "member/0103/memberremiges01",
"when": "2025-02-15T11:27:00.285774865Z",
"event_status": "mandate_registered"
},
{
"msg": "Mandate registered successfully",
"user": "0103",
"when": "2025-02-15T11:27:39.988472315Z",
"event_status": "mandate_register"
},
{
"msg": "Mandate cancelled pending for investor
auth awaited",
"user": "0103",
"when": "2025-02-15T11:28:01.230610171Z",
"event_status": "mandate_cancel"
},
{
"msg": "Member cancelled mandate",
"user": "0103",
"when": "2025-02-15T11:28:45.3867424Z",
"event_status": "mandate_cancel"
}
]
},
"messages": []
}

BSE StARMF v2 API

89
 messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": null,
"messages": [
{
"msgid": 3663,
"errcode": "id_does_not_exist",
"field": "id"
}
]
}

6.2.14 Mandate List Fetch

6.2.14.1 Mandate List Fetch

Request
POST /mandate_list

{
"data": {
"start": 0,
"length": 50,
"fields": [
"id",
"umrn",
"src_acct",
"dest_acct",
"max_txn_amt",
"cur",
"valid_till",
"type",
"details",
"is_active",
"is_verified",
"verified_on",

BSE StARMF v2 API

90
 "verified_by_org",
"cancelled_at",
"cancelled_by",
"created_at",
"ALL"
],
"format": "json",
"count_only": false,
"sort_dir": "a",
"is_compressed": false,
"search": {
"value": ""
},
"filter_param": {
"is_active": false,
"is_verified": true,
"type": null,
"member_code": "",
"status": null,
"ucc": "",
"created_at_after": "",
"created_at_before": ""
}
}
}

Attribute M List Type Limit Description and example(s)

count_only Y N Boolean Will return count of records, if the value is true

fields Y Y Object [“ALL”]

start Y N Integer 0

length Y N Integer 100

filter_param N Y Object mandate_filter_param

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"status": "success",
"data": {
"lists": [
{
"exch_mandate_id": 8,
"ucc": "8kr4EBmr",
"man_2fa": "n",
"man_2fa_action_at": "2023-02-15 00:00:00",
"member_code": "0103",
"amount": 100,

BSE StARMF v2 API

91
 "cur": "INR",
"ifsc": "UTIB0000145",
"acct_no": "6986598569865",
"bank_name": "John Doe",
"bank_branch": "Ghansoli",
"acct_type": "SA",
"mode": "DD",
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"reg_date": "2023-02-15",
"start_date": "2025-02-18",
"end_date": "2065-02-15",
"type": "U",
"details": {
"field1": "",
"blod_id": ""
},
"is_verified": true,
"cancelled_at": "2025-02-18",
"status": "C",
"created_at": "2025-02-18",
"audit_trail": [
{
"msg": "Mandate registered successful",
"user": "member/0103/isec.maker",
"when": "2025-02-18T12:05:45.064084815Z",
"event_status": "mandate_registered"
},
{
"msg": "Member cancelled mandate",
"user": "0103",
"when": "2025-02-18T12:15:09.298791747Z",
"event_status": "mandate_cancel"
}
],
"others": {
"mode": "DD",
"status": null,
"investor": {
"ucc": "8kr4EBmr"
},
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"client_name": "",
"mem_details": {
"euin_flag": true,
"member_id": "",
"partner_id": "partner_id",
"sub_br_arn": "arn",
"broker_code": "",
"sub_br_code": "code"
},
"request_type": "Entry",
"mem_mandate_info": {
"umrn_number": "UMRN987654321",
"sponsor_code": "SPN456789",
"utility_code": "UTL000123",
"member_mandate_id": "MM123456789",
"mandate_status_date":
"2024-02-12T10:30:00Z"
}
},

BSE StARMF v2 API

92
 "identifier": {
"identifier": {}
}
}
],
"total_count": 1
},
"messages": null
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": null,
"messages": [
{
"msgid": 3663,
"errcode": "id_does_not_exist",
"field": "id"
}
]
}

6.2.15 Mandate Modify

6.2.15.1 Mandate Modify

Request
POST /mandate_update

{
"data": {
"investor": {
"ucc": "8kr4EBmr"

BSE StARMF v2 API

93
 // "pan_holders": [
// ""
// ],
// "holding_nature": "SI"
},
"exch_mandate_id":11,
"member":"0103",
"identifier": {
"identifier_type": "nach_scan_img",
"file_name": "nach_scan_img.png",
"file_blob":
"iVBORw0KGgoAAAANSUhEUgADvYzDaqbjaCrqZaWiZd1p8VEQniXDqZHUGG/aG3efRLslvShm0At/YKHH
gCdTVXtYIztRYiEhxqdZfdDkUM4s4mtRpIvMtoRC6DhXZPPmJvpce+bIVq3TjxChBzl+CoiKHWZ/mybmw
UEjSdttSdxYZTYnYbj0Fs2Vt/vcZq1lDSYELvB6E+N8UYbUEtllAU6WYoCX9amEPSFzkijMq1G9XVal7m
DGNkoGRMJ+CQ4hbf480wR6Pr1CtFWFTdnSy6DPELeN+2uWlnF7MemCHRV3ame1K+yum6/HWxy0uRlOG/K
QM91T2p8lf6dwPzQs4vyOo7LQFd9DUJntnjs7UbULxZFoOs/oL9OybGbaa1nixLQ1XzcW6fz9O8E80Ct0
ZV+MWh4XwK6dwZxWqe51pzSgTh5/1RVX39V/bjxuAB0Vd/1pnbTkGQQO2qN5/wF7erLGHtR+/PMltBu5t
TXkpY6OXZ+C3r2FIeH+aL7xK8vP5qtoeufYQB1mmutQxZZp03HvajhfGvoqj7VSiuwz+Rh5ecXt+rf9u1
lf/ybv2udL+a9qNVsCPSameuDmBH4n8qpk3d1Pr1e+naaN3o8zNUQH8DS+Nn0Rh8C0m9VfwKq1TcnqkZW
Vt6TaP4os/YuLToclqpJy1UB6DAWYysQ/CL6a9ZP0yfstTeHvE5RfS3yiJtOSkDbsWjr8gppphWVtdM+M
zhpvbYl220yCFpS27q19t15VgK6qsaeSQdbA3h8L62Y1L24LQgL09GSGcdxoEmFLAAr+n0R6PoCE173JE
5SGvJUYh3yseuevgtvaBe1TuwVraJwUUZpO3ECaUhM4Qn9MssVfI7w1NGSO8dqyUMufqA+8nW6B9ZloCu
b9jRbgYach6TWkvQXtO66FfcB+TgA7jkSQbPS0BSCduPH6+mbER+DH4Y6paa9cNbRxVZqPi52GVnFp0+4
LAXtE6x3nWcEUpqMocQcLL4LCaFe39IHpOjFXcByk9H43FIC2p1hxLTQWgAtw0iF/sAO6Oozj0UaEErkJ
nfrq2LQPlWRmpxk4wIJL0pTPNjV0gOCHMlhh9RnF47KQVf/RW6HWyKrgM/N1D6t0l6dSjensY9kSepWeF
8Q2rYkikgRdVCBSlZ9dyy6qvodpC55shpajiwF/TuKlnTC5YbjUjCP/Yd/dlVlUOXhJzLgoBvmv/ndrbE
ILX0bQmg17zYddVVV34UMFCQIz+0/I6YtXaDOiwomSXSmgjemq+GfIe4tY5HLtSkJXZlPCN8oOo7Gzqqm
MeG0y1VZaJv2AFa1s6w+IJ51xo+t/YPgeFKVhXbTBq2hV9E3nZecQ5+1LGczXmno+hPqngVw0VHVfFlpC
WJRGtpdFuguqEU7NxQ7B+JKpTU0xaGtRIRFdMtPVlk7Vy86Ut5yj0ny2AE0G6SPq63U66qax7DDP1rHmx
1AV80f2KW0e7Dg==",
"file_size": 1024
}
}

Attribute M List Type Limit Description and example(s)

investor Y N Object Client code of the UCC. Investor

exch_mandate_ Y N Integer Mandate ID

id

member N N String Member code

identifier N N Object identifier

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {

BSE StARMF v2 API

94
 "status": "success",
"data": {
"investor": {
"ucc": "8kr4EBmr"
},
"member": "0103",
"exch_mandate_id": 11
},
"messages": null
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": null,
"messages": [
{
"msgid": 3663,
"errcode": "id_does_not_exist",
"field": "id"
}
]
}

6.2.16 Mandate Cancel

6.2.16.1 Mandate Cancel

Request
POST /mandate_cancel

{
"data": {
"ids": [21],
"investor": {
"ucc": "CLNT10082"
// "pan_holders": [
// ""
// ],

BSE StARMF v2 API

95
 // "holding_nature": "SI"
}
// "parent_client_code": ""
}
}

Attribute M List Type Limit Description and example(s)

ids Y Y Array Mandate IDs to be cancelled

investor N N Object Client code of the UCC. Investor

parent_client_c N N String Parent client code of the UCC or Investor

ode

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"status": "success",
"data": {
"success_id": [
21
],
"investor": {
"ucc": "CLNT10082"
}
},
"messages": []
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": null,
"messages": [
{
"msgid": 3517,
"errcode": "missing",

BSE StARMF v2 API

96
 "field": "ids",
"vals": [
"211"
]
}
]
}

6.2.17 Mandate Link

6.2.17.1 Mandate Link

Request
POST /link_mandate

{
"data": {
"reg_no":"5178b85e-c177-467a-8cdf-15880550e3fb",
"exch_mandate_id": 23
}
}

Attribute M List Type Limit Description and example(s)

reg_no Y N String SXP Registration Number

exch_mandate_ Y N Integer Exchange Mandate ID

id

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object {
"status": "success",
"data": {
"reg_no": "5178b85e-c177-467a-8cdf-15880550e3fb"
},
"messages": []
}

messages Y Y object []

BSE StARMF v2 API

97
 Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": null,
"messages": [
{
"msgid": 3507,
"errcode": "record_not_found",
"field": "reg_no",
"vals": [
"5178b85e-c177-467a-8cdf-15880550e3fk"
]
}
]
}

6.2.18 Mandate Delink

6.2.18.1 Mandate Delink

Request
POST /mandate_delink

{
"data": {
"reg_nos": ["5178b85e-c177-467a-8cdf-15880550e3fb"]

}
}

Attribute M List Type Limit Description and example(s)

reg_nos Y N Array SXP Registration Numbers

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

BSE StARMF v2 API

98
 data Y Y object {
"status": "success",
"data": {
"SuccessIds": [
"5178b85e-c177-467a-8cdf-15880550e3fb"
],
"FailedIds": null
},
"messages": null
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

{
"status": "error",
"data": {
"SuccessIds": null,
"FailedIds": [
"5178b85e-c177-467a-8cdf-15880550e3fk"
]
},
"messages": [
{
"msgid": 3507,
"errcode": "record_not_found",
"field": "reg_no",
"vals": [
"5178b85e-c177-467a-8cdf-15880550e3fk"
]
}
]
}

6.2.19 Mandate Status Webhook

6.2.19.1 Mandate Status Webhook

BSE StARMF v2 API

99
6.2.20 Request Single Payment BSE PG

6.2.20.1 Request Single Payment BSE PG

Request
POST /get_exchpg_service

"data": {
"mem_details": {
"member": "0103",
"euin": "",
"euin_flag": false,
"sub_br_code": "",
"sub_br_arn": "",
"partner_id": ""
}
"investor": {
"ucc": "UCC_CODE01"
},
"order_ids": [50000123,50000124],
"requested_method": "bse_pg_page",
"payment_mode": [ "upi", "netbanking", "mandate"]
"redirection_url": "",
}

Attribute M List Type Limit Description and example(s)

mem_details N N Object Details of the member

investor Y N Object Client code of the UCC. Investor

order_ids Y Y Integer Array of order_ids

requested_meth Y N String Enum value 'bse_pg_page' , or “payment_info_data”

od

payment_mode Y Y String The possible values are upi, netbanking, mandate.

redirection_url Y N String url on which the user journey will be redirected

after user activity for the payments is
completed from bse_pg_page.

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object
"data": {
"exch_pg_page_link":
"http://localhost:8082/s4/pg_view_object/11757dcc-43f3-4
537-a1f6-a3eefc2b0cb5",
"payment_information": {
"payment_mode": "",

BSE StARMF v2 API

100
 "get_bank_account_details_row": null,
"mode_additional_info": ""
}
}

If the requested_method is “payment_info_data”, the

following response will come:
"data": {
"payment_information": [
{
"payment_mode": "upi",
"get_bank_account_details_row": [
{
"account_number": "980000000000",
"ifsc_code": "ABHY0065002",
"bank_code": null,
"bse_bank_code": "ABHY"
},
{
"account_number": "78700000000",
"ifsc_code": "ABHY0065002",
"bank_code": null,
"bse_bank_code": "ABHY"
}
],
"mandate_ids": null,
"mode_additional_info": "upi"
},
{
"payment_mode": "netbanking",
"get_bank_account_details_row": [
{
"account_number": "980000000000",
"ifsc_code": "ABHY0065002",
"bank_code": null,
"bse_bank_code": "ABHY"
},
{
"account_number": "78700000000",
"ifsc_code": "ABHY0065002",
"bank_code": null,
"bse_bank_code": "ABHY"
}
],
"mandate_ids": null,
"mode_additional_info": "Net banking"
},
{
"payment_mode": "mandate",
"get_bank_account_details_row": null,
"mandate_ids": null,
"mode_additional_info": "Mandates"
}
],
"exch_pg_page_link":
"http://localhost:8082/send_payment_info"
}

BSE StARMF v2 API

101
 messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

"messages": [
{
"msgid": 3507,
"errcode": "record_not_found",
"field": "order",
"vals": [
"50000000025"
]
}
]

6.2.21 Request Send Payment Info BSE PG

6.2.21.1 Request Send Payment Info BSE PG

Request
POST /send_payment_info

{
"data": {
"payment_mode": "upi",
"order_ids": [5000000969],
"ucc": "CLNT10102",
"member": "0103",
"amount": 7000,
"currency": "INR",
"return_url": "https://www.google.com/",
"payment_details": {
"vpa": "success@razorpay",
"bank_id": "HDFC",
"account_number": "980000000000"
}
}
}

Attribute M List Type Limit Description and example(s)

payment_mode Y N String Possible values are- upi or netbanking or mandate

order_ids Y Y Integer Array of order_ids

BSE StARMF v2 API

102
 ucc Y N String Client code of the UCC

member Y N String Member code of the UCC

amount Y N Float The amount of the orders selected

currency Y N String Always INR

return_url Y N String URL on which the user will be redirected to

payment_details Y N Object The payment details of UCC.

"vpa": "success@razorpay",
"bank_id": "HDFC",
"account_number": "980000000000",
“mandate_id”: 123

Response
Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y object
If the payment is successful for UPI:
"data": {
"payment_ref_id":
"RZ20250421110850853132DC62A50D",
"status": "SUCCESS",
"message": "Payment successful",
"transaction_id": "pay_QLaxCKcQwaGZwm",
"next_step": "poll",
"links": [
{
"href":
"https://api.razorpay.com/v1/payments/pay_QLaxCKcQwa
GZwm",
"rel": "poll",
"method": ""
}
]
}

If the payment is not successful for UPI:

"data": {
"payment_ref_id":
"RZ2025042111095958700513EC98A2",
"status": "FAILED",
"message": "Payment failed: Payment failed: Payment
was unsuccessful due to a temporary issue. If amount got
deducted, it will be refunded within 5-7 working days.",
"transaction_id": "pay_QLayO9c4U32OmW",
"next_step": "poll",
"links": [
{
"href":
"https://api.razorpay.com/v1/payments/pay_QLayO9c4U32

BSE StARMF v2 API

103
 OmW",
"rel": "poll",
"method": ""
}
]
}

messages Y Y object []

Sample Failure response

Attribute M List Type Limit Description and example(s)

status Y N String "error"

data Y Y object {}

messages Y Y object Array of messages:

"messages": [
{
"msgid": 579,
"errcode": "invalid",
"field": "payment_mode",
"vals": [
"Payment mode must be one of: netbanking, upi,
mandate, got: upiiiiiiiiiiiiiiiiiiii"
]
}
]

6.2.22 Webhook BSE Payment Gateway

6.2.22.1 Webhook BSE Payment Gateway

6.3 Webhook Listing

6.3.1 Webhook
Request
POST /v2/wh_starmfv2

{
"data": {

BSE StARMF v2 API

104
 "member": { … },
"investor": { ... },
}
}

Attribute M List Type Limit Description and example(s)

entity_type Y N Enum “member”

“pa”
“bank”
“collection_agency”

member C N Object Refer Member

investor Y N Object Refer Investor

request_id Y N String Request ID from StAR MF system

action Y Y Object {
"msgcode": “”,
"at": "", //received by StARMF platform
"event_type":wh_event_type,
"event": wh_event,
"event_message": "",
“order_Id” : “”,
“mandate_id”: “”,
“sxp_reg_num”: “”,
“pg_order_ids” : “”,
“payment_ref_id”: “”
"data":{
//nft_response_obj
}
}

msgcode: These will start from 10000

Example:
{
"entity_type": "member",
"member": {
"member_id": "...",
"subbr_code": "",
"subbr_arn": "",
"euin": "",
"euin_flag": "",
"partner_id": ""
},
"parent_client_code": "",
"investor": {
"ucc": "...",
"pan_holders": "...",
"holding_natire": "...",
"client_code": "...",
},
"request_id": "2024102900000001",
"action": {

BSE StARMF v2 API

105
 "msgcode": "10010",
"at": "2024-10-29T12:52:24+05:30",
"event_type": "...",
"event": "...",
"event_message": "...",
"order_id": “...”,
​ "mem_ord_ref_id": “...”,
“mandate_id”: “...”,
“sxp_reg_num”: “...”,
“pg_order_ids”: [7001,7002],
“payment_ref_id”: “...”
}
}

Response
{
"data": {
"member": { … },
"investor": { ... },
}
}

Attribute M List Type Limit Description and example(s)

request_id Y N String Request ID from StAR MF system

ack Y Y Object {
"status": "success",
"data": {
"id": "1"
},
"messages": []
}
Refer to webhook_ack

7 Annexure

7.1 Environments
Sandbox

URL

Production

URL

BSE StARMF v2 API

106
7.2 Masters and Enumerated values
This is a representative list only. Please refer to the platform website for the latest updates
for all masters.

7.2.1 Country List

Country

7.2.2 Tax Code

tax_status

7.2.3 Holding Nature

holding_nature

7.2.4 Bank Account Types

bank_acc_type

7.2.5 Transaction Code

Possible values are

NEW: For new orders

MOD: To modify orders placed earlier (subject to business process constraints)
CXL: To cancel orders placed earlier (subject to business process constraints)

7.2.6 Payment Receipt Modes

(These modes are applicable where investor had made a payment to CC)
DIRECTDEBIT
NEFT
RTGS
NACH
UPI

7.3 Objects

7.3.1 Member
{
"memberid": "...",
"brokercode": "..."
"subbrcode": "...",
"subbrarn": "...",

BSE StARMF v2 API

107
 "euin": "...",
"euinflag": "...",
"partnerid": "..."
}

Attribute M List Type Len Description and example(s)

member_id Y N String 20 Member Code, assigned by the platform at the time of

onboarding

subbr_code N N String 15 Sub Broker Code

subbr_arn N N String 20 Sub Broker ARN Code

euin C N String 20 EUIN Number, only for specific APIs

euin_flag C N String 1 EUIN declaration (Y | N), only for specific APIs

partner_id N N String Partner Code, assigned by the Platform to each ISV,

required when a member uses services provided by ISV

7.3.2 Investor
{
"ucc": "...",
}

OR

{
"panholders": [ PAN number of Holder 1, PAN number of Holder 2, … ],
"holdingnature": "..."
}

Attribute M List Type Len Description and example(s)

ucc C N String UCC Code

If pan_holders is not passed, then this is mandatory.

pan_holders C Y String 1-5 PAN number of Holder 1, PAN number of Holder 2, …

If ucc is not passed, then this is mandatory.

holding_nature C N Enum If more than one PAN holders are provided holding_nature
This is Mandatory when pan_holders field is passed.

7.3.3 Investor_ucc
{
"client_code": "..."
}

Attribute M List Type Len Description and example(s)

client_code Y N String client_code is mandatory.

BSE StARMF v2 API

108
7.3.4 Holder
{
}

Attribute M List Type Len Description and example(s)

holder_rank Y N Enum Rank of holder holder_rank

occ_code Y N Enum Occupation Code occ_code

auth_mode Y N Enum Holder Authentication Mode. auth_mode

is_pan_exempt Y N Boolean Is holder Exempted from PAN details

pan_exempt_ca N N Enum If the holder is PAN exempted, then Category of PAN

tegory exemption. pan_exempt_category

identifier Y Y Object Identifier Object identifier

Allowed Identifiers:
-​ pan
-​ pan_exempt_ref_no
-​ nomination_form
-​ wet_signature
-​ aadhaar_esign
-​ supporting_document (PAN and aadhaar ensign
related supporting docs if any)
Refer to identifier

kyc_type Y N Enum Type of KYC like ckyc/biometric/kra/aadhaar etc kyc_type

ckyc_number N N String Ckyc number if kyc_type is `ckyc`

Only numeric value is allowed here

person Y Y Object 3 Person Object. person

contact Y Y Object Contact Object. contact

nomination N Y Object 5 Nomination Object (provided only under first holder).

nomination

7.3.5 bank_account
{
}

Attribute M List Type Len Description and example(s)

ifsc_code Y N String IFSC code of the Bank

bank_acc_num Y N String Bank Account Number (including leading zeros).

Minimum Length=9 | Maximum Length=20

bank_acc_type Y N Enum Type of Bank Account like Savings/Current etc.

bank_acc_type

bank_acc_owne C N Enum Mandatory only if UCC is a Minor or Custodian during

r creation of UCC / addition of bank account for UCC.
bank_acc_owner
Not required for Order

BSE StARMF v2 API

109
 identifier C Y Object List of valid identifier objects. Identifier
Allowed Identifiers:
-​ cancel_cheque
-​ bank_statement
-​ bank_log
Refer to identifier

bank_name N N String This field is not to be passed in add_ucc, order_new,

order_update and any other (create or modify API) request.​
It will only be part of the response in get_ucc, list_ucc,
get_order etc.

7.3.6 depository
{
}

Attribute M List Type Len Description and example(s)

depository_cod Y N Enum Depository code for CDSL/NSDL. depository_code

e

dp_id Y N String dp id provided by depository

Minimum Length=8 | Maximum Length=8

client_id Y N String Client id provided by depository

Minimum Length=8 | Maximum Length=8

cmbp_id C N String Clearing Member Business Partner ID provided by NSDL

Minimum Length=8 | Maximum Length=8. This is
mandatory for CDSL, but not for NSDL.

bank_account Y N String Bank Account Number linked to this Depository Account.

account_owner Y N Enum Owner of the Depository account like Self or Guardian.

account_owner

identifier N Y Object Identifier Object. Identifier

Allowed Identifiers:
-​ cml_copy
Refer to identifier

is_default Y N Boolean Is this account a default account?

7.3.7 comm_addr
{
}

Attribute M List Type Len Description and example(s)

address_line_1 Y N String Address Line 1

Minimum Length=10 | Maximum Length=120

address_line_2 N N String Address Line 3

Minimum Length=10 | Maximum Length=120

address_line_3 N N String Address Line 3Minimum Length=10 | Maximum

BSE StARMF v2 API

110
 Length=120

postalcode Y N String Postalcode / Pincode

city Y N String City

state Y N String State

country Y N String Country

7.3.8 addr
{
}

Attribute M List Type Len Description and example(s)

address_line_1 Y N String Address Line 1

Minimum Length=10 | Maximum Length=120

address_line_2 N N String Address Line 3

Minimum Length=10 | Maximum Length=120

address_line_3 N N String Address Line 3

Minimum Length=10 | Maximum Length=120

city Y N String City

state Y N String State

country Y N String Country

postalcode Y N String Postalcode / pincode

7.3.9 contact
{
}

Attribute M List Type Len Description and example(s)

contact_number C N String Contact Number of the holder(e.g. 9988776655)

extension C N String Extension of the holder in case of landline (e.g. 22051). If

the contact_type is RE or OF, this attribute is required.

country_code C N String Country code or calling code of the holder (e.g. +91)

whose_contact_ C N Enum Whose contact number is this. For e.g. Self/Parent/Spouse

number etc. whose_contact_number

email_address Y N String Email address of the holder.​

Minimum Length=10
Maximum Length=200

whose_email_a C N Enum Whose email id is this. For e.g. Self/Parent/Spouse etc.

ddress whose_email_address

BSE StARMF v2 API

111
 contact_type Y N Enum Contact is Office/Residence. contact_type

fax_no C N String If the contact_type is RE or OF, this attribute is required.

7.3.10 nomination
{
}

Attribute M List Type Len Description and example(s)

person Y N Object person

nomination_per C N String Nomination percentage

cent

nomination_rela Y N Enum Nominee relationship for e.g. Son/Father/Mother etc.

tion nomination_relation

is_pan_exempt Y N Boolean Is the nominee PAN Exempted

pan_exempt_ca N N Enum If the nominee is PAN exempted, then what is the pan
tegory exempt category. pan_exempt_category

identifier Y Y Object 1 Identifier block for PAN/PKERN. Identifier

Allowed Identifiers:
-​ pan
-​ pan_exempt_ref_no
Refer to identifier

is_minor N N Boolean Is the Nominee minor?

guardian C Y Object 1 Guardian Object in case the Nominee is a minor. Nominee:

guardian

7.3.11 Nominee: guardian

{
}

Attribute M List Type Len Description and example(s)

first_name Y N String Guardian: first name

middle_name N N String Guardian: middle name

last_name N N String Guardian: last name

dob Y N String Guardian: date of birth

is_pan_exempt Y N Boolean Guardian: is pan exempted

pan_exempt_ca N N Enum Guardian: pan exempt category in case guardian is PAN

tegory exempted. pan_exempt_category

identifier Y Y Object Guardian: Identifier block for PAN/PKERN. Identifier

Identifier block for PAN/PKERN. Identifier
Allowed Identifiers:

BSE StARMF v2 API

112
 -​ pan
-​ pan_exempt_ref_no
Refer to identifier

7.3.12 PAN holder

{
"holderrank": 1,
"panno": "AAAAA1111Z",
"mobile_no": "+911111122222",
"email_id": "abc@pqr.domain"
}

Attribute M List Type Limit Description and example(s)

holder_rank Y N Integer 1-3 Rank indicates PAN Holder 1, PAN Holder 2 and so on,
wherever a UCC has more than one PAN holder.

pan Y N String 10 As per Income Tax Department issued number

kyc_status O N Mandatory where record have to be added, optional when

record have to be updated

mobile_no O N String Mandatory where a record has to be added, optional when

a record has to be updated.

email_id O N String Mandatory where record have to be added, optional when

record have to be updated

bank_accounts O Y Object 5 Bank Account object. bank_account

nominees O Y Object 3 Nominee Details. nomination

BSE StARMF v2 API

113
7.3.13 person
{
}

Attribute M List Type Limit Description and example(s)

first_name Y N String First name of the holder

middle_name N N String Middle name of the holder

last_name N N String Last name of the holder.

Note:
Minimum Length
(first_name+space+middle_name+space+last_name)=2
Maximum Length
(first_name+space+middle_name+space+last_name)=70

dob C N String Date of Birth(in case of individual holder). Date of

Register/Incorporation(in case of non-individual holder).
Not mandatory in case of Nomination.

gender N N Enum Gender of person(in case of Individual). gender

7.3.14 ubo_person
{
}

Attribute M List Type Limit Description and example(s)

first_name Y N String First name of the holder

middle_name N N String Middle name of the holder

last_name N N String Last name of the holder.

Note:
Minimum Length
(first_name+space+middle_name+space+last_name)=2
Maximum Length
(first_name+space+middle_name+space+last_name)=70

dob C N String Date of Birth(in case of individual holder). Date of

Register/Incorporation(in case of non-individual holder).
Not mandatory in case of Nomination.

gender N N Enum Gender of person(in case of Individual). gender

tax_residency Y Object Country of tax Residency. tax_residency

7.3.15 identifier
{
}

BSE StARMF v2 API

114
 Attribute M List Type Limit Description and example(s)

identifier_type Y N Enum Type of Identifier for e.g. pan/pkern/lei/passport/ etc.

identifier_type

identifier_numb Y N String Identifier number of Identifier type. For e.g. PAN number for
er identifier type “pan”

issue_date N N String Issue date of the identifier

expiry_date N N String Expiry date of the identifier

file_name N N String Name of file if being sent with the request

file_size N N Integer Size of file

file_blob N N String Base64 encoded file string

7.3.16 fatca
{
}

Attribute M List Type Limit Description and example(s)

holder_rank Y N Integer 1-3 Rank indicates PAN Holder 1, PAN Holder 2 and so on,
wherever a UCC has more than one PAN holder.

place_of_birth Y N String Place of Birth e.g. New York

Minimum Length=2 | Maximum Length=60

country_of_birth Y N String Country of Birth e.g. USA

client_name Y N String Name of person declaring FATCA. Should match with that
of holder

investor_type Y N String Type of Investor. investor_type

dob Y N String Date of birth

father_name C N String Name of Father of holder

Minimum Length=2 | Maximum Length=70

spouse_name C N String Name of Spouse of holder

Minimum Length=2 | Maximum Length=70

address_type Y N ENUM Type of Address. address_type

occ_code Y N ENUM Occupation Code. occ_code

occ_type Y N ENUM Occupation Type. occ_type

tax_status Y N ENUM Tax Status. tax_status

exemption_cod C N ENUM Exemption Code. Mandatory in case of non-individual

e exemption_code

identifier Y Object PAN is required. This PAN should match PAN of the holder.
Identifier
Allowed Identifiers:

BSE StARMF v2 API

115
 -​ pan
-​ pan_exempt_ref_no
Refer to identifier

corporate_servi Y N ENUM Corporate Service Sector. corporate_service_sector

ce_sector

wealth_source Y N ENUM Wealth Source. wealth_source

income_slab Y N ENUM Income Slab. income_slab

net_worth Y N Integer Net Worth

Minimum Length=3 | Maximum Length=20

date_of_net_wo Y N String Date on which Net Worth was calculated

rth

politically_expos Y N ENUM Is the person Politically Exposed? politically_exposed

ed

is_self_declared C N boolean Is the Declaration Self Declared?

data_source Y N ENUM Data Source. data_source

tax_residency Y Y Object 5 Country of Tax Residencies tax_residency

ffi_drnfe C N ENUM ffi_drnfe

is_giin_avail C N ENUM is_giin_avail

giin_no C N String GIIN no

Minimum Length=19 | Maximum Length=19

spr_name C N String Sponsor Name

Minimum Length=2 | Maximum Length=70

nfe_category C N ENUM nfe_category

nfe_sub_catego C N ENUM nfe_sub_category

ry

nature_of_busin C N String Nature of Business

ess Minimum Length=2 | Maximum Length=70

nature_of_relati C N ENUM nature_of_relation

on

ubo C Y Object ubo

npo C Y Object npo

7.3.17 ubo
{
}

Attribute M List Type Limit Description and example(s)

is_ubo_applicab Y N Boolean Is UBO Applicable?

le

BSE StARMF v2 API

116
 ubo_count Y N Integer No of UBO present

ubo_detail Y Y Object UBO details object. ubo_detail

7.3.18 ubo_detail
{
}

Attribute M List Type Limit Description and example(s)

person Object Person details. ubo_person

place_of_birth String Place of Birth

country_of_birth String Country of Birth

occ_code Enum Occupation Code. occ_code

occ_type Enum Occupation Type. occ_type

beneficiary_per Number Beneficiary Percent of UBO

cent

ubo_type_code Enum Type of UBO. ubo_type_code

addr object Address. addr

ubo_addr_type Enum Type of address. ubo_addr_type

contact Object Contact. contact

identifier Y Y Object 1 Identifier block for PAN. identifier

Allowed Identifiers:
-​ pan
-​ pan_exempt_ref_no
Refer to identifier

ubo_declaration Boolean UBO declaration flag

_flag

exchange_nam String Name of Exchange

e

isin String ISIN code

name_of_realte String Name of related listed company

d_listed_compa
ny

ubo_category Enum UBO Category. ubo_category

ubo_email_id String UBO Email ID

smo_designatio String SMO Designation

n Minimum Length=5 | Maximum Length=20

BSE StARMF v2 API

117
7.3.19 npo
{
}

Attribute M List Type Limit Description and example(s)

npo_form Y N Boolean Is NPO Form

npo_dcl Y N Boolean Is NPO declaration

npo_rg_no Y Y String NPO registration number

7.3.20 aof
{
}

Attribute M List Type Limit Description and example(s)

is_aof_submitte Y N Boolean Is AOF submitted

d

7.3.21 aof_ria
{
}

Attribute M List Type Limit Description and example(s)

is_aof_ria_sub Y N Boolean Is AOF submitted

mitted

7.3.22 tax_residency
{
}

Attribute M List Type Limit Description and example(s)

country Y N String Country code of residency. Refer to Country

tax_id_no Y String Tax ID No

Minimum Length=10 | Maximum Length=50

tax_id_type Y String Tax ID Type. fatca_identifier_type

7.3.23 ucc_list_filter_param
{
}

Attribute M List Type Limit Description and example(s)

BSE StARMF v2 API

118
 holding_nature N N Enum Holding nature. holding_nature

tax_status N N Enum Tax status. tax_status

is_client_physic N N Boolean Is the UCC Client Physical

al

is_client_demat N N Boolean Is the UCC Client Demat

parent_client_c N N String Parent client Code

ode

7.3.24 ucc_status_obj
{
}

Attribute M List Type Limit Description and example(s)

holders N Y Object 3 ucc_status_holder

bank_account N Y Object 5 ucc_status_bank_account

depository N Y Object 5 ucc_status_depository

transaction_rea N N Object 2 ucc_status_transaction_ready

dy

7.3.25 status_count_summary_obj
{
}

Attribute M List Type Limit Description and example(s)

status N Y Enum 3 ucc_count_status

status_count N Y Number 5 Count of objects

7.3.26 ucc_status_holder
{
}

Attribute M List Type Limit Description and example(s)

holder_rank N N Object holder_rank

holder_pan N Y String PAN of Holder

pan_verification N Y Object ucc_status_pan

fatca_status N N Object ucc_status_fatca

BSE StARMF v2 API

119
 elog N N Object ucc_status_elog

elog_ria N N Object ucc_status_elog_ria

nominee_2fa N N Object ucc_status_nominee_2fa

kyc_status N N Object ucc_status_kyc

aof N N Object ucc_status_aof

aof_ria N N Object ucc_status_aof_ria

7.3.27 ucc_status_bank_account
{
}

Attribute M List Type Limit Description and example(s)

bank_acc_num Y N String Bank Acc Number

ifsc_code Y N String IFSC code

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

verified_at N N String Timestamp of when the object was verified

7.3.28 ucc_status_depository
{
}

Attribute M List Type Limit Description and example(s)

depository_cod Y N Object depository_code

e

dp_id Y N Object DP ID of the depository account

client_id Y N Object Client ID of the depository account

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

verified_at N N String Timestamp of when the object was verified

7.3.29 ucc_status_aof / ucc_status_aof_ria / ucc_status_elog /

ucc_status_elog_ria / ucc_status_fatca
{

BSE StARMF v2 API

120
 }

Attribute M List Type Limit Description and example(s)

rta_code Y N Enum “CAMS” / “KFIN”

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

verified_at N N String Timestamp of when the object was verified

7.3.30 ucc_status_pan / ucc_status_nominee_2fa

{
}

Attribute M List Type Limit Description and example(s)

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

verified_at N N String Timestamp of when the object was verified

7.3.31 ucc_status_kyc
{
}

Attribute M List Type Limit Description and example(s)

kyc_type Y N Enum “CKYC”

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

verified_at N N String Timestamp of when the object was verified

7.3.32 ucc_status_transaction_ready
{
}

Attribute M List Type Limit Description and example(s)

mode Y N Enum “DEMAT” / “PHYSICAL”

verified_status Y N Enum “TRUE”/”FALSE”

verification_faile N N String Reason for which verification failed

d_reason

BSE StARMF v2 API

121
 verified_at N N String Timestamp of when the object was verified

7.3.33 info_order
{
}

Attribute M List Type Limit Description and example(s)

7.3.34 mem_details
{
}

Attribute M List Type Limit Description and example(s)

euin_flag Y N Boolean EUIN declaration (Y | N), only for specific APIs

euin C N String EUIN Number, only for specific APIs

broker_code N N String Broker Code

sub_br_code Y N String Sub Broker Code

sub_br_arn Y N String Sub Broker ARN Code

partner_id Y N String Partner Code, assigned by the Platform to each ISV,

required when a member uses services provided by ISV

7.3.35 depository_acct (order/sxp/mandate)

{
}

Attribute M List Type Limit Description and example(s)

depository Y N Enum Depository depository_code (order/sxp/mandate)

dp_id Y N String DP ID of Depository Account

client_id Y N String Client ID of Depository Account

7.3.36 bank_acct (order/sxp/mandate)

{
}

Attribute M List Type Limit Description and example(s)

ifsc Y N String IFSC Code of bank Account

BSE StARMF v2 API

122
 no Y N String Bank Account Number

type C N Enum Bank Account Type bank_acc_type

Mandatory for orders/sxp/mandates.

name N N String bank name

vpa N Y String UPI Address

7.3.37 mem_mandate_info(mandate)
{
}

Attribute M List Type Limit Description and example(s)

member_manda N N String Member Mandate ID

te_id

mandate_status N N String Date at which the Mandate Status is updated

_date

umrn_number N N String URN Number

utility_code N N String Utility code

sponsor_code N N String Sponsor code

7.3.38 order_list_filter_param
{
}

Attribute M List Type Limit Description and example(s)

open_close Y N Enum order_status

status N N Enum order_list_status

type N N Enum order_type - []String

ucc N N String UCC code of client. When specified, then member_code

filter value will be mandatory

member_code C N String Member Code

This is mandatory if ucc is passed

threshold_order N N Boolean Whether it is Threshold Order

amc_code N N String AMC Code

BSE StARMF v2 API

123
 sxp_reg_no N N String SXP Registration No

placed_at_after N N String Shows records based upon the timestamp range between
the specified values. In case placed_at_before is omitted
then the system will take the current timestamp as the
value. UTC Timestamp

placed_at_befor N N String Shows records based upon the timestamp range between
e the specified values.In case placed_at_after is omitted then
the system will select all data since the beginning of
operation. UTC Timestamp

"order_src_type N N [] String Values can be systematic or lumpsum.

":["lumpsum"],

7.3.39 order_holder
{
}

Attribute M List Type Limit Description and example(s)

holder_rank Y N Enum holder_rank

email N N String Email ID

mobnum N N String Mobile Number

is_nomination_o Y N Boolean Is the nomination opted for by the client?

pted

nomination_aut C N Enum If nomination is opted, then what is the nomination

h_mode authentication mode? Nomination_auth_mode

7.3.40 order_src_info
{
}

Attribute M List Type Limit Description and example(s)

src_isin N N String Source ISIN

src_sch_rta_co N N String Source Scheme RTA Code

de

src_sch_opt N N String Source Scheme Option

sip_rgdt N N String SxP register date

sip_fq N N String SxP Frequency

sip_st_dt N N String SxP Start Date

sip_end_dt N N String SxP End Date

BSE StARMF v2 API

124
7.3.41 allotment_details
{
}

Attribute M List Type Limit Description and example(s)

allotment_date N N String Allotment Date

allotment_partia N N String Is allotment Partial or Full

l_full

allotment_units N N String Allotment Units

short_units N N String Short Units

allotment_amou N N String Allotment Amount

nt

allotment_nav N N String Allotment NAV

nav_date N N String NAV Date

folio N N String Folio

stt N N String STT

stamp_duty N N String Stamp Duty

7.3.42 redempt_details
{
}

Attribute M List Type Limit Description and example(s)

redempt_date N N String Redemption Date

redempt_units N N String Redemption Units

redempt_amoun N N String Redemption Amount

t

redempt_nav N N String Redemption NAV

nav_date N N String NAV Date

folio N N String Folio

tds N N String TDS

exit_load N N String Exit Load

payout_date N N String Payout Date

payout_utr N N String Payout UTR

bank_acct N N String Bank Account

BSE StARMF v2 API

125
 paymt_mode N N String Payment Mode

dispatch_ref_no N N String Dispatch Reference Number

7.3.43 refund_details
{
}

Attribute M List Type Limit Description and example(s)

refund_receipt_ N N String Refund Receipt Date

date

refund_amount N N String Refund Amount

interest_amount N N String Interest Amount if applicable

total_amount N N String Total Amount

refund_due_dat N N String Refund Due Date

e

refund_hist N N String refund_hist

7.3.44 refund_hist
{
}

Attribute M List Type Limit Description and example(s)

refund_release_ N N String Refund release date

date

refund_status N N String Refund status

refund_utr N N String Refund UTR

reversal_date N N String Reversal Date

reversal_utr N N String Reversal UTR

7.3.45 history_obj
{
}

Attribute M List Type Limit Description and example(s)

event_status N N String Event Status

msg N N String Message

when N N String When

BSE StARMF v2 API

126
 user N N String Username

7.3.46 rejection_reason
{
}

Attribute M List Type Limit Description and example(s)

by N N String Rejection By

reason N N String Rejection Reason

7.3.47 info_sxp
{
}

Attribute M List Type Limit Description and example(s)

mem_details N N Object Member Details mem_details

7.3.48 sxp_list_filter_param
{
}

Attribute M List Type Limit Description and example(s)

sxp_type Y N Enum sxp_type

status N N Enum sxp_status

freq N N Enum sxp_freq

src_scheme N N String Source Scheme

is_topup N N Boolean If false then show non-top up records and if true then
shows top up records

reg_at_after N N String Shows records based upon the timestamp range between
the specified values.
In case reg_at_before is omitted then the system will take
the current timestamp as the value.
In case reg_at_after is omitted then system will select all
data since the beginning of operation

reg_at_before N N String

next_due_date_ N N String Shows records based upon the timestamp range between
at_after the specified values.
In case next_due_date_at_after is omitted then the system
will take the current timestamp as the value.

BSE StARMF v2 API

127
 next_due_date_ N N String
at_before

is_topup N N Boolean Filter based on topup requests

ucc N N String ucc

member N N String Member

phys_or_demat N N String order_phys_or_demat

7.3.49 sxp_special_product
{
}

Attribute M List Type Limit Description and example(s)

special_prod_ty Y N Enum Special Product Type special_products_type

pe

special_prod_n Y N String E.g. “icici_freedom_sip” or “icici_insured” or

ame “hdfc_dream_sip” or “sbi_mitra_sip”

target_scheme C N String Target scheme code(mandatory for certain types of special

products)

target_amt C N Number Target Amount (mandatory if target scheme is passed )

goal_type N N Enum Goal Type special_products_goal_type

goal_amt N N Number Goal Amount

7.3.50 mandate_list_filter_param
{
}

Attribute M List Type Limit Description and example(s)

is_active N N Boolean Is mandate Active

is_verified N N Boolean Is mandate Verified

type N N Enum mandate_type

created_at_after N N String UTC timestamp

created_at_befo N N String UTC timestamp

re

reg_at_after N N String Shows records based upon the timestamp range between
the specified values. In case reg_at_before is omitted then
the system will take the current timestamp as the value.
UTC timestamp

reg_at_before N N String Shows records based upon the timestamp range between

BSE StARMF v2 API

128
 the specified values. In case reg_at_after is omitted then
the system will select all data since the beginning of
operation. UTC timestamp

7.3.51 investor_mis
{
"ucc": "...",
}

OR

{
"panholders": [ PAN number of Holder 1, PAN number of Holder 2, … ],
"holdingnature": "..."
}
Note: One of the above objects is mandatory

Attribute M List Type Len Description and example(s)

ucc C N String Client code of UCC

panholders C N String PAN Holder combination

holding_nature C N Enum If more than one PAN holders are provided holding_nature
Mandatory if panholders field is passed.

7.3.52 mis_info
{
}

Attribute M List Type Limit Description and example(s)

src N N String Source. For example ‘SIP’

reg_no N N String SIP Registration No

umrn C N String UMRN. Mandatory for MIS_TYPE=’XSIP’

mem_details N N Object Member details. mis_mem_details

7.3.53 mis_mem_details
{
}

Attribute M List Type Limit Description and example(s)

subbr_code N N String 15 Sub Broker Code

BSE StARMF v2 API

129
 subbr_arn N N String 20 Sub Broker ARN Code

partner_id N N String Partner Code, assigned by the Platform to each ISV,

required when a member uses services provided by ISV

7.3.54 nft_auth
{
}

Attribute M List Type Limit Description and example(s)

user_id Y N String NFT user id

member_code Y N String NFT member code

password Y N String NFT password

amc Y N String AMC Code

rta Y N Enum RTA

member_id Y N String Member ID

client_code Y N String Client Code

entity_type Y N String Constant value “UCC”

7.3.55 nominee_change_info
The total percentage of all 3 Nominee should add up to 100%
{
}

Attribute M List Type Limit Description and example(s)

amc_code Y N String unique AMC code to be length 3

user_code Y N String agent_code max of length 15, ARN/RIA Code

folio_no Y N String Folio no

nct_type Y N Enum Type of operation

tax_number Y N String PAN

twofa_auth Y N Enum Two Factor Auth

email N N String primary holder email its based on twofa_auth

mobile_no N N String primary holder mobile its based on twofa_auth

j1_email N N String Holder 1 Email ID

BSE StARMF v2 API

130
j1_mobile N N String Holder 1 mobile no

j2_email N N String Holder 2 Email ID

j2_mobile N N String Holder 2 mobile no

broke_cd Y N String agent RIA/ARN Code

ria_code Y N String agent RIA/ARN Code

nom_opt Y N String Y|N option which is nom opt out example

nom1_name Y N String Nominee 1 name

nom1_rela Y N String Nominee 1 relation

nom1_per Y N String Nominee 1 percent

nom1_pan Y N String Nominee 1 PAN

nom1_min_f Y N String Nominee 1 is minor?

nom1_dob N N String Nominee 1 date of birth

nom1_guard N N String Nominee 1 guardian

nom1_grela N N String Nominee 1 guardian relation

nom1_gpan N N String Nominee 1 guardian PAN

nom2_name N N String Nominee 2 name

nom2_rela N N String Nominee 2 relation

nom2_per N N String Nominee 2 percent

nom2_pan N N String Nominee 2 PAN

nom2_min_f N N String Nominee 2 is minor?

nom2_dob N N String Nominee 2 date of birth

nom2_guard N N String Nominee 2 guardian

nom2_grela N N String Nominee 2 guardian relation

nom2_gpan N N String Nominee 2 guardian PAN

nom3_name N N String Nominee 3 name

nom3_rela N N String Nominee 3 relation

nom3_per N N String Nominee 3 percent

nom3_pan N N String Nominee 3 PAN

nom3_min_f N N String Nominee 3 is minor?

nom3_dob N N String Nominee 3 date of birth

nom3_guard N N String Nominee 3 guardian

BSE StARMF v2 API

131
nom3_grela N N String Nominee 3 guardian relation

nom3_gpan N N String Nominee 3 guardian PAN

7.3.56 contact_info
{
}

Attribute M List Type Limit Description and example(s)

amc_code Y N String unique AMC code to be length 3

user_code Y N String agent_code max of length 15, ARN/RIA Code

folio_no Y N String Folio no

nct_type Y N Enum Type of operation

tax_number Y N String PAN

broke_cd Y N String agent RIA/ARN Code

ria_code Y N String agent RIA/ARN Code

twofa_auth Y N Enum either E/M/B

Y N Enum E/W E-sign and W-sign if doc_type present than image is

compulsory, for E-Sign file type should be pdf and W-Sign
doc_type file type should be of tiff

nom_opt Y N String Y|N option which is nom optout example

email N N String primary holder email its based on twofa_auth

mobile_no N N String primary holder mobile its based on twofa_auth

j1_email N N String Holder 1 Email ID

j1_mobile N N String Holder 1 mobile no

j2_email N N String Holder 2 Email ID

j2_mobile N N String Holder 2 mobile no

N N Enum Primary holder email declaration

ph_ema_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

N N Enum Primary holder mobile declaration

ph_mob_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

N N Enum Joint holder 1 email declaration

j1_ema_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

N N Enum Joint holder 1 mobile declaration

j1_mob_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

N N Enum Joint holder 2 email declaration

j2_ema_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

BSE StARMF v2 API

132
 N N Enum Joint holder 2 mobile declaration
j2_mob_dec SE|SP|DC|DS|DP|GD|PM|CD|PO

7.3.57 bank_change_info
{
}

Attribute M List Type Limit Description and example(s)

amc_code Y N String unique AMC code to be length 3

user_code Y N String agent_code max of length 15, ARN/RIA Code

folio_no Y N String Folio no

nct_type Y N Enum Type of operation

tax_number Y N String PAN

broke_cd Y N String agent RIA/ARN Code

ria_code Y N String agent RIA/ARN Code

twofa_auth Y N Enum either E/M/B

Y N Enum E/W E-sign and W-sign if doc_type present than image is

compulsory, for E-Sign file type should be pdf and W-Sign
doc_type file type should be of tiff

client_code Y N String Client Code

entity_type Y N String “UCC”

ref_id Y N Integer UCC ref_id

nom_opt Y N String Y|N option which is nom optout example

pb_act_no Y N String bank account number

pb_hld_nam Y N String bank holder name

pb_ifsc_cd Y N String bank IFSC Code

pb_act_ty Y N String bank Account type

pb_nam Y N String bank name

pb_br_nam Y N String bank branch name

ab1_act_no N N String bank account number

ab1_hld_na N N String bank holder name

ab1_ifs_cd N N String bank IFSC Code

ab1_act_ty N N String bank Account type

ab1_name N N String bank name

BSE StARMF v2 API

133
ab1_br_nam N N String bank branch name

ab2_act_no N N String bank account number

ab2_hld_na N N String bank holder name

ab2_ifs_cd N N String bank IFSC Code

ab2_act_ty N N String bank Account type

ab2_name N N String bank name

ab2_br_nam N N String bank branch name

ab3_act_no N N String bank account number

ab3_hld_na N N String bank holder name

ab3_ifs_cd N N String bank IFSC Code

ab3_act_ty N N String bank Account type

ab3_name N N String bank name

ab3_br_nam N N String bank branch name

ab4_act_no N N String bank account number

ab4_hld_na N N String bank holder name

ab4_ifs_cd N N String bank IFSC Code

ab4_act_ty N N String bank Account type

ab4_name N N String bank name

ab4_br_nam N N String bank branch name

ab5_act_no N N String bank account number

ab5_hld_na N N String bank holder name

ab5_ifs_cd N N String bank IFSC Code

ab5_act_ty N N String bank Account type

ab5_name N N String bank name

ab5_br_nam N N String bank branch name

7.3.58 scheme_nfo_date_time_detail
{
}

Attribute M List Type Limit Description and example(s)

nfo_cutoff_date Y NFO Cut-off date

nfo_cutoff_time Y NFO Cut-off time

BSE StARMF v2 API

134
 Y "New Fund Offer"
"Purchase"
"Systematic Transfer Plan - IN"
"Systematic Investment Plan"
"Systematic Transfer Plan - OUT"
"Systematic Withdrawal Plan"
"Switch-OUT"
nfo_transaction "Switch-IN"
_type "Redemption"

7.3.59 nfo_payment_details
{
}

Attribute M List Type Limit Description and example(s)

Y “Cheque”
"NEFT/RTGS"
"Mandate"
nfo_payment_m "UPI"
ode_name “DirectCredit/NodalPayment”

nfo_payment_c Y NFO Payment Cut-off date

utoff_date
nfo_payment_c Y NFO Payment Cut-off time
utoff_time

7.3.60 scheme_interval_lifecycle
{
}

Attribute M List Type Limit Description and example(s)

scheme_interva Y
l_open_date
scheme_interva Y
l_close_date

7.3.61 scheme_lumpsum
{
}

Attribute M List Type Limit Description and example(s)

Y Enum “Purchase”
“New Fund Offer”
“Switch-OUT”
scheme_transa “Switch-IN”
ction_type “Redemption”

scheme_transa N String Cut off time

BSE StARMF v2 API

135
ction_cutoff_tim
e
scheme_transa Y Object Y Refer scheme_transaction_mode_allowed
ction_mode_all
owed
scheme_transa Y Object Y Refer scheme_transaction_single_details
ction_single_de
tails
scheme_transa Y N String “Purchase”
ction_type_tag_
name
scheme_transa Y N String "2025-02-01T00:00:00"
ction_effective_
start_date
scheme_transa N N String "2025-02-01T00:00:00"
ction_effective_
end_date
scheme_transa N N Object Refer scheme_transaction_allowed_options
ction_allowed_o
ptions

7.3.62 scheme_transaction_allowed_options
{
}

Attribute M List Type Limit Description and example(s)

scheme_sxp_p N N Boolean true

aused
scheme_sxp_re N N Boolean false
gistration_allow
ed
scheme_sxp_tri N N Boolean false
gger_allowed

7.3.63 scheme_transaction_mode_allowed
{
}

Attribute M List Type Limit Description and example(s)

scheme_transa Y Object “Demat”

ction_mode_all “Physical”

BSE StARMF v2 API

136
owed

7.3.64 scheme_transaction_single_details
{
}

Attribute M List Type Limit Description and example(s)

scheme_transa Y Object Refer scheme_transaction_units

ction_units
scheme_transa Y Object Refer scheme_transaction_amounts
ction_amounts
scheme_install N Object Refer scheme_installment_numbers Will be available for
ment_numbers “systematic” only

7.3.65 scheme_transaction_units
{
}

Attribute M List Type Limit Description and example(s)

scheme_transa Y Integer Max Units

ction_max_unit
scheme_transa Y Integer Min Units
ction_min_unit
scheme_transa Y Integer Multiplier
ction_mult_unit

7.3.66 scheme_transaction_amounts
{
}

Attribute M List Type Limit Description and example(s)

scheme_transa Y Integer Max Amount

ction_max_amt
scheme_transa Y Integer Min Amount
ction_min_amt
scheme_transa Y Integer Multiplier
ction_mult_amt
scheme_transa C Integer Minimum amount for additional deposits. Mandatory for
ction_min_addit “Purchase” and “Switch-IN”
ional

BSE StARMF v2 API

137
7.3.67 scheme_installment_numbers
{
}

Attribute M List Type Limit Description and example(s)

maximum Y Integer Max no of Installments

minimum Y Integer Min no of Installments

7.3.68 scheme_systematic
{
}

Attribute M List Type Limit Description and example(s)

Y Enum “Systematic Transfer Plan - IN”

“Systematic Transfer Plan - OUT”
scheme_transa “Systematic Investment Plan”
ction_type “Systematic Withdrawal Plan”

scheme_transa Y Object Refer scheme_transaction_allowed_options

ction_allowed_o
ptions
scheme_transa Y Object Refer scheme_transaction_single_details
ction_single_de
tails

Y Enum “Daily”
“Fortnightly”
“Weekly”
“Monthly”
“Quarterly”
“Half Yearly”
scheme_sxp_fr “Annually”
equency “Periodically”

scheme_sxp_fr Y Object Refer scheme_sxp_frequency_detail

equency_detail

scheme_syste Y Object Refer scheme_systematic_transaction_detail

matic_transacti
on_detail
scheme_transa N N Object Refer scheme_transaction_allowed_options
ction_allowed_o
ptions
scheme_transa N N String "00:00:00"
ction_cutoff_tim

BSE StARMF v2 API

138
e
scheme_transa N N String "00:00:00"
ction_effective_
end_date
scheme_transa Y N String "2025-02-01T00:00:00"
ction_effective_
start_date
scheme_transa Y N Object Refer scheme_transaction_mode_allowed
ction_mode_all
owed
scheme_transa Y N String "STP-IN"
ction_type
scheme_transa Y N String "Systematic Transfer Plan - IN"
ction_type_tag_
name

sip_flag N N Boolean false

stp_in_flag N N Boolean false

stp_out_flag N N Boolean false

switch_in_flag N N Boolean false

switch_out_flag N N Boolean false

swp_flag N N Boolean false

scheme_catego Y N String “Debt”

ry
amc_active_fla N N Boolean true
g

is_active N N Boolean true

7.3.69 scheme_transaction_allowed_options
{
}

Attribute M List Type Limit Description and example(s)

pause Y Boolean Is pause allowed

trigger Y Boolean Is trigger allowed

first_order Y Boolean Is first order?

registration Y Boolean Is registration allowed

BSE StARMF v2 API

139
7.3.70 scheme_sxp_frequency_detail
{
}

Attribute M List Type Limit Description and example(s)

Y Enum “days”
type “dates”

value Y Object E.g. [1,2,3,4,25,30]

7.3.71 scheme_systematic_transaction_detail
{
}

Attribute M List Type Limit Description and example(s)

Y Object {
“maximum”: 200,
“minimum”: 300,
“installment”: 100
gaps }

Y Object {
“maximum”: 200,
“minimum”: 300,
“no_of_pauses”: 0
pauses }

7.3.72 webhook_ack
{
}

Attribute M List Type Limit Description and example(s)

status Y N String “success” on to indicate webhook is consumed

Y N Object {
"id": "20241027-aA123.12"
}
Here the id has a unique id generated by the consumer of
webhook.
This ID should begin and end with [azAZ09]
data ID format is YYYYMMDD-[azAZ09,8]

messages N Y Object Should be blank

7.3.73 sxp_history_filter_param
{
}

BSE StARMF v2 API

140
 Attribute M List Type Limit Description and example(s)

no_of_txn Y N Integer Specifies the number of transactions to be shown

from_date N N String Specifies the start date for the transaction.

to_date N N String Specifies the end date for the transaction.

member N N String Member code

7.3.74 nav_filter_param
{
}

Attribute M List Type Limit Description and example(s)

Y N String The Net Asset Value of the Mutual Fund Scheme on a

particular date. By default, it will return the NAV of current
nav_date date.

bse_scheme_c N N String The BSE mutual fund scheme code.

ode

7.3.75 mandate_filter_param
{
}

Attribute M List Type Limit Description and example(s)

is_active N N boolean Fetches mandate which is active

is_verified N N boolean Fetches mandate which is verified

type N Y Array Mandate type filtering

member_code N N String Member code filtering

status N Y Array Member status filtering

ucc N N String UCC Filtering

created_at N N String Date filtering range

_after
created_at_bef N N String Date filtering range
ore

7.3.76 scheme_filter_param
{

BSE StARMF v2 API

141
 }

Attribute M List Type Limit Description and example(s)

scheme_catego N N String “debt”

ry “equity”

scheme_amc_n N N String Scheme AMC Name

ame

scheme_option Y N Enum “Growth”

“IDCW Payout”
“IDCW Reinvestment”

scheme_plan Y N Enum “Direct”

“Regular”

scheme_isin N N String Scheme ISIN

scheme_redem Y N Enum “T1”

ption_settlemen “T2”
t_days “T3”
“T4”
“T4”
“T6”
“T7”
“T8”
“T9”
“T10”

scheme_transa Y Object Y Refer scheme_transaction_mode_allowed

ction_mode_all
owed

7.3.77 nft_response_obj
{
}

Attribute M List Type Limit Description and example(s)

IHNo N N String

Status N N String

AMCCode N N String

DocType N N String

Errcode N N String

FolioNo N N String

NCTType N N String

UsrTxnNo N N String

EntryDate N N String

BSE StARMF v2 API

142
ReturnMsg N N String

TaxNumber N N String

TwoFAAuth N N String

ReturnCode N N String

PortRemarks N N String

7.4 Enums

7.4.1 holding_nature
SI Single

JO Joint

AS Anyone or Survivor

7.4.2 tax_status

Tax Tax Status Tax type Is Is Minor?

Code Resident?
01 Individual Individual Y N
02 On behalf of minor Individual Y Y
03 HUF Non-Individual Y N
04 Company Non-Individual Y N
05 AOP Non-Individual Y N
06 Partnership Firm Non-Individual Y N
07 Body Corporate Non-Individual Y N
08 Trust Non-Individual Y N
09 Society Non-Individual Y N
10 Others Non-Individual Y N
11 NRI-Others Non-Individual N N
12 DFI Non-Individual Y N
13 Sole Proprietorship Non-Individual Y N
21 NRE Individual N N
22 OCB Non-Individual N N
23 FII Non-Individual N N
24 NRO Individual N N
25 Overseas Corp. Body - Others Non-Individual N N

BSE StARMF v2 API

143
 26 NRI Child Individual N Y
27 NRI - HUF (NRO) Non-Individual N N
28 NRI - Minor (NRO) Individual N Y
29 NRI - HUF (NRE) Non-Individual N N
31 Provident Fund Non-Individual Y N
32 Super Annuation Fund Non-Individual Y N
33 Gratuity Fund Non-Individual Y N
34 Pension Fund Non-Individual Y N
36 Mutual Funds FOF Schemes Non-Individual Y N
37 NPS Trust Non-Individual Y N
38 Global Development Network Non-Individual N N
39 FCRA Non-Individual N N
41 QFI - Individual Individual N N
42 QFI - Minors Individual N Y
43 QFI - Corporate Non-Individual N N
44 QFI - Pension Funds Non-Individual N N
45 QFI - Hedge Funds Non-Individual N N
46 QFI - Mutual Funds Non-Individual N N
47 LLP Non-Individual Y N
48 Non-Profit organization [NPO] Non-Individual Y N
51 Public Limited Company Non-Individual Y N
52 Private Limited Company Non-Individual Y N
53 Unlisted Company Non-Individual Y N
54 Mutual Funds Non-Individual Y N
55 FPI - Category I Non-Individual N N
56 FPI - Category II Non-Individual N N
57 FPI - Category III Non-Individual N N
58 Financial Institutions Non-Individual Y N
59 Body of Individuals Non-Individual Y N
60 Insurance Company Non-Individual Y N
61 OCI - Repatriation Individual N N
62 OCI - Non Repatriation Individual N N
70 Person of Indian Origin Individual N N
72 Government Body Non-Individual Y N
73 Defense Establishment Non-Individual Y N
74 Non - Government Organisation Non-Individual Y N
75 Bank/Co-Operative Bank Non-Individual Y N
76 Artificial Juridical person Non-Individual Y N
77 Seafarer NRE Individual N N
78 Seafarer NRO Individual N N

BSE StARMF v2 API

144
 tax_code tax_status

01 Individual

02 On behalf of minor

03 HUF

04 Company

05 AOP

06 Partnership Firm

07 Body Corporate

08 Trust

09 Society

10 Others

11 NRI-Others

12 DFI

13 Sole Proprietorship

21 NRE

22 OCB

23 FII

24 NRO

25 Overseas Corp. Body - Others

26 NRI Child

27 NRI - HUF (NRO)

28 NRI - Minor (NRO)

29 NRI - HUF (NRE)

31 Provident Fund

32 Super Annuation Fund

33 Gratuity Fund

34 Pension Fund

36 Mutual Funds FOF Schemes

BSE StARMF v2 API

145
 37 NPS Trust

38 Global Development Network

39 FCRA

41 QFI - Individual

42 QFI - Minors

43 QFI - Corporate

44 QFI - Pension Funds

45 QFI - Hedge Funds

46 QFI - Mutual Funds

47 LLP

48 Non-Profit organization [NPO]

51 Public Limited Company

52 Private Limited Company

53 Unlisted Company

54 Mutual Funds

55 FPI - Category I

56 FPI - Category II

57 FPI - Category III

58 Financial Institutions

59 Body of Individuals

60 Insurance Company

61 OCI - Repatriation

62 OCI - Non Repatriation

70 Person of Indian Origin

72 Government Body

73 Defense Establishment

74 Non - Government Organisation

75 Bank/Co-Operative Bank

BSE StARMF v2 API

146
 76 Artificial Juridical person

77 Seafarer NRE

78 Seafarer NRO

7.4.3 rdmp_idcw_pay_mode (Payment mode for redemptions & IDCW)

01 Cheque

02 Direct Credit

03 Electronic Clearing Service

04 National Electronic Fund Transfer

05 Real-Time Gross Settlement

7.4.4 nomination_auth_mode
W Wet Signature

E Aadhaar ESign

O OTP Authentication

7.4.5 comm_mode
P Physical

M Mobile

E Email

7.4.6 onboarding
Z Paperless

P Paper(physical)

7.4.7 holder_rank
1 First/Primary Holder

2 Second Holder

3 Third Holder

BSE StARMF v2 API

147
 -1 Guardian

7.4.8 occ_code
01 Business

02 Service

03 Professional

04 Agriculturist

05 Retired

06 Housewife

07 Student

08 Others

09 Doctor

41 Private Sector Service

42 Public Sector Service

43 Forex Dealer

44 Government Service

99 Unknown / Not Applicable

7.4.9 auth_mode
M Mobile

E Email

B Both

7.4.10 pan_exempt_category
01 Sikkim Resident

02 Transactions carried out on behalf of STATE GOVT

03 Transactions carried out on behalf of CENTRAL GOVT

04 COURT APPOINTED OFFICIALS

05 UN Entity/Multilateral agency exempt from paying tax in India

BSE StARMF v2 API

148
 06 Official Liquidator

07 Court Receiver

08 Investment in Mutual Funds Up to Rs. 50,000/- p.a. including SIP

7.4.11 kyc_type
K KRA Compliant

C CKYC Compliant

B BIOMETRIC KYC

E Aadhaar EKYC PAN

7.4.12 bank_acc_type
SB Savings account

CB Current account

NE NRE account

NO NRO account

7.4.13 bank_acc_owner / account_owner

SELF Self

GUARDIAN Guardian

7.4.14 depository_code
NSDL NSDL

CDSL CDSL

7.4.15 depository_code (order/sxp/mandate)

N NSDL

C CDSL

BSE StARMF v2 API

149
7.4.16 whose_contact_number / whose_email_address
SE Self

SP Spouse

DC Dependent Children

DS Dependent Siblings

DP Dependent Parents

GD Guardian

PM PMS

CD Custodian

PO POA

NA Not Applicable ()This can only be passed for non-individual Tax Status types)

7.4.17 contact_type
RE Residential

OF Office

PR Primary

OT Other

7.4.18 nomination_relation
1 Aunt

2 Brother

3 Daughter

4 Daughter In Law

5 Father

6 Father In Law

7 Grand Daughter

8 Grand Son

BSE StARMF v2 API

150
 9 Grand Father

10 Grand Mother

11 Husband

12 Mother

13 Mother In Law

14 Nephew

15 Niece

16 Friend

17 Sister

18 Son

19 Son In Law

20 Uncle

21 Wife

22 Others

7.4.19 gender
M Male

F Female

O Other

7.4.20 identifier_type​
is_expi
extensio is_doc_nu is_issue_d ry_ma
n_allowe mber_man ate_mandat ndator identifier_si
file_type file_label d datory ory y ze
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
Legal Entity "png",
lei Identifier "eml", TRUE TRUE TRUE 10240

BSE StARMF v2 API

151
 "msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
pan PAN "zip"] TRUE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
cancel_cheq "msg",
ue Cancel Cheque "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
bank_statem "msg",
ent Bank Statement "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
cml_copy CML Copy "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
amc_mail_co "tif",
py AMC Mail Copy "png", FALSE FALSE FALSE 10240

BSE StARMF v2 API

152
 "eml",
"msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
gst GST "zip"] TRUE TRUE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
aadhar_card Aadhar Card "zip"] TRUE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
rta_email_do RTA Email "msg",
c Document "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
registration_d Registration "msg",
oc Document "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
driving_licens "bmp",
e Driving License "tif", TRUE TRUE TRUE 10240

BSE StARMF v2 API

153
 "png",
"eml",
"msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
passport Passport "zip"] TRUE TRUE TRUE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
pan_exempt_ PAN Exempt Ref "msg",
ref_no No "zip"] TRUE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
AMFI "eml",
arn_certificat Registration "msg",
e Number "zip"] TRUE TRUE TRUE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
SEBI "eml",
sebi_reg_cert Registration "msg",
ificate Number "zip"] TRUE TRUE FALSE 10240
["pdf",
"jpg",
"jpeg",
euin EUIN "bmp", TRUE TRUE TRUE 10240

BSE StARMF v2 API

154
 "tif",
"png",
"eml",
"msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
undertaking_ Undertaking "msg",
certificate Certificate "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
letter_of_appl Letter of "msg",
ication Application "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
gst_declarati "msg",
on GST Declaration "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
wet_signatur "msg",
e Wet Signature "zip"] FALSE FALSE FALSE 10240
["pdf",
address_proo "jpg",
f Address Proof "jpeg", FALSE FALSE FALSE 10240

BSE StARMF v2 API

155
 "bmp",
"tif",
"png",
"eml",
"msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
nism_cerificat NISM passing "msg",
e certificate "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
TAN "eml",
tan_declarati allotment/declar "msg",
on ation "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
llp_deed LLP Deed "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
patnership_d Partnership "msg",
eed Deed "zip"] FALSE FALSE FALSE 10240

BSE StARMF v2 API

156
 ["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
certification_ "eml",
of_incorporati Certification of "msg",
on Incorporation "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
self_certified Self-Certified "msg",
_pan PAN card "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
partnership_r Partnership "msg",
esolution resolution "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
bank_resoluti "msg",
on Bank resolution "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
certificate_of Certificate of "msg",
_registration Registration "zip"] FALSE FALSE FALSE 10240

BSE StARMF v2 API

157
 ["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
List of "eml",
authorised_si Authorised "msg",
gnatory Signatory "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
board_resolut Board "msg",
ion Resolution "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
trust_deed Trust Deed "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
tan TAN "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
Suspension "eml",
suspension_ Supporting "msg",
document Document "zip"] FALSE FALSE FALSE 10240

BSE StARMF v2 API

158
 ["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
supporting_d Supporting "msg",
ocument Document "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
scheme_infor Scheme "eml",
mation_docu information "msg",
ment document "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
key_informati "tif",
on_memoran "png",
dum_and_ap Key Info "eml",
plication_for Memorandum "msg",
m and App Form "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
aadhaar_esig "tif",
n Aadhaar Esign "png"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
Account "msg",
aof Opening Form "zip"] TRUE FALSE FALSE 10240
nomination_f Nomination ["pdf",
orm Form "jpg", FALSE FALSE FALSE 10240

BSE StARMF v2 API

159
 "jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
"zip"]
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
fatca_form Fatca Form "zip"] FALSE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
elog Electronic Log "zip"] TRUE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
Account "eml",
Opening Form "msg",
aof_ria RAI "zip"] TRUE FALSE FALSE 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
Corporate "eml",
Identification "msg",
cin Number "zip"] TRUE TRUE TRUE 10240

BSE StARMF v2 API

160
purchase_red PURCHASE_RE ["txt",
emption DEMPTION "csv"] TRUE NULL NULL 10240
["txt",
switch SWITCH "csv"] TRUE NULL NULL 10240
payin_bank_ PAY IN BANK
hdfc_xls HDFC XLS ["xls"] TRUE NULL NULL 10240
payin_bank_i PAY IN BANK
cici_xlsx ICICI XLSX ["xlsx"] TRUE NULL NULL 10240
payin_bank_i PAY IN BANK ["txt",
cici_csv ICICI CSV "csv"] TRUE NULL NULL 10240
payin_bank_i PAY IN BANK ["txt",
cici_mt940 ICICI MT940 "csv"] TRUE NULL NULL 10240
payin_bank_i PAY_IN_BANK_I ["txt",
cici_mt942 CICI_MT942 "csv"] TRUE NULL NULL 10240
pa_bank_as_ PA_BANK_AS_ ["txt",
mfd MFD "csv"] TRUE NULL NULL 10240
pa_excl_me ["txt",
m PA_EXCL_MEM "csv"] TRUE NULL NULL 10240
sxp_records_ SXP_RECORDS ["txt",
in_sip_reg _IN_SIP_REG "csv"] TRUE NULL NULL 10240
sxp_records_ SXP_RECORDS
in_xsip_isip_r _IN_XSIP_ISIP_ ["txt",
eg REG "csv"] TRUE NULL NULL 10240
sxp_records_ SXP_RECORDS ["txt",
in_swp_reg _IN_SWP_REG "csv"] TRUE NULL NULL 10240
sxp_records_ SXP_RECORDS ["txt",
in_stp_reg _IN_STP_REG "csv"] TRUE NULL NULL 10240
["txt",
reg_mandate REG_MANDATE "csv"] TRUE NULL NULL 10240
nach_respon NACH_RESPO ["txt",
se NSE "csv"] TRUE NULL NULL 10240
iman_respon IMAN_RESPON ["txt",
se SE "csv"] TRUE NULL NULL 10240
abp_mandate ABP_MANDATE ["txt",
_download _DOWNLOAD "csv"] TRUE NULL NULL 10240
cancel_mand CANCEL_MAND ["txt",
ate ATE "csv"] TRUE NULL NULL 10240
rff_kfin_file_p RFF_KFIN_FILE ["txt",
rocessing _PROCESSING "csv"] TRUE NULL NULL 10240

BSE StARMF v2 API

161
rta_in_kfintec RTA_IN_KFINT ["txt",
h_sftp ECH_SFTP "csv"] TRUE NULL NULL 10240
rta_in_cams_ RTA_IN_CAMS_ ["txt",
sftp SFTP "csv"] TRUE NULL NULL 10240
RFF_CAMS_FIL
rff_cams_file E_PROCESSIN ["txt",
_processing G "csv"] TRUE NULL NULL 10240
dp_cdsl_in_p DP_CDSL_IN_P
urch_liquid URCH_LIQUID ["D19"] TRUE NULL NULL 10240
DP_CDSL_IN_P
dp_cdsl_in_p URCH_OTHER
urch_others S ["D18"] TRUE NULL NULL 10240
dp_nsdl_in_p DP_NSDL_IN_P
urch_liquid URCH_LIQUID ["D01"] TRUE NULL NULL 10240
DP_NSDL_IN_P
dp_nsdl_in_p URCH_OTHER
urch_others S ["D01"] TRUE NULL NULL 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
"eml",
"msg",
bank_log Bank Log "zip"] TRUE TRUE TRUE 10240
cff_val_resp_ CFF_VAL_RES ["txt",
in P_IN "csv"] TRUE NULL NULL 10240
payout_resp_ PAYOUT_RESP ["txt",
in _IN "csv"] TRUE NULL NULL 10240
payout_amc_ PAYOUT_AMC_ ["txt",
in IN "csv"] TRUE NULL NULL 10240
rcptin_resp_r RCPTIN_RESP_
ecords_in_cd RECORDS_IN_ ["txt",
sl CDSL "csv"] TRUE NULL NULL 10240
rcptin_resp_r RCPTIN_RESP_
ecords_in_nd RECORDS_IN_ ["txt",
sl NDSL "csv"] TRUE NULL NULL 10240
CDSL_PAYOUT
cdsl_payout_ _RESPONSE_I ["txt",
resp_in N "csv"] TRUE NULL NULL 10240

BSE StARMF v2 API

162
 NSDL_PAYOUT
nsdl_payout_ _RESPONSE_I
resp_in N ["D**"] TRUE NULL NULL 10240
["txt",
amc_mis AMC_MIS "csv"] TRUE NULL NULL 10240
pay_in_bank PAY_IN_BANK_
_hdfc_50200 HDFC_5020008 ["txt",
087951110 7951110 "csv"] TRUE NULL NULL 10240
billing_bulk_fi BILLING_BULK_
le_upload FILE_UPLOAD ["csv"] TRUE FALSE FALSE 10240
CDSL CDSL ["txt"] TRUE NULL NULL 10240
NSDL NSDL ["txt"] TRUE NULL NULL 10240
pa_exch_raz PA_EXCH_RAZ ["txt",
orpay_upi ORPAY_UPI "csv"] TRUE NULL NULL 10240
pa_exch_axis PA_EXCH_AXIS ["txt",
_cheque _CHEQUE "csv"] TRUE NULL NULL 10240
pa_exch_icici PA_EXCH_ICICI ["txt",
_neft_rtgs _NEFT_RTGS "csv"] TRUE NULL NULL 10240
pa_exch_hdf PA_EXCH_HDF ["txt",
c_neft_rtgs C_NEFT_RTGS "csv"] TRUE NULL NULL 10240
["txt",
pa_in_xsip PA_IN_XSIP "csv"] TRUE NULL NULL 10240
pa_exch_billd PA_EXCH_BILL ["txt",
esk_otm DESK_OTM "csv"] TRUE NULL NULL 10240
pa_exch_finl PA_EXCH_FINL ["txt",
ogic OGIC "csv"] TRUE NULL NULL 10240
["pdf",
"jpg",
"jpeg",
"bmp",
"tif",
"png",
Fund Movement "eml",
fund_movem Supporting "msg",
ent_doc Document "zip"] NULL NULL NULL 10240

7.4.21 Country
Country to be passed is 3 Character ISO Code.
Refer to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 for codes.

BSE StARMF v2 API

163
7.4.22 address_type
1 Residential or Business
2 Residential
3 Business
4 Registered Office
5 Unspecified
6 Resident Or Business Foreign
7 Residential Foreign
8 Business Foreign
9 Registered Office Foreign
10 Unspecified Foreign

7.4.23 occ_type
B Business
S Service
O Others

7.4.24 exemption_code
A An organization exempt from tax under section 501(a) or any individual retirement plan as
defined in section 7701(a)(37)
B The United States or any of its agencies or instrumentalities
C A state, the District of Columbia, a possession of the United States, or any of their political
subdivisions or instrumentalities
D A corporation the stock of which is regularly traded on one or more established securities
markets, as described in Reg. section 1.1472-1(c)(1)(i)
E A corporation that is a member of the same expanded affiliated group as a corporation
described in Reg. section 1.1472-1(c)(1)(i)
F A dealer in securities, commodities, or derivative financial instruments (including notional
principal contracts, futures, forwards, and options) that is registered as such under the laws of
the United States or any state
G A real estate investment trust
H A regulated investment company as defined in section 851 or an entity registered at all times
during the tax year under the Investment Company Act of 1940
I A common trust fund as defined in section 584(a)
J A bank as defined in section 581
K A broker
L A trust exempt from tax under section 664 or described in section 4947(a)(1)
M A tax exempt trust under a section 403(b) plan or section 457(g) plan
N Not Applicable

7.4.25 corporate_service_sector
1 Foreign Exchange/Money Changer Services

BSE StARMF v2 API

164
 2 Gaming/Gambling/Lottery Services
3 Money Laundering/Pawning
4 Not Applicable

7.4.26 wealth_source
1 Salary
2 Business Income
3 Gift
4 Ancestral Property
5 Rental Income
6 Prize Money
7 Royalty
8 Others

7.4.27 income_slab
31 Below 1 Lakh
32 > 1 <=5 Lacs
33 >5 <=10 Lacs
34 >10 <= 25 Lacs
35 > 25 Lacs < = 1 Crore
36 Above 1 Crore

7.4.28 politically_exposed
Y the investor is politically exposed person
N the investor is not politically exposed person
R if the investor is a relative of the politically exposed person

7.4.29 data_source
P Physical
E Electronically

7.4.30 ffi_drnfe
FFI FFI
DRNFE DRNFE

7.4.31 is_giin_avail
AF Applied for
NR Not required to apply for
NO Not obtained - Non-participating FI

BSE StARMF v2 API

165
7.4.32 nfe_category
L Listed Entity
RL Related to Listed Entity
A Active NEFFE
P Passive NEFFE
NA Not Applicable for Non NFFE

7.4.33 nfe_sub_category
Less than 50 percent of the NFEs gross income for the preceding financial yearis passive income
01 and less than 50 percent of the assets held by theNFE during the preceding financial year are
assets that produce or are held for the production of passive income;
The NFE is a Governmental Entity, an International Organization, a Central Bank , or an entity
02
wholly owned by one or more of the foregoing;
Substantially all of the activities of the NFE consist of holding (in whole or in part) the outstanding
stock of, or providing financing and services to, one or more subsidiaries that engage in trades or
businesses other than the business of a Financial Institution, except that an entity shall not qualify
03
for this status if the entity functions as an investment fund, such as a private equity fund, venture
capital fund, leveraged buyout fund, or any investment vehicle whose purpose is to acquire or fund
companies and then hold interests in those companies as capital assets for investment purposes;
The NFE is not yet operating a business and has no prior operating history, but is investing capital
into assets with the intent to operate a business other than that of a Financial Institution, provided
04
that the NFE shall not qualify for this exception after the date that is 24 months after the date of the
initial organization of the NFE;
The NFE was not a Financial Institution in the past five years, and is in the process of liquidating its
05 assets or is reorganizing with the intent to continue or recommence operations in a business other
than that of a Financial Institution;
The NFE primarily engages in financing and hedging transactions with, or for, Related Entities that
are not Financial Institutions, and does not provide financing or hedging services to any Entity that
06
is not a Related Entity, provided that the group of any such Related Entities is primarily engaged in
a business other than that of a Financial Institution;
Any NFE that fulfils all of the following requirements: * It is established and operated in India
exclusively for religious, charitable, scientific, artistic, cultural, athletic, or educational purposes; or
it is established and operated in India and it is a professional organization, business league,
chamber of commerce, labor organization, agricultural or horticultural organization, civic league or
an organization operated exclusively for the promotion of social welfare; * It is exempt from income
tax in India; * It has no shareholders or members who have a proprietary or beneficial interest in its
income or assets; The applicable laws of the NFEs country or territory of residence or the NFEs
formation documents do not permit any income or assets of the NFE to be distributed to, or applied
for the benefit of, a private person or non-charitable Entity other than pursuant to the conduct of the
07 NFEs charitable activities, or as payment of reasonable compensation for services rendered, or as
payment representing the fair market value of property which the NFE has purchased; and The
applicable laws of the NFEs country or territory of residence or the NFEs formation documents
require that, upon the NFEs liquidation or dissolution, all of its assets be distributed to a
governmental entity or other non-profit organization, or escheat to the government of the NFEs
country or territory of residence or any political subdivision thereof. Explanation.- For the purpose
of this sub-clause, the following shall be treated as fulfilling the criteria provided in the said
sub-clause, namely:- (I) an Investor Protection Fund referred to in clause (23EA); (II) a Credit
Guarantee Fund Trust for Small Industries referred to in clause 23EB; and (III) an Investor
Protection Fund referred to in clause (23EC), of section 10 of the Act;

BSE StARMF v2 API

166
7.4.34 nature_of_relation
SU Subsidiary
CO Controlled

7.4.35 fatca_identifier_type
A Passport
B Election ID Card
C PAN Card
D ID Card
E Driving License
G UIDIA / Aadhar letter
H NREGA Job Card
O Others
X Not categorized
T TIN [Tax Payer Identification Number]
C1 Company Identification Number
G1 US GIIN
E1 Global Entity Identification Number

7.4.36 ubo_category
UBO UBO
SMO SMO

7.4.37 ubo_type_code
C01 CP of legal person-ownership
C02 CP of legal person-other means
C03 CP of legal person-senior managing official
C04 CP of legal arrangement-trust-settlor
C05 CP of legal arrangement-trust-trustee
C06 CP of legal arrangement-trust-protector
C07 CP of legal arrangement-trust-beneficiary
C08 CP of legal arrangement-trust-other
C09 CP of legal arrangement-trust-other-settlor equivalent
C10 CP of legal arrangement-trust-other-trustee-equivalent
C11 CP of legal arrangement-trust-other-protector equivalent
C12 CP of legal arrangement-trust-other-beneficiary-equivalent
C13 CP of legal arrangement-trust-other-other-equivalent
C14 Unknown

BSE StARMF v2 API

167
7.4.38 ubo_addr_type
1 Residential or Business
2 Residential
3 Business
4 Registered Office
5 Unspecified

7.4.39 ucc_status
ALL All Records
ACTIVE Active UCC Records
INACTIVE Inactive UCC Records
SUSPENDED Suspended UCC Records
PENDING_AUTH UCC Records which are Pending UCC Authentication
PENDING_VERIFICATION UCC Records which are Pending Verification

7.4.40 ucc_count_status
PENDING_VERIFICATION UCC Records which are Pending Verification
PUSH_BACK Active UCC Records
PENDING_AUTHENTICAT
ION UCC Records which are Pending UCC Authentication
REJECTED Rejected UCC Records
ACTIVE Active UCC Records
INACTIVE Inactive UCC Records
DRAFT Records in Draft State
PENDING_APPROVAL Records which are awaiting Exchange Approval

7.4.41 order_type
p Purchase
r Redemption
s Switch

7.4.42 order_phys_or_demat
p Physical
d Demat

7.4.43 order_status
o Open Orders

BSE StARMF v2 API

168
c Completed Orders
a All Orders

7.4.44 order_source
sip Order source SIP
stp Order source STP
swp Order source SWP
nfo Order source NFO
lumpsum Order source Lumpsum
combo Order source is Combo order

7.4.45 order_list_status
received Order is Received
threshold_approval_pending Threshold Approval for Order is pending
match_pending Order Match is Pending
expired Order is Expired
matched Order has Matched
queued_for_rta Order is queued for RTA
queued_for_dp Order is queued for DP
ucc_rejected UCC rejected order
platform_rejected Platform rejected order
rta_rejected RTA rejected order
ops_rejected OPS team rejected order
rta_error RTA Error for the order
done Order Processed successfully

7.4.46 mandate_type
X NACH
N Enach, e-mandate
U UPI Autopay

7.4.47 mandate_mode
ACH ACH
AD Auto Debit

7.4.48 sxp_freq
m Monthly
w Weekly
d Daily
f Fortnightly

BSE StARMF v2 API

169
q Quarterly
h Half yearly
y Yearly

7.4.49 sxp_type
SIP SIP
SWP SWP
STP STP
TOPUP SXP Top-up
SPROD Special product

7.4.50 sxp_status
reg Sxp is registered by the member.
active Sxp is Active
inactive Sxp is yet to start as per schedule
paused When UCC has requested to pause SxP
cancelled When UCC has requested to terminate SxP
mandate_unlink When the mandate is removed from the SxP
autocancelled For SIP, When N consecutive payments (as per sub scheme master) have failed
matured Once all instalments are completed as per the schedule
invalidated As per business rules defined in masters, this SxP is no longer valid

7.4.51 sxp_cancel_reason
1 Non availability of Funds
2 Scheme not performing
3 Service issue
4 Load Revised
5 Wish to invest in other schemes
6 Change in Fund Manager
7 Goal Achieved
8 Not comfortable with market volatility
9 Will be restarting SIP after few months
10 Modifications in bank/mandate/date etc
11 I have decided to invest elsewhere
12 This is not the right time to invest
13 Others(members to enter cancellation reason)

7.4.52 special_products_type
FREEDOM Freedom
GOAL Goal

BSE StARMF v2 API

170
INSURED Insured
SMART Smart

7.4.53 special_products_goal_type
1 Tax Savings
2 Retirement Planning
3 Kids Education
4 Kids Marriage
5 Dream House
6 Dream Vacation
7 Dream Car
8 Others

7.4.54 paymt_mode
NEFT NEFT
RTGS RTGS
CHEQUE Cheque
UPI UPI
IFT Internal Fund Transfer
IMPS IMPS

7.4.55 nct_type
kfin cams Description
NCTCF01 NOM Opt Out of Nominee
NCTCF02 NOM Opt In for Nominee
NCTCF03 COC Change Of Contact
NCTCF04 COM Change Of Bank

7.4.56 investor_type
Individual Individual
Non-Individual Non-Individual

7.4.57 mis_type
XSIP XSIP
OTM OTM
DIRECT DIRECT
NODAL NODAL

BSE StARMF v2 API

171
NEFT NEFT
UPI UPI
DOWNLOAD DOWNLOAD
UPIR UPI Recurring
NACH NACH
CHEQUE Cheque
ENACH ENACH
DIRECT DEBIT DIRECT DEBIT

7.4.58 mis_status
A Accepted
R Rejected
P Pending

7.4.59 2fa_event
ucc_elog 2FA event related to UCC Elog Authentication
ucc_nomination 2FA event related to UCC Nomination Authentication
ucc_authentication 2FA event related to UCC Activation Authentication
order 2FA event related to Orders
sxp 2FA event related to SxP
sxp_topup 2FA event related to SxP_topup
nfo 2FA event related to NFO
nft_email 2FA event related to NFT Email Change
nft_contact 2FA event related to NFT Contact Change
nft_bankacc 2FA event related to NFT Bank Acc Change

7.4.60 scheme_sub_category type

BPSU Banking & PSU Fund
CRP Corporate Bond Fund
CRDT Credit Risk Fund
DYN Dynamic Bond Fund
FLT Floater Fund
GLT Gilt Fund
GLT10 Gilt Fund with 10 year Constant Duration
LIQ Liquid Fund

BSE StARMF v2 API

172
LNG Long Duration Fund
LOW Low Duration Fund
MED Medium Duration Fund
MLD Medium to Long Duration Fund
MON Money Market Fund
OVN Overnight Fund
SRT Short Duration Fund
USRT Ultra Short Duration Fund
CNTR Contra Fund
DIV Dividend Yield Fund
ELSS ELSS
FLX Flexi Cap Fund
FOC Focused Fund
LMC Large & Mid Cap Fund
LRG Large Cap Fund
MID Mid Cap Fund
MLT Multi Cap Fund
SCTH Sectoral / Thematic Fund
SML Small Cap Fund
VAL Value Fund
AGG Aggressive Hybrid Fund
ARB Arbitrage Fund
BAL Balanced Hybrid Fund
CNSV Conservative Hybrid Fund
ADV Dynamic Asset Allocation or Balanced Advantage Fund
EQS Equity Savings
MLTA Multi-Asset Allocation Fund
FOF Fund of Fund
INT International
GLD Gold
INDX Index Funds
ETF ETFs
CHLD Children's Fund

BSE StARMF v2 API

173
RET Retirement Fund
FMP Fixed Maturity Plan
LIQD Liquid

7.4.61 order_lifecycle_status
Order Status Meaning

sxp_order_triggered Order Triggered

ops_rejected Order Rejection - by Exchange
received Order Received - by Exchange
order_2fa_pending Investor authentication awaited
bank_tpv_pending Bank verification awaited
matched Fund info matched
queued_for_rta Order queued to RTA
rta_error Data validation error - RTA
queued_for_rta Order Sent to RTA
rta_resp_rcvd Order Accepted by RTA
dp_units_matched DP Obligation Matched
units_rta_settled Order settled directly by RTA
done Allotment Done
Cases:
- Purchase demat units settled
- Purchase physical rff accepted
- Redemption demat funds settled
- Redemption funds rff accepted
- Switch demat units settled
- Switch physical rff accepted
partial_units_done Partial Allotment Done
redempt_rta_settled Funds Credited - By RTA - Physical
redempt_exch_settled Funds Credited - By BSE - Demat
queued_for_dp Allotment Pending (Demat- RFF received)
rta_rejected Order Rejected -by RTA
dp_rejected Order Rejected - by DP
refund_pending Refund Awaited - from RTA/AMC
exch_refund_init Refund initiated - from BSE
exch_refund_done Refund Credited- by BSE

BSE StARMF v2 API

174
exch_refund_attempted Refund Attempt Failed N/5
exch_refund_failed Refund Failed
redempt_payout_attempted Redemption Fund Payout Attempt Failed N/3
redempt_payout_failed Redemption Fund Payout Failed
redempt_fund_returned_amc Redemption Funds returned to AMC
funds_to_unclaimed Moved to unclaimed A/C
threshold_approval_pending Threshold Approval Pending
match_pending Match Pending
expired Order Expired
ucc_rejected Order Rejection - by investor
platform_rejected Order Rejection - by platform
refund_approved After checker approves refund record

7.4.62 sxp_lifecycle_status
Sxp Status Meaning

active Active
cancelled Cancelled by member
sxp_2fa_pending Investor authentication awaited
autocancelled Auto Cancelled
paused Paused
sxp_investor_canc Cancelled by investor
mandate_unlink Suspended
matured Matured
inactive Inactive
invalidated Platform rejected
reg Registered

7.4.63 wh_event
Webhook event and its meaning
Webhook Event Meaning
ops_rejected Order: Order Rejection - by Exchange
received Order: Order Received - by Exchange
order_2fa_pending Order: Investor authentication awaited
bank_tpv_pending Order: Bank verification awaited

BSE StARMF v2 API

175
matched Order: Fund info matched
queued_for_rta Order: Order queued to RTA
rta_error Order: Data validation error - RTA
sent_to_rta Order: Order Sent to RTA
rta_resp_rcvd Order: Order Accepted by RTA
units_payout_sent Order: Order units allocated to UCC
dp_units_matched Order: DP Obligation Matched
units_rta_settled Order: Order settled directly by RTA
done Order: Allotment Done
Cases:
- Purchase demat units settled
- Purchase physical rff accepted
- Redemption demat funds settled
- Redemption funds rff accepted
- Switch demat units settled
- Switch physical rff accepted
partial_units_done Order: Partial Allotment Done
redempt_rta_settled Order: Funds Credited - By RTA - Physical
redempt_exch_settled Order: Funds Credited - By BSE - Demat
queued_for_dp Order: Allotment Pending (Demat- RFF
received)
rta_rejected Order: Order Rejected -by RTA
dp_rejected Order: Order Rejected - by DP
refund_pending Order: Refund Awaited - from RTA/AMC
exch_refund_init Order: Refund initiated - from BSE
exch_refund_done Order: Refund Credited- by BSE
exch_refund_attempted Order: Refund Attempt Failed N/5
exch_refund_failed Order: Refund Failed
redempt_payout_attempted Order: Redemption Fund Payout Attempt
Failed N/3
redempt_payout_failed Order: Redemption Fund Payout Failed
redempt_fund_returned_amc Order: Redemption Funds returned to
AMC
funds_to_unclaimed Order: Moved to unclaimed A/C
threshold_approval_pending Order: Threshold Approval Pending
match_pending Order: Match Pending
expired Order: Order Expired
ucc_rejected Order: Order Rejection - by investor

BSE StARMF v2 API

176
platform_rejected Order: Order Rejection - by platform
refund_approved Order: After checker approves refund
record
active SxP: Active
sxp_order_triggered SxP: SxP order Triggered
cancelled SxP: Cancelled by member
sxp_2fa_pending SxP: Investor authentication awaited
autocancelled SxP: Auto Cancelled
paused SxP: Paused
sxp_investor_canc SxP: Cancelled by investor
mandate_unlink SxP: Suspended
matured SxP: Matured
inactive SxP: Inactive
invalidated SxP: Platform rejected
reg SxP: Registered
nft_contact NFT: NFT Contact change event
nft_nominee NFT: NFT Nominee change event
nft_bank_acc NFT: NFT Bank Account change event
PENDING_VERIFICATION UCC: Pending for verification
ucc_bank_acc UCC: Bank account verification related
event
ucc_dp_acc UCC: DP account verification related event
ucc_pan_verification UCC: PAN verification related event
ucc_kyc_verification UCC: KYC verification related event
ucc_elog_verification UCC: ELOG verification related event
ucc_auth_nominee UCC: Nominee Authentication related
event
ucc_auth_ucc UCC: UCC Authentication related event
ucc_auth_elog UCC: ELOG Authentication related event
ACTIVE UCC: When the UCC is activated.
Initiated Mandate: Mandate registered by Exchange
Active Mandate: Mandate Register
investor_auth_awaited Mandate: Mandate cancel 2FA is pending
cancelled_by_member Mandate: Mandate cancel If 2FA is
accepted
scan_upload_pending Mandate: If scan upload is pending

BSE StARMF v2 API

177
rejected Mandate: If rejected from agency
in_process_agency Mandate: Is in the process from agency
agency_pending Payment Gateway: Payment request is
sent to an Agency, waiting for response.
agency_inprocess Payment Gateway: Payment request is in
process at agency's end
agency_approved Payment Gateway: Payment is approved
by an agency.
agency_rejected Payment Gateway: Payment is rejected by
an agency.
agency_cancelled Payment Gateway: Payment is cancelled
by an agency.

7.4.64 wh_event_type
Type of event
Event type Meaning

UCC UCC related events

ORDER Order related events
SXP SxP related events
MANDATE Mandate related events
NFT NFT related events
PAYMENT GATEWAY PAYMENT GATEWAY related events

7.5 Error Codes

This Section provides a list of expected error codes for completeness. Some of the errors
will never appear for StARMFv2 API users. In future releases, an API will be available to
fetch the latest list of error codes and descriptions.

key value
500 Please try after sometime
501 Received an invalid request
502 For {<field>} is {<val_0>}
503 Try after sometime " {
""msgid"": 503,

BSE StARMF v2 API

178
 ""errcode"": """",
""field"": ""no bucket found""
}"

504 Invalid ID for the selected record

505 ID not found for the selected record "{
""msgid"": 505,
""errcode"": ""id_not_exist"",
""field"": ""id"",
""vals"": [
""78""
]
}"

506 Selected {<field>} does not exist

507 Record not found "{
""status"": ""error"",
""data"": null,
""messages"": [
{
""msgid"": 507,
""errcode"": ""record_not_found""
}
]
}"

508 Token missing

509 Token verification failed
510 Token cache failed
511 Invalid tax code for {<field>}
512 Invalid group id for {<field>}
513 Invalid account type id for {<field>}
514 Invalid tax name for {<field>}
515 {<field>} should be in the format {<val_0>}
for value '{<val_1>}'
516 {<field>} should be 10 digit {<val_0>}
517 Missing {<field>} "{
""msgid"": 517,
""errcode"": ""missing"",

BSE StARMF v2 API

179
 ""field"": ""Amc_mail_copy"",
""vals"": [
""Amc_mail_copy identifier is
missing""
]
},"

518 Invalid value for {<field>}

519 {<field>} must be between {<val_0>} and
{<val_1>}
520 {<field>} is mandatory, and {<val_0>}
521 ISO3166_1_ALPHA3 for {<field>}
522 {<field>} is Required "{
""msgid"": 522,
""errcode"": ""required"",
""field"": ""FirstName"",
""vals"": [
""""
]
},"

523 {<field>} expects only {<val_0>} characters

524 Length for {<field>} should be {<val_0>} but "{
received {<val_1>} ""status"": ""error"",
""data"": null,
""messages"": [
{
""msgid"": 524,
""errcode"": ""len"",
""field"": ""CkycNumber"",
""vals"": [
"""",
""6""
]
}
]
}"

525 {<field>} has the value {<val_0>}, exceeds

maximum value {<val_1>}

BSE StARMF v2 API

180
 526 {<field>} must be {<val_0>} characters "{
""msgid"": 526,
""errcode"": ""min"",
""field"": ""nfo_payment_details"",
""vals"": [
""1""
]
},"

527 {<field>} should be max {<val_0>} characters

528 {<field>} is invalid for {<val_1>}
529 {<field>} is invalid for {<val_1>}
530 {<field>} does not match for {<val_0>}
531 JSON marshal error for {<field>}
532 one of for {<field>}
533 Mismatch for id and entity type
534 ID and status mismatch
535 Invalid value for {<field>}
536 Invalid Status
537 {<field>} expects only {<val_0>} characters
538 {<field>} expects only {<val_0>} and {<val_1>}
characters
539 Duplicate Record for {<field>} found for value "{
{<val_0>} in {<val_1>} ""status"": ""error"",
""data"": ""name"",
""messages"": [
{
""msgid"": 539,
""errcode"": ""duplicate_record"",
""field"": ""name"",
""vals"": [
""DRAFT""
]
}
]
}"

540 Name already exists

BSE StARMF v2 API

181
 541 Code already exists
542 Country and state mismatch
543 {<field>} expects only {<val_0>} and {<val_1>}
characters
544 Missing file {<val_0>} in {<val_1>} "{
""status"": ""error"",
""data"": {
""failed_id"": [
83
]
},
""messages"": [
{
""msgid"": 544,
""errcode"": ""tx_error"",
""field"": ""ID"",
""vals"": [

""amc_20240622_121859_1.png"",
""basic_details""
]
}
]
}"

545 ID and Tag ID mismatch

546 Already inactive
547 All fields restricted
548 No more ID allowed with all
549 Overlapping date range
550 ID or entity required
551 JSON unmarshal error for {<field>}
552 Invalid date time for {<field>} for value
{<val_0>}
553 Provided bank not supported for {<field>}
554 Pan bank verification failed for {<field>}
555 Yes bank pennydrop transfer failed for
{<field>}

BSE StARMF v2 API

182
 556 Yes bank pennydrop status check failed for
{<field>}
557 Yes bank pennydrop status check timed out
for {<field>}
558 Custom pennydrop failure for {<field>}
559 Invalid value for {<field>},{<val_0>} " {
""msgid"": 559,
""errcode"": ""invalid_data"",
""field"": ""identifier_number"",
""vals"": [
""pan"",
""invalid PAN fourth character of
identifier number TYHPJ8907 and required
NA""
]
},"

560 Data not found for {<field>}

561 {<field>} is not allowed
562 Entity not exist in {<field>}
563 CCCM ID should be same for all DP accounts
564 Field should be '{<val_0>}' for '{<val_1>}'
565 Invalid declaration type'
566 Required {<field>} Document for {<val_0>}
567 Invalid transaction combination for {<field>}
568 Invalid pattern of {<val_0>} for {<field>} "{
""status"": ""error"",
""data"": null,
""messages"": [
{
""msgid"": 568,
""errcode"": ""invalid_pattern"",
""field"":
""Sebi_reg_certificate.IdentifierNumber"",
""vals"": [
""INB000145236""
]
}
]

BSE StARMF v2 API

183
 }"

569 Server Credentials missing in {<field>}

570 Protean PAN verification failed
571 {<field>} {<val_1>} should be greater than "{
{<val_0>} ""msgid"": 571,
""errcode"":
""invalid_date_order_error "",
""field"": ""nfo_close_date"",
""vals"": [
""2024-06-18"",
""2024-06-18""
]
},"

572 Invalid numeric suffix for {<field>}

573 Invalid scheme name prefix
574 Invalid {<field>} given value {<val_1>}
{<val_0>}
575 Select atleast {<val_0>} {<field>}
576 Invalid value for {<field>}
577 Invalid value for {<field>}
578 Invalid value for {<field>}
579 Invalid {<field>} value for {<val_0>} "{
""msgid"": 579,
""errcode"": ""invalid"",
""field"": ""Transaction Date and Cut
Off Time(IST)"",
""vals"": [
"""",
""2024-06-18""
]
},"

580 Unable to get token "{

""msgid"": 580,
""errcode"":
""unable_to_get_token"",
""field"": ""token""

BSE StARMF v2 API

184
 }"

581 User already exists

582 Invalid username format
584 Group not found
585 Users are present in this group
586 Could not add user to keycloak
587 User not found
588 Unable to get users
589 Unable to deactivate users
590 Unable to activate users
591 Failed to load dependencies
592 Visibility Already Exists "{
""msgid"": 592,
""errcode"":
""visibility_already_exists"",
""field"":
""group_id,role_id,visibility_id"",
""vals"": [
""1 4 1""
]
}"

593 Visibility Does Not Exist "{

""msgid"": 593,
""errcode"":
""visibility_doesnot_exists"",
""field"": ""visibility_id"",
""vals"": [
""ss""
]
},"

594 Visibility Mapped To Role

595 Object repeated for {<field>}
596 CVLKRA failed in {<field>}
597 UCC exists for mandate
598 Invalid operation

BSE StARMF v2 API

185
 599 {<field>} is not activated yet, choose the
Effective Start Date after {<val_0>}
600 Invalid value for {<field>}
601 msg org branch does not exist
602 Inactive record
603 {<field>} is not activated yet, choose the " ""msgid"": 603,
Effective Start Date after {<val_0>} ""errcode"": ""EffectiveStartDate"",
""field"": ""Start date must be after
today"",
""vals"": [
""2024-06-12 00:00:00 +0000
UTC""
]"

604 Invalid Effective End Date for

605 Failed to store object in {<field>} "{
""msgid"": 605,
""errcode"": ""failed to store
object""
}"

606 Pennyless yes bank error

607 Failed to fetch nomination detail
608 Failed to get the object
609 Minio error
610 Cdsl file encoding failed
611 Nsdl file encoding failed
612 Depositary failed in {<field>}
613 Failed to get identifier id in {<field>}
614 Failed to get holder rank in {<field>}
615 Failed to get DP verification req data
616 NSDL File Creation Failed
617 CDSL file creation error
618 CDSL file flush error
619 Invalid Depository
620 Error getting minor to major email template

BSE StARMF v2 API

186
 621 error processing minor to major email
622 error while updating database
623 Failed to fetch data for nomination
validation:
624 Error processing minor to major email
625 Operation failed
626 Failed to load minio config
627 Failed to remove object
628 Out of memory
629 Missing multipart form
630 Error reading file
631 Binding error
632 Invalid Holding Type
633 Invalid Tax_Status
634 Declaration detail fetch error
635 Scheduled email job add
636 Invalid NAV file name
637 Member_Type_Mismatch
638 id and is process mismatch
639 id and is communication mismatch
640 The provided ID and label in the {<field>} do
not correspond correctly.
641 The provider specified in the {<field>} is not
recognized.
642 The ID, entity, or status type specified in the
{<field>} do not match correctly.
643 The ID and reference ID in the {<field>} do
not match correctly.
644 An error occurred while processing the
scheduled pending email jobs in {<field>}.
645 A dependency error occurred in the {<field>}.
646 A transaction error occurred in the {<field>}.
647 The provided PAN (Primary Account Number)
in the {<field>} is invalid.

BSE StARMF v2 API

187
 648 The PAN (Primary Account Number) is
required in the {<field>}.
649 The reason for PAN (Primary Account
Number) is required in the {<field>}.
650 The end date is required in the {<field>}.
651 Failed to update the record in the {<field>}.
652 Failed to fetch PAN details in the {<field>}.
653 The effective end date should be greater
than the current date in the {<field>}.
654 Invalid request. The PAN is already debarred
or exists.
655 The start date cannot be in the past in the
{<field>}.
656 The start date should be less than the end
date in the {<field>}.
657 There was a validation error in the {<field>}.
658 Transaction error occurred for the user in the
{<field>}.
659 Authentication failed for the NFT
(Non-Fungible Token) in the {<field>}.
660 Id and reference tag Id do not match
correctly.
661 The minimum and maximum values are
invalid in the {<field>}.
662 The record is not in draft status.
663 The ID does not exist.
664 The error state does not exist in the {<field>}.
665 The holder type ID is invalid in the {<field>}.
666 There was an error processing the bank
account identifiers in the {<field>}.
667 {<field>} is required id {<val_0>} "{
""msgid"": 667,
""errcode"": ""required_if"",
""field"": ""EmailAddress"",
""vals"": [
"""",
""""

BSE StARMF v2 API

188
 ]
}"

679 Data mismatch. Invalid {<field>} is required

with {<val_0>}.
668 {<field>} is required with {<val_0>}.
669 The field should only contain letters and
spaces in {<field>}.
999 Record {<field>}ed Successfully for '{<val_0>}'
1001 Please Enter {<field>} Pattern for {<val_0>}
1023 {<field>} token_member_mismatch
1024 numeric
1025 No active records found
670 Invalid captcha
671 Generate captcha
672 Login failed
673 Unauthorized
677 Audit trail failed
678 Data mismatch for {<field>} for {<val_0>} in
{<val_1>}
683 The {<field>} field invalid formate {<val_0>}
686 Rigel error {<val_0>}
687 Something wrong {<val_0>}
692 Manual process by required {<val_0>} in
{<val_1>}
695 File generation failed
696 Invalid file type {<val_0>}
697 Member not found
698 BASE64 decode error {<val_0>}
701 Minio file not found {<val_0>} in {<val_1>}
702 Role Already exists
703 Allowed for exchange {<val_0>}
713 Otp not matched
707 Max attempt reached

BSE StARMF v2 API

189
 708 Twofa link expired
710 Approval accepted
711 Rejection Accepted
712 Too fast otp request
706 Role not exists with user
714 NFT nominee change failed
715 NFT contact change failed
1025 No active records found
1027 Duplicate identifier type {<val_0>} in
{<val_1>}
1028 Match not found {<val_0>} in {<val_1>}
1029 Data mismatch for {<field>} for @<val_0>@
in @<val_1>@
1030 The {<field>} No bucket found
1031 The {<field>} Invalid timezone
1542 The {<field>} RSA decryption error
1543 AES decryption error
1544 IMPS status check failed
1546 PAN combination not found
1547 Bank verification failed
1548 ICICI pennydrop failed
1507 Record Not Found

7.5.1 Order Error Codes

Refer to Error Codes for examples of error codes

Error Code Error Description

1522 Required field is not present.

1505 ID not exist.

1507 Record not found

1503/1520 application_error

1539 Record already exist

BSE StARMF v2 API

190
 1551/1531 Incorrect information provided

1579 Invalid

1587 Inactive record is being referred to in this order.

1588 This combination of data is not allowed.

1594 Order details do not match UCC information.

1000 Order placed does not belong to a Regular Plan.

1001 Order placed does not belong to a Direct Plan.

1002 Member is Suspended.

1005 Order is placed after Closing Date.

1006 Value is not within the Min-Max range.

1007 The member is not allowed to place orders for this AMC.

1009 Amount not within Min-Max allowed range.

1010 Amount is less than minimum Amount for additional Lumpsum order

1011 Amount is not in multiples of minimum additional

1012 Purchase Order cannot be in Units

1013 Min-Max units for this redemption and switch out is invalid

1015 Order is above Member Threshold

1016 Order is above Global Threshold

1017 Invalid Frequency for the order

1018 SIP order cannot be in Units

1019 Min-Max units for frequency is invalid

1020 Incomplete_operation: for any UCC related operations which are incomplete like
nomination, holder details, aof, elog, fatca,etc

2518 Invalid Email

2530 {<field>} does not match for {<val_1>}

2531 JSON marshal error

2551 JSON unmarshal error

2560 Data not found for {<field>}

2605 Failed to store object

2608 Failed to get the object

BSE StARMF v2 API

191
 2625 Operation failed

1584 The field {<field>} is invalid for {<val_0>}

2544 Missing file

1517 Missing {<field>}

1503 Try after sometime

1580 Invalid date time for {<field>} for value {<val_0>}

1581 Invalid Json

1593 The field {<field>} is invalid for {<val_0>}

1028 At least one of the following {<field>} is required for {<val_0>}

1029 Multiple values provided for {<field>} for {<val_0>}

1585 The field {<field>} is invalid for {<val_0>}

1586 The field {<field>} is invalid for {<val_0>}

1587 {<field>} record is inactive for {<val_0>}

1588 {<field>} is not allowed for {<val_0>}

1589 time parsing error for {<field>}

1540 Duplicate Record for {<field>} found for value {<val_0>}

1590 Insufficient information for {<field>}

2518 The field {<field>} is invalid for {<val_0>}

1027 The field {<field>} is invalid event or order

1026 Failed to update {<field>} for {<val_0>}

1025 Failed to cancel {<field>} for {<val_0>}

712 Too fast resend OTP request, ignored

711 Link expired or some holders have already rejected this request

710 Your approval accepted, further approvals pending

709 invalid action

708 some holders have already rejected this request

707 maximum attempts reached

706 otp not matched

1676 Member not found

2675 Failed to process file

BSE StARMF v2 API

192
 1596 Details Mismatch for field {<field>}

1595 Details Mismatch for field {<field>} for {<val_0>}

1594 Details Mismatch for {<field>} field value should be {<val_1>} instead of
{<val_0>}

1597 Details Mismatch

7.5.2 SxP Error Codes

Refer to Error Codes for examples of error codes

Error Code Error Description

3522 Required field is not present.

3505 ID not found for {<field>} for value {<val_0>}

3539 Record already exists

3507 Record not found

3520/3503 Try again after some time

3551/3531 Incorrect information provided

3579/3671/36 Invalid date time for {<field>} for value {<val_0>}

03/3580

3561 not_allowed

581 invalid_json

3669 invalid_field

3692 detail_mismatch

3801 global_threshold_high

3604 Invalid Effective End Date for {<field>}

3667 Invalid Brokerage found for {<field>} for value {<val_0>}

3672 Invalid Type for {<field>} field for value {<val_0>}

3573 The {<field>} is not found from rigel

3501 Received an invalid request

4560 Data not found

3602 Inactive record for {<field>} for value {<val_0>}

3669 The field {<field>} is invalid for {<val_0>}, {<val_1>}

BSE StARMF v2 API

193
 673 unauthorized access

3676 member not found

3698 Base64 decoding failed: Invalid or corrupted data

3675 Invalid file type

3682 The field {<field>} not regular plain for {<val_0>}

3683 The field {<field>} not direct plain for {<val_0>}

3789 The field {<field>} amount {<val_1>} is invalid for {<val_1>}, @<val_2>@

3690 The {<field>} field must be {<val_0>}

3778 The {<val_0>} member is suspended. Please choose a different member.

3779 The {<val_0>} member is not mapped with amc {<val_1>}

3800 The order amount for given {<val_0>} exceeds the member's threshold amount
{<val_1>}. Please enter a lower amount.

3801 The order amount for given {<val_0>} exceeds the global threshold amount
{<val_1>}. Please enter a lower amount.

3692 Details Mismatch for field {<field>}

3793 Details Mismatch for {<field>} field value should be {<val_1>} instead of {<val_0>}

3693 incomplete operation for field {<field>} for value {<val_0>}, {<val_1>}

3901 otp not matched

3902 maximum attempts reached

3903 Link expired or some holders have already rejected this request

3904 invalid action

3905 Your approval accepted, further approvals pending

3906 Some holders have already rejected this request

3907 Too fast resend OTP request, ignored

1593 The field {<field>} is invalid for {<val_0>}

3908 Session expired

3702 The field {<field>} is invalid event

3809 Invalid {<field>} for {<val_0>} and {<val_1>} and @<val_2>@

3810 {<field>} is not valid for {<val_0>} of type {<val_1>} @<val_2>@

3710 Authentication is pending for registration number {<val_0>}. Please complete the
authentication process to proceed

BSE StARMF v2 API

194
 3711 The cancellation request for registration number {<val_0>} has already been
processed

3707 Failed to initiate payment gateway transaction {<field>}

3708 BillDesk API error for {<field>}

3709 BillDesk order mapping failed due to {<field>}

3812 Failed to create Razorpay payment for {<field>}

3813 Order creation failed due to {<field>}

7.5.3 Mandate Error Codes

Refer to Error Codes for examples of error codes

Error Code Error Description

3701 Scan image upload not allowed

3706 Mandate is already linked to sxp

3704 sxp not active

3705 Not allowed sip type

3580 Invalid date time for {<field>} for value {<val_0>}

3581 Invalid json

3573 The {<field>} is not found from rigel

3544 error while inserting record

4560 Data not found

3604 Invalid Effective End Date for {<field>}

3624 Operation failed

3655 Failed to update the record in the {<field>} for value {<val_0>}

3657 There was a validation error in the {<field>}

3663 The ID does not exist for {<field>}

3668 Failed to add record, {<val_0>}

3669 The field {<field>} is invalid for {<val_0>}, {<val_1>}

3676 member not found

3677 slow query error

3675 Invalid file type

BSE StARMF v2 API

195
 3679 The field {<field>} list limit exceeded for {<val_0>}

3680 Invalid Bank Account Details

3692 Details Mismatch for field {<field>}

3792 ID not found for {<field>} for value @<val_0>@

3909 The field {<field>} token mismatch for given {<val_0>}, {<val_1>}

3910 failed to check mime.

3911 file extension for {<val_0>} is invalid for field {<field>}

3700 The field {<field>} is failed to map record for value {<val_0>}

3701 The field {<field>} is not allowed to upload Scan image for value {<val_0>}

3703 The field {<field>} is invalid event

3704 The field {<field>} sxp is not active for {<val_0>}

3705 The field {<field>} is {<val_0>} sip type is not allowed

3697 Failed to create HTTP client

3798 Failed to read HTTP response

3699 HTTP request creation failed

3912 Encryption failed

3802 Decryption failed

3804 failed to register mandate, {<field>}

3806 failed to get mandate history, {<val_0>}

3807 kafka billing error

3712 The provided mandate is already linked to SXP for registration number {<val_0>}

3713 Mismatch in mandate rejection count

3714 Mandate {<field>} is {<val_0>}

3811 Mandate cancellation failed for {<field>}: {<val_0>}. The mandate is currently in
{<val_1>} status.

BSE StARMF v2 API

196
8 Examples

8.1 ucc

8.1.1 add_ucc

8.1.1.1 Request
Endpoint: /v2/add_ucc
{
"data": {
"member_code": {
"member_id": "xxxx"
},
"investor": {
"client_code": "34099321001"
},
"tax_code": "26",
"holding_nature": "SI",
"rdmp_idcw_pay_mode": "01",
"is_client_physical": true,
"is_client_demat": false,
"ucc_status": "A",
"is_nomination_opted": false,
"nomination_auth_mode": "O",
"comm_mode": "P",
"onboarding": "Z",
"holder": [
{
"occ_code": "02",
"auth_mode": "M",
"holder_rank": "1",
"is_active": true,
"is_pan_exempt": false,
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "ASWPG1334G"
}
],
"kyc_type": "C",
"ckyc_number": "12341876543242",
"person": {
"first_name": "vaibhav",

BSE StARMF v2 API

197
 "middle_name": "rajan",
"last_name": "shirsath",
"dob": "01-Jan-2020",
"gender": "M"
},
"contact": [
{
"contact_number": "9912345678",
"country_code": "91",
"whose_contact_number": "SE",
"email_address": "rubrobin2001@gmail.com",
"whose_email_address": "SE",
"contact_type": "PR"
}
]
},
{
"occ_code": "03",
"auth_mode": "M",
"holder_rank": "-1",
"is_active": true,
"is_pan_exempt": false,
"kyc_type": "C",
"ckyc_number": "12341876543232",
"person": {
"first_name": "gangadhar",
"middle_name": "ramesh",
"last_name": "shirsath",
"dob": "12-Jan-1960",
"gender": "F"
},
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "ASWPG1434G"
}
],
"contact": [
{
"contact_number": "9912348958",
"country_code": "91",
"whose_contact_number": "SE",
"email_address": "santhosh@tantiv4.com",
"whose_email_address": "SE",
"contact_type": "PR"

BSE StARMF v2 API

198
 }
]
}
],
"comm_addr": {
"address_line_1": "Flat No. 102, ABC Apartments",
"address_line_2": "Gangapur Road",
"address_line_3": "Nashik, Maharashtra 422005",
"postalcode": "400010"
},
"foreign_addr": {
"address_line_1": "123 Main Street",
"address_line_2": "Apt 101 njjjbbhjbhhbj",
"address_line_3": "Houston, Texas 77002",
"postalcode": "77002",
"city": "Houston",
"state": "Texas",
"country": "USA"
},
"bank_account": [
{
"ifsc_code": "HDFC0009375",
"bank_acc_num": "6986598569865",
"bank_acc_type": "NE",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "bank_statement",
"file_name": "bank_statement.png",
"file_size": 1024,
"file_blob": "",
"additional_info": null
}
]
}
],
"fatca": [
{
"HolderRank": "1",
"place_of_birth": "New York City",
"country_of_birth": "America",
"client_name": "vaibhav",
"investor_type": "Individual",
"dob": "01-Jan-2020",
"father_name": "Michael Johnson",

BSE StARMF v2 API

199
 "spouse_name": "Emily Johnson",
"address_type": "2",
"occ_code": "01",
"occ_type": "B",
"tax_status": "NRI Child",
"exemption_code": "A",
"identifier": {
"identifier_type": "pan",
"identifier_number": "ASWPG1334G"
},
"corporate_service_sector": "1",
"wealth_source": "1",
"income_slab": "31",
"net_worth": 125000.00,
"date_of_net_worth": "20-Jun-2022",
"politically_exposed": "Y",
"is_self_declared": true,
"data_source": "P",
"tax_residency": [
{
"country": "India",
"tax_id_no": "1234567890",
"tax_id_type": "A"
},
{
"country": "Canada",
"tax_id_no": "987654321",
"tax_id_type": "B"
}
]
},
{
"HolderRank": "-1",
"place_of_birth": "New York City",
"country_of_birth": "America",
"client_name": "gangadhar",
"investor_type": "Individual",
"dob": "12-Jan-1960",
"father_name": "dinesh shewale",
"spouse_name": "sangita",
"address_type": "2",
"occ_code": "01",
"occ_type": "B",
"tax_status": "NRI Child",
"exemption_code": "A",

BSE StARMF v2 API

200
 "identifier": {
"identifier_type": "pan",
"identifier_number": "ASWPG1434G"
},
"corporate_service_sector": "1",
"wealth_source": "1",
"income_slab": "31",
"net_worth": 125000.00,
"date_of_net_worth": "20-Jun-2019",
"politically_exposed": "Y",
"is_self_declared": true,
"data_source": "P",
"tax_residency": [
{
"country": "India",
"tax_id_no": "1234567890",
"tax_id_type": "A"
},
{
"country": "Canada",
"tax_id_no": "987654321",
"tax_id_type": "B"
}
]
}
]
}
}

8.1.1.2 Response
{
"status": "success",
"data": {
"client_code": "34099321001",
"member_code": "xxxx",
"status": "APPROVED"
},
"messages": []
}

8.1.2 update_ucc
Endpoint: /v2/update_ucc

BSE StARMF v2 API

201
8.1.2.1 update_ucc

8.1.2.1.1 Request
{
"data": {
"member_code": {
"member_id": "xxxx"
},
"investor": {
"client_code": "34099321001"
},
"comm_addr": {
"address_line_1": "Flat No. 504, ABC Apartments",
"address_line_2": "Gangapur Road",
"address_line_3": "Nashik, Maharashtra 422005",
"postalcode": "400010"
}
}
}

8.1.2.1.2 Response
{
"status": "success",
"data": {
"client_code": "34099321001",
"member_code": "xxxx",
"status": "APPROVED"
},
"messages": []
}

8.1.2.2 update_ucc: bank account

8.1.2.2.1 Request

{
"data": {
"member_code": {
"member_id": "xxxx"
},
"investor": {
"client_code": "34099321001"
},

BSE StARMF v2 API

202
 "bank_account": {
"delete": [
{
"ifsc_code": "HDFC0009375",
"bank_acc_num": "6986598569822",
"bank_acc_type": "NE",
"account_owner": "SELF"
}
],
"add": [
{
"ifsc_code": "KKBK0002006",
"bank_acc_num": "kk6986598569889",
"bank_acc_type": "NE",
"account_owner": "SELF"
}
]
}
}
}

8.1.2.2.2 Response
{
"status": "success",
"data": {
"client_code": "34099321001",
"member_code": "xxxx",
"status": "APPROVED"
},
"messages": []
}

8.1.2.3 update_ucc: holder object

8.1.2.3.1 Request
{
"data": {
"member_code": {
"member_id": "2112121"
},
"investor": {
"client_code": "2112212"
},
"holder": {
"add": [

BSE StARMF v2 API

203
 {
"holder_rank": "2",
"occ_code": "02",
"is_pan_exempt": false,
"kyc_type": "B",
"contact": [
{
"contact_number": "9604000705",
"country_code": "91",
"whose_contact_number": "SE",
"email_address": "rajeshsahuu23i@gmail.com",
"whose_email_address": "SE",
"contact_type": "PR"
}
]
}
]
}
}
}

8.1.2.3.2 Response
{
"status": "success",
"data": {
"client_code": "0589833",
"member_code": "0103",
"parent_client_code": "",
"status": "PENDING_APPROVAL"
},
"messages": null
}

8.1.3 list_ucc
Endpoint: /v2/list_ucc

8.1.3.1 Request
{
"data": {
"start": 0,
"length": 1000,

BSE StARMF v2 API

204
 "fields": [
"ALL"
],
"filter_param": {
"holding_nature": "JOINT"
},
"ucc_status": "ALL"
}
}

8.1.3.2 Response
{
"status": "success",
"data": {
"count": 1,
"lists": [
{
"member_code": {
"member_id": "xxxx"
},
"investor": {
"client_code": "1002900031"
},
"parent_client_code": "",
"holding_nature": "JOINT",
"tax_status": "Individual",
"tax_code": "01",
"rdmp_idcw_pay_mode": "CHEQUE",
"is_client_physical": true,
"is_client_demat": true,
"is_nomination_opted": true,
"nomination_auth_mode": "O",
"comm_mode": "E",
"onboarding": "Z",
"ucc_status": "PENDING_VERIFICATION",
"holder": [
{
"holder_rank": "1",
"occ_code": "02",
"auth_mode": "M",
"is_pan_exempt": false,
"pan_exempt_category": "",
"identifier": [
{

BSE StARMF v2 API

205
 "identifier_type": "pan",
"identifier_number": "NOTPA0008A",
"entity_sub_state": "HOLDER",
"is_active": true
}
],
"kyc_type": "C",
"ckyc_number": "12341876543232",
"person": {
"first_name": "vaibhav",
"middle_name": "rajan",
"last_name": "shirsath",
"dob": "01-Jan-2000",
"gender": "M"
},
"contact": [
{
"contact_number": "8050733694",
"whose_contact_number": "SE",
"email_address": "shishir.ballal@mindstack.in",
"whose_email_address": "SE",
"contact_type": "PR",
"is_foreign": false
}
],
"nomination": [
{
"holder_name": "",
"first_name": "Anjali",
"middle_name": "divesh",
"last_name": "shirsath",
"dob": "23-Jan-2020",
"nomination_relation": "3",
"is_minor": true,
"nomination_percent": 100,
"pan_exempt_category": "",
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "NOTPA0002A",
"entity_sub_state": "holder"
}
],
"guardian": {
"first_name": "radha",

BSE StARMF v2 API

206
 "middle_name": "divesh",
"last_name": "shirsath",
"dob": "01-Jun-2000",
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "GFHPH7654R",
"entity_sub_state": "holder"
}
]
}
}
],
"is_pan_verified": true
},
{
"holder_rank": "2",
"occ_code": "02",
"auth_mode": "M",
"is_pan_exempt": false,
"pan_exempt_category": "",
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "NOTPA0006A",
"entity_sub_state": "HOLDER",
"is_active": true
}
],
"kyc_type": "C",
"ckyc_number": "12341876543242",
"person": {
"first_name": "sam",
"middle_name": "ram",
"last_name": "shirsath",
"dob": "01-Jan-2000",
"gender": "M"
},
"contact": [
{
"contact_number": "9912345678",
"whose_contact_number": "SE",
"email_address": "vaibhavborse2001@gmail.com",
"whose_email_address": "SE",
"contact_type": "PR",

BSE StARMF v2 API

207
 "is_foreign": false
}
],
"is_pan_verified": true
}
],
"comm_addr": {
"address_line_1": "Flat No. 102, ABC Apartments",
"address_line_2": "Gangapur Road",
"address_line_3": "Nashik, Maharashtra 422005",
"postalcode": "400010"
},
"foreign_addr": {
"address_line_1": "",
"city": "",
"state": "",
"country": "",
"postalcode": ""
},
"depository": [
{
"depository_code": "CDSL",
"dp_id": "12345678",
"client_id": "87654321",
"bank_account": "6986598569865",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "cml_copy",
"entity_sub_state": "DEPOSITORY",
"file_name": "ucc_20241206_103658_1cml_copy.png",
"file_blob": "ucc_20241206_103658_1cml_copy.png",
"file_size": 1024,
"is_active": true
}
]
},
{
"depository_code": "CDSL",
"dp_id": "87654321",
"client_id": "12345678",
"bank_account": "6986598569865",
"account_owner": "SELF",
"identifier": [
{

BSE StARMF v2 API

208
 "identifier_type": "cml_copy",
"entity_sub_state": "DEPOSITORY",
"file_name": "ucc_20241206_103658_2cml_copy.png",
"file_blob": "ucc_20241206_103658_2cml_copy.png",
"file_size": 1024,
"is_active": true
}
]
},
{
"depository_code": "NSDL",
"dp_id": "IN123456",
"client_id": "87654321",
"cmbp_id": "IN890000",
"bank_account": "6986598569865",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "cml_copy",
"entity_sub_state": "DEPOSITORY",
"file_name": "ucc_20241206_103658_3cml_copy.png",
"file_blob": "ucc_20241206_103658_3cml_copy.png",
"file_size": 1024,
"is_active": true
}
]
},
{
"depository_code": "NSDL",
"dp_id": "IN876543",
"client_id": "12345678",
"cmbp_id": "IN990000",
"bank_account": "6986598569865",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "cml_copy",
"entity_sub_state": "DEPOSITORY",
"file_name": "ucc_20241206_103658_4cml_copy.png",
"file_blob": "ucc_20241206_103658_4cml_copy.png",
"file_size": 1024,
"is_active": true
}
]
}

BSE StARMF v2 API

209
 ],
"bank_account": [
{
"ifsc_code": "UTIB0000004",
"bank_acc_num": "6986598569865",
"bank_acc_type": "SB",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "bank_statement",
"entity_sub_state": "BANK",
"file_name":
"ucc_20241206_103658_1bank_statement.png",
"file_blob":
"ucc_20241206_103658_1bank_statement.png",
"file_size": 1024,
"is_active": true
}
]
}
],
"fatca": [
{
"client_name": "jhon doe",
"tax_status": "NRE",
"investor_type": "Individual",
"place_of_birth": "New York City",
"country_of_birth": "America",
"dob": "2000-01-01",
"address_type": "1",
"occ_code": "01",
"occ_type": "B",
"data_source": "P",
"wealth_source": "1",
"income_slab": "31",
"politically_exposed": "Y",
"is_self_declared": true,
"father_name": "Michael Johnson",
"spouse_name": "Emily Johnson",
"exemption_code": "A",
"identifier": {
"identifier_type": "pan",
"identifier_number": "NOTPA0006A",
"entity_sub_state": "holder"
},

BSE StARMF v2 API

210
 "corporate_service_sector": "1",
"net_worth": 125000,
"date_of_net_worth": "2019-06-20",
"tax_residency": [
{
"country": "India",
"tax_id_no": "1234567890",
"tax_id_type": "A"
},
{
"country": "Canada",
"tax_id_no": "987654321",
"tax_id_type": "B"
}
],
"ubo": {},
"npo": {}
},
{
"client_name": "Sarvottam",
"tax_status": "Individual",
"investor_type": "Individual",
"place_of_birth": "SSN",
"country_of_birth": "India",
"dob": "2000-01-01",
"address_type": "1",
"occ_code": "01",
"occ_type": "B",
"data_source": "P",
"wealth_source": "1",
"income_slab": "31",
"politically_exposed": "Y",
"is_self_declared": true,
"father_name": "Michael Johnson",
"spouse_name": "Emily Johnson",
"exemption_code": "A",
"identifier": {
"identifier_type": "pan",
"identifier_number": "NOTPA0008A",
"entity_sub_state": "holder"
},
"corporate_service_sector": "1",
"net_worth": 125000,
"date_of_net_worth": "2020-06-20",
"tax_residency": [

BSE StARMF v2 API

211
 {
"country": "INDIA",
"tax_id_no": "123-45-6789",
"tax_id_type": "A"
},
{
"country": "INDIA",
"tax_id_no": "987654321",
"tax_id_type": "A"
}
],
"ubo": {},
"npo": {}
}
],
"identifiers": null
}
],
"status_count_summary": [
{
"status": "ACTIVE",
"status_count": 1
},
{
"status": "DRAFT",
"status_count": 4
},
{
"status": "PENDING_APPROVAL",
"status_count": 36
},
{
"status": "PENDING_VERIFICATION",
"status_count": 9
},
{
"status": "REJECTED",
"status_count": 30675
}
]
},
"messages": null
}

BSE StARMF v2 API

212
8.1.4 get_ucc
Endpoint: /v2/get_ucc

8.1.4.1 Request
{
"data": {
"investor": {
"client_code": "34099321001"
}
}
}

8.1.4.2 Response
{
"status": "success",
"data": {
"member_code": {
"member_id": "0103"
},
"investor": {
"client_code": "34099321001"
},
"holding_nature": "SI",
"tax_status": "NRI Child",
"tax_code": "26",
"rdmp_idcw_pay_mode": "01",
"is_client_physical": true,
"is_client_demat": false,
"is_nomination_opted": false,
"nomination_auth_mode": "O",
"comm_mode": "P",
"onboarding": "Z",
"holder": [
{
"holder_rank": "-1",
"occ_code": "03",
"auth_mode": "M",
"is_pan_exempt": false,
"pan_exempt_category": "",
"is_pan_verified": true,
"identifier": [
{

BSE StARMF v2 API

213
 "identifier_type": "pan",
"identifier_number": "ASWPG1434G",
"is_active": true
}
],
"kyc_type": "C",
"ckyc_number": "12341876543232",
"person": {
"first_name": "gangadhar",
"middle_name": "ramesh",
"last_name": "shirsath",
"dob": "12-Jan-1960",
"gender": "F"
},
"contact": [
{
"contact_number": "9912348958",
"whose_contact_number": "SE",
"email_address": "santhosh@tantiv4.com",
"whose_email_address": "SE",
"contact_type": "PR",
"is_foreign": false
}
]
},
{
"holder_rank": "1",
"occ_code": "02",
"auth_mode": "M",
"is_pan_exempt": false,
"pan_exempt_category": "",
"is_pan_verified": true,
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "ASWPG1334G",
"is_active": true
}
],
"kyc_type": "C",
"ckyc_number": "12341876543242",
"person": {
"first_name": "vaibhav",
"middle_name": "rajan",
"last_name": "shirsath",

BSE StARMF v2 API

214
 "dob": "01-Jan-2020",
"gender": "M"
},
"contact": [
{
"contact_number": "9912345678",
"whose_contact_number": "SE",
"email_address": "rubrobin2001@gmail.com",
"whose_email_address": "SE",
"contact_type": "PR",
"is_foreign": false
}
]
}
],
"comm_addr": {
"address_line_1": "Flat No. 504, ABC Apartments",
"address_line_2": "Gangapur Road",
"address_line_3": "Nashik, Maharashtra 422005",
"postalcode": "400010"
},
"foreign_addr": {
"address_line_1": "123 Main Street",
"address_line_2": "Apt 101 njjjbbhjbhhbj",
"address_line_3": "Houston, Texas 77002",
"city": "Houston",
"state": "Texas",
"country": "United States of America",
"postalcode": "77002"
},
"bank_account": [
{
"ifsc_code": "HDFC0009375",
"bank_acc_num": "6986598569865",
"bank_acc_type": "NE",
"account_owner": "SELF",
"identifier": [
{
"identifier_type": "bank_statement",
"identifier_number": "",
"file_name": "ucc_20241209_062049_1bank_statement.png",
"file_size": 1024,
"file_blob": "ucc_20241209_062049_1bank_statement.png",
"is_active": true
}

BSE StARMF v2 API

215
 ],
"is_verified": true
},
{
"ifsc_code": "KKBK0002006",
"bank_acc_num": "kk6986598569889",
"bank_acc_type": "NE",
"account_owner": "SELF"
}
],
"fatca": [
{
"client_name": "gangadhar",
"tax_status": "NRI Child",
"investor_type": "Individual",
"place_of_birth": "New York City",
"country_of_birth": "America",
"dob": "12-Jan-1960",
"address_type": "2",
"occ_code": "01",
"occ_type": "B",
"data_source": "P",
"wealth_source": "1",
"income_slab": "31",
"politically_exposed": "Y",
"is_self_declared": true,
"father_name": "dinesh shewale",
"spouse_name": "sangita",
"exemption_code": "A",
"identifier": {
"identifier_type": "pan",
"identifier_number": "ASWPG1434G"
},
"corporate_service_sector": "1",
"net_worth": 125000,
"date_of_net_worth": "20-Jun-2019",
"tax_residency": [
{
"country": "India",
"tax_id_no": "1234567890",
"tax_id_type": "A"
},
{
"country": "Canada",
"tax_id_no": "987654321",

BSE StARMF v2 API

216
 "tax_id_type": "B"
}
],
"ubo": {},
"npo": {}
},
{
"client_name": "vaibhav",
"tax_status": "NRI Child",
"investor_type": "Individual",
"place_of_birth": "New York City",
"country_of_birth": "America",
"dob": "01-Jan-2020",
"address_type": "2",
"occ_code": "01",
"occ_type": "B",
"data_source": "P",
"wealth_source": "1",
"income_slab": "31",
"politically_exposed": "Y",
"is_self_declared": true,
"father_name": "Michael Johnson",
"spouse_name": "Emily Johnson",
"exemption_code": "A",
"identifier": {
"identifier_type": "pan",
"identifier_number": "ASWPG1334G"
},
"corporate_service_sector": "1",
"net_worth": 125000,
"date_of_net_worth": "20-Jun-2022",
"tax_residency": [
{
"country": "India",
"tax_id_no": "1234567890",
"tax_id_type": "A"
},
{
"country": "Canada",
"tax_id_no": "987654321",
"tax_id_type": "B"
}
],
"ubo": {},
"npo": {}

BSE StARMF v2 API

217
 }
],
"identifiers": [
{
"identifier_type": "",
"identifier_number": ""
}
],
"ucc_status_obj": [
{
"client_code": "34099321001",
"holders": [
{
"holder_rank": "-1",
"holder_pan": "ASWPG1434G",
"pan_verification": {
"verified_status": "TRUE",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},
"fatca_status": [
{
"rta_type": "CAMS",
"verified_status": "1",
"verification_failed_reason": "",
"verified_at": ""
},
{
"rta_type": "KFIN",
"verified_status": "1",
"verification_failed_reason": "",
"verified_at": ""
}
],
"elog": {
"ip": "",
"status": "",
"accepted_at": "",
"rta_verification": null
},
"nominee_2fa": {
"verified_status": "true",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},

BSE StARMF v2 API

218
 "kyc_status": {
"kyc_type": "C",
"verified_status": "TRUE",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},
"aof": null,
"aof_ria": null
},
{
"holder_rank": "1",
"holder_pan": "ASWPG1334G",
"pan_verification": {
"verified_status": "TRUE",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},
"fatca_status": [
{
"rta_type": "CAMS",
"verified_status": "1",
"verification_failed_reason": "",
"verified_at": ""
},
{
"rta_type": "KFIN",
"verified_status": "1",
"verification_failed_reason": "",
"verified_at": ""
}
],
"elog": {
"ip": "",
"status": "",
"accepted_at": "",
"rta_verification": null
},
"nominee_2fa": {
"verified_status": "true",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},
"kyc_status": {
"kyc_type": "C",
"verified_status": "TRUE",

BSE StARMF v2 API

219
 "verification_failed_reason": "",
"verified_at": "2024-12-09 06:56:05"
},
"aof": null,
"aof_ria": null
}
],
"bank_account": [
{
"bank_acc_num": "6986598569865",
"ifsc_code": "HDFC0009375",
"verified_status": "TRUE",
"verification_failed_reason": "",
"verified_at": "2024-12-09 06:20:51"
},
{
"bank_acc_num": "kk6986598569889",
"ifsc_code": "KKBK0002006",
"verified_status": "",
"verification_failed_reason": "",
"verified_at": ""
}
],
"depository": null
}
]
},
"messages": null
}

8.2 Order

8.2.1 order_new
Endpoint: url- /s2/order_new

8.2.1.1 Request

{
"data": {
"orders": [
{
"type": "p",
"mem_ord_ref_id": "123456781",

BSE StARMF v2 API

220
 "investor": {
"ucc": "66180440205"
},
"member": "0103",
"mem_details": {
"euin": "E123456",
"euin_flag": true,
"sub_br_code": "IN123456",
"sub_br_arn": "ARN-123456",
"partner_id": "partner id"
},
"scheme": "BS131Y-GR",
"amount": 6000,
"cur": "INR",
"is_units": false,
"all_units": false,
"min_redeem_flag": false,
"folio": "",
"is_fresh": true,
"phys_or_demat": "P",
"src": "lumpsum",
"holder": [
{
"holder_rank": "1",
"email": "vaibhavborse2001@gmail.com",
"mobnum": "9912345678",
"is_nomination_opted": true,
"nomination_auth_mode": "W"
}
],
"email": "shivam02ahirrao@gmail.com",
"mobnum": "9001122333",
"kyc_passed": true,
"depository_acct": {
"depository": "N",
"dp_id": "IN464548",
"client_id": "78545698"
},
"bank_acct": {
"ifsc": "ICIC0000001",
"no": "238401001200",
"type": "CB",
"name": "HDFC BANK"
},
"dpc": true

BSE StARMF v2 API

221
 }

]
}
}

8.2.1.2 Response

{
"status": "success",
"data": {
"items": [
{
"mem_ord_ref_id": "123456781",
"id": 5000000231,
"status": "success"
}
]
},
"messages": []
}

8.2.2 order_update
Endpoint: /s2/order_update

8.2.2.1 Request
{
"data": {
"id": 5000004168,
"mem_ord_ref_id":"12456593459",
"type": "p",
"scheme": "RRSONU-GR",
"amount": 10000,
"cur": "INR",
"is_units": false,
"all_units": false,
"folio": "75766665",
"phys_or_demat": "p",
"src": "lumpsum",

BSE StARMF v2 API

222
 "reg_no": "",
"mem_details": {
"euin": "",
"euin_flag": false,
"sub_br_code": "",
"sub_br_arn": "",
"partner_id": ""
},

"holder": [
{
"holder_rank": "1",
"email": "shivam02ahirrao@gmail.com",
"mobnum": "9856321470",
"is_nomination_opted": false,
"nomination_auth_mode": "O"
}
],
"email": "shivam02ahirrao@gmail.com",
"mobnum": "9856321470",
"kyc_passed": true,
"depository_acct": {
"depository": "N",
"dp_id": "IN464548",
"client_id": "78545698"
},
"bank_acct": {
"ifsc": "ABHY0065002",
"no": "980000000000",
"type": "savings",
"name": "some other name"
},
"dpc": true,
"remark": "reason for update"
}
}

8.2.2.2 Response
{
"status": "success",
"data": {
"success_id": [
5000000232

BSE StARMF v2 API

223
 ],
"investor": {}
},
"messages": []
}

8.2.3 order_cancel
Endpoint: /s2/order_cancel

8.2.3.1 Request
{
"data": {
"id": 5000004164,
"investor": {
"ucc": "Test3012",
"ucc_id": 0,
"pan_holders": [],
"holding_nature": ""
},
"remark": "reason for cancel"
}
}

8.2.3.2 Response
{
"status": "success",
"data": {
"success_id": [
5000000232
],
"investor": {
"ucc": "66180440205"
}
},
"messages": []
}

BSE StARMF v2 API

224
8.2.4 order_list
Endpoint: /s2/order_list

8.2.4.1 Request

"data": {

"fields": [

"ALL"

],

"start": 0,

"length": 1,

"filter_param": {

"open_close": "o",

"placed_at_after": "2024-01-06",

"placed_at_before": "2025-11-06"

8.2.4.2 Response

"lists": [

"id": 5000004356,

"exch_order_id": "",

"type": "p",

BSE StARMF v2 API

225
 "mem_ord_ref_id": "1234567895",

"investor": {

"ucc": "CLNT10083"

},

"status": "match_pending",

"member": "0103",

"member_name": "Icici Securities Limited",

"scheme": "RRSONU-GR",

"src_scheme_name": "REMIGES002-REGULAR-GROWTH",

"amount": 6100,

"cur": "INR",

"is_units": false,

"all_units": false,

"is_fresh": true,

"folio_num": "",

"phys_or_demat": "p",

"info": {

"min_redeem_flag": false,

"src": "lumpsum",

"reg_no": "",

"mem_details": {

"broker_arn": "",

"euin_flag": true,

"euin": "E123456",

"sub_br_code": "IN123456",

BSE StARMF v2 API

226
 "sub_br_arn": "ARN-123456",

"partner_id": "partner id",

"mem_type": "MFI"

},

"mem_2fa": "n",

"mem_2fa_action_at": "",

"mem_paymt": "",

"order_src_info": {

"src_isin": "IN1111111111",

"src_sch_rta_code": "SONU",

"src_sch_opt": "",

"sip_rgdt": "",

"sip_fq": "",

"sip_st_dt": "",

"sip_end_dt": "",

"src_allowed_inst": 0,

"cur_inst_no": 1,

"is_new_order": true

},

"email": "shivam02ahirrao@gmail.com",

"mobnum": "9001122333",

"placed_at": "2025-01-25T05:50:17Z",

"exch_mandate_id": 0,

"kyc_passed": true,

BSE StARMF v2 API

227
 "tracker_id": "",

"depository_acct": {

"depository": "N",

"dp_id": "IN464548",

"client_id": "78545698"

},

"bank_acct": {

"ifsc": "ABHY0065002",

"no": "980000000000",

"type": "CB",

"name": "ABHYUDAYA COOPERATIVE BANK LIMITED",

"branch_name": "",

"bank_city": ""

},

"dpc": true,

"remarks": "",

"dest_scheme": "",

"dest_scheme_name": "",

"payment_ref_id": "",

"matched_pa": null,

"pa_matched_at": "",

"matched_bank_rcpt": null,

"bank_matched_at": "",

"full_matched_at": "",

"rejection_reason": {

BSE StARMF v2 API

228
 "by": "",

"reason": ""

},

"rta_resp_at": "",

"rta_resp": null,

"dp_resp": null,

"refund_details": null,

"manually_updated_at": "",

"manually_updated_by": "",

"threshold_isapproved": false,

"threshold_app_rej_by": "",

"threshold_app_rej_at": "",

"expires_at": "",

"order_added_at": "",

"history": [

"event_status": "received",

"msg": "Order received",

"when": "2025-01-25T05:50:17.824221533Z",

"user": "member/0103/isec.maker"

},

"event_status": "order_update",

"msg": "order update request",

"when": "2025-01-25T05:52:48.902134316Z",

BSE StARMF v2 API

229
 "user": "member/0103/isec.maker"

],

"matched_bank_rcpt_id": 0,

"matched_pa_ids": 0,

"dest_folio": "",

"nomination": [

"first_name": "vaibhav",

"middle_name": "saurab",

"last_name": "shirshath",

"dob": "01-Jan-2020",

"nomination_relation": "18",

"is_minor": true,

"nomination_percent": 50,

"is_pan_exempt": true,

"pan_exempt_category": "03",

"identifier": [

"identifier_type": "pan_exempt_ref_no",

"identifier_number": "AS12346789"

],

"guardian": {

"first_name": "saurabh",

BSE StARMF v2 API

230
 "middle_name": "ramesh",

"last_name": "shirsath",

"dob": "01-Jan-2000",

"identifier": [

"identifier_type": "pan",

"identifier_number": "ASWHG2252G"

],

"pan_exempt_category": ""

},

"first_name": "lokesh",

"middle_name": "saurab",

"last_name": "shirsath",

"dob": "20-Jan-2021",

"nomination_relation": "18",

"is_minor": true,

"nomination_percent": 10,

"is_pan_exempt": true,

"pan_exempt_category": "01",

"identifier": [

"identifier_type": "pan_exempt_ref_no",

BSE StARMF v2 API

231
 "identifier_number": "AS98765443"

],

"guardian": {

"first_name": "saurabh",

"middle_name": "ramesh",

"last_name": "shirsath",

"dob": "01-Jan-1995",

"pan_exempt_category": ""

},

"first_name": "savita",

"middle_name": "saurabh",

"last_name": "shirsath",

"dob": "01-Jan-2000",

"nomination_relation": "21",

"is_minor": false,

"nomination_percent": 40,

"pan_exempt_category": "",

"identifier": [

"identifier_type": "pan",

"identifier_number": "ASWPG2252G"

BSE StARMF v2 API

232
 ],

"guardian": {

"pan_exempt_category": ""

],

"holder": [

"holder_rank": "1",

"email": "shivam02ahirrao@gmail.com",

"mobnum": "9001122449",

"is_nomination_opted": true,

"nomination_auth_mode": "O"

],

"settlement_no": "2425258",

"rta_txn_no": "",

"rta_remark": null,

"reg_no": "",

"payment_aggr_code": "",

"settlement_date": "2025-01-25 05:50:17.824227 +0000 UTC",

"settlement_type": "",

"pg_ref_no": "",

"fund_receipt_date": "2025-01-25 05:50:17.824227 +0000 UTC",

"allotment_details": null,

BSE StARMF v2 API

233
 "redempt_details": null

],

8.2.5 order_get
Endpoint: /s2/order_get

8.2.5.1 Request
{
"data": {
"id": 5000000026,
"filter_param": {
"open_close": "o"
}
}
}

8.2.5.2 Response
{
"status": "success",
"data": {
"id": 5000000026,
"exch_order_id": "",
"type": "p",
"mem_ord_ref_id": "",
"investor": {
"ucc": "66004366022305"
},
"status": "match_pending",
"member": "0103",
"scheme": "BS131Y-GR",
"amount": 80000,
"cur": "INR",
"is_units": false,

BSE StARMF v2 API

234
 "all_units": false,
"is_fresh": true,
"folio_num": "",
"phys_or_demat": "p",
"info": {
"min_redeem_flag": true,
"src": "lumpsum",
"reg_no": "",
"mem_details": {
"broker_arn": "",
"euin_flag": false,
"sub_br_code": "",
"sub_br_arn": "",
"partner_id": "",
"mem_type": "MFI"
}
},
"mem_2fa": "n",
"mem_2fa_action_at": "",
"mem_paymt": "",
"order_src_info": {
"src_isin": "INF209KC1258",
"src_sch_rta_code": "131Y",
"src_sch_opt": "",
"sip_rgdt": "",
"sip_fq": "",
"sip_st_dt": "",
"sip_end_dt": "",
"src_allowed_inst": 0,
"cur_inst_no": 15
},
"email": "vaibhavborse2001@gmail.com",
"mobnum": "+919912345678",
"placed_at": "2025-01-09T12:58:28Z",
"exch_mandate_id": 0,
"kyc_passed": true,
"tracker_id": "",
"depository_acct": {
"depository": "C",
"dp_id": "99301549",
"client_id": "64261065"
},
"bank_acct": {
"ifsc": "",
"no": "",

BSE StARMF v2 API

235
 "type": "",
"name": "",
"branch_name": "",
"bank_city": ""
},
"dpc": false,
"remarks": "",
"dest_scheme": "",
"payment_ref_id": "",
"matched_pa": null,
"pa_matched_at": "",
"matched_bank_rcpt": null,
"bank_matched_at": "",
"full_matched_at": "",
"rejection_reason": {
"by": "",
"reason": ""
},
"rta_resp_at": "",
"rta_resp": null,
"dp_resp": null,
"refund_details": null,
"manually_updated_at": "",
"manually_updated_by": "",
"threshold_isapproved": false,
"threshold_app_rej_by": "",
"threshold_app_rej_at": "",
"expires_at": "",
"order_added_at": "",
"history": [
{
"event_status": "received",
"msg": "Order received",
"when": "2025-01-09T12:58:28.049911735Z",
"user": "member/0103/isec.maker"
}
],
"matched_bank_rcpt_id": 0,
"matched_pa_ids": 0,
"dest_folio": "",
"expiresat": "",
"nomination": [
{
"first_name": "Anjali",
"middle_name": "divesh",

BSE StARMF v2 API

236
 "last_name": "shirsath",
"dob": "23-Jan-2020",
"nomination_relation": "3",
"is_minor": true,
"nomination_percent": 100,
"pan_exempt_category": "",
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "NOTPA0002A"
}
],
"guardian": {
"first_name": "radha",
"middle_name": "divesh",
"last_name": "shirsath",
"dob": "01-Jun-2000",
"identifier": [
{
"identifier_type": "pan",
"identifier_number": "GFHPH7654R"
}
],
"pan_exempt_category": ""
}
}
],
"holder": [
{
"holder_rank": "1",
"email": "vaibhavborse2001@gmail.com",
"mobnum": "9912345678",
"is_nomination_opted": true,
"nomination_auth_mode": "O"
}
],
"settlement_no": "2425244",
"rta_txn_no": "",
"rta_remark": null,
"reg_no": "",
"payment_aggr_code": "",
"settlement_date": "2025-01-09 12:58:28.049915 +0000 UTC",
"settlement_type": "",
"pg_ref_no": "",
"fund_receipt_date": "2025-01-09 12:58:28.049915 +0000 UTC",

BSE StARMF v2 API

237
 "allotment_details": null,
"redempt_details": null
},
"messages": null
}

8.3 SxP

8.3.1 sxp_register
Endpoint: /s4/sxp_register

8.3.1.1 Request
{
"data": {
"sxp_type": "sip",
"mem_sxp_ref_id": "123456781",
"investor": {
"ucc": "66180440205"
},
"member": "0103",
"src_scheme": "BS131Y-GR",
"kyc_passed": true,
"dest_scheme": "",
"amc_code": "",
"exch_mandate_id": 0,
"amount": 5000,
"cur": "INR",
"src_folio": "123423/12",
"dest_folio": "",
"phys_or_demat": "P",
"isunits": false,
"dpc": false,
"start_date": "2025-02-09",
"end_date": "2030-12-31",
"freq": "m",
"txn_date": 9,
"payment_ref_id": "",
"mem_details": {
"euin": "E345671",
"euin_flag": true,

BSE StARMF v2 API

238
 "sub_br_code": "IN456789",
"sub_br_arn": "ARN-435674",
"partner_id": ""
},
"info": {},
"holder": [
{
"holder_rank": "1",
"email": "vaibhavborse2001@gmail.com",
"mobnum": "9912345678",
"is_nomination_opted": true,
"nomination_auth_mode": "W"
}
],
"depository_acct": {
"depository": "",
"dp_id": "",
"client_id": ""
},
"bank_acct": {
"ifsc": "HDFC0000644",
"no": "50200000000000",
"type": "CB",
"name": "HDFC BANK"
},
"remark": "",
"email": "rajesh@offline.com",
"mobnum": "+919828288288",
"first_order_today": false,
"brokerage": 2.5,
"ninstallments": 3,
"special_product": {
"special_prod_type": "",
"special_prod_name": "",
"target_scheme": "",
"target_amt": 0,
"goal_type": "",
"goal_amt": 0,
"sip_tenure": 0
}
}
}

BSE StARMF v2 API

239
8.3.1.2 Response

{
"status": "success",
"data": {
"id": "52fedcad-1f85-41c1-b60e-b5143681ba46"
},
"messages": []
}

8.3.2 sxp_cancel
Endpoint:

8.3.2.1 Request

"data": {

"reg_no": "c49c7035-12cd-422c-b61c-1cbfa61914fc",

"reason_cd": 6,

"reason_cd_msg": "",

"type": "SIP"

8.3.2.2 Response
{
"status": "success",
"data": {
"id": "4"
},
"messages": []
}

8.3.3 sxp_topup
Endpoint: /s4/sxp_topup

BSE StARMF v2 API

240
8.3.3.1 Request

"data": {

"reg_num": "f15d48ea-1dad-4434-85be-e427061819ba",

"mem_sxp_ref_id": "5465-5465-54-5446",

"amount": 1000,

"cur": "INR",

"start_date": "2023-03-16",

"end_date": null,

"freq": "w",

"txn_date": 1,

"payment_ref_id": "",

"remark": "any comment",

"first_order_today": true,

"email": "rupesh@gmail.com",

"mobnum": "+919985478565"

8.3.3.2 Response
{
"status": "success",
"data": {
"id": "1"
},
"messages": []
}

8.3.4 sxp_set_pause
Endpoint:

8.3.4.1 Request
{
"data": {
"reg_no": "93fc15cc-ee8e-4e3c-ae17-bb29e69e6f60",

BSE StARMF v2 API

241
 "ninstallments": 51,
"paused_from": "2025-05-09"
}
}

8.3.4.2 Response

8.3.5 sxp_resume
Endpoint:

8.3.5.1 Request
{
"data": {
"reg_no": "93fc15cc-ee8e-4e3c-ae17-bb29e69e6f60",
"resume_reason":"The sxp has been resume"
}
}

8.3.5.2 Response
{
"status": "success",
"data": {
"id": "25"
},
"messages": []
}

8.3.6 sxp_list
Endpoint: /s4/sxp_list

8.3.6.1 Request
{
"data": {
"start": 0,
"length": 2,
"fields": [
"ALL"
],
"count_only": false,

BSE StARMF v2 API

242
 "format": "json",
"sort_by": "",
"sort_dir": "",
"is_compressed": true,
"search": {
"value": ""
},
"filter_param": {
"sxp_type": null,
"status": null,
"phys_or_demat": null,
"start_date": "",
"end_date": "",
"ucc": "",
"member": "",
"is_topup": false,
"reg_at_after": "",
"reg_at_before": "",
"next_due_date_at_after": "",
"next_due_date_at_before": ""
}
}
}

8.3.6.2 Response
{
"status": "success",
"data": {
"lists": [
{
"id": 134,
"reg_no": "653409d3-ffc3-4405-b6f0-9fd6a63e4291",
"sxp_type": "xxx",
"ucc": "xxx",
"src_scheme": "xxx",
"dest_scheme": "",
"exch_mandate_id": 0,
"amount": 5000,
"cur": "INR",
"isunits": false,
"all_units": false,
"depository_acct": {
"depository": "",
"dp_id": "",

BSE StARMF v2 API

243
 "client_id": ""
},
"member": "xxx",
"member_name": "xxx",
"src_folio": "",
"dest_folio": "",
"dpc": false,
"phys_or_demat": "xxx",
"start_date": "2025-01-15",
"end_date": "2025-01-31",
"freq": "d",
"txn_date": 15,
"payment_ref_id": "",
"bank_acct": null,
"ninstallments": 0,
"status": "active",
"next_due_date": null,
"previous_paid_date": "",
"n_installment_paid": 0,
"total_amt_paid": 0
},
{
"id": 133,
"reg_no": "xxx",
"sxp_type": "xxx",
"ucc": "xxx",
"src_scheme": "xxx",
"dest_scheme": "",
"exch_mandate_id": 0,
"amount": 3234,
"cur": "INR",
"isunits": false,
"all_units": false,
"depository_acct": {
"depository": "",
"dp_id": "",
"client_id": ""
},
"member": "xxx",
"member_name": "xxx",
"src_folio": "",
"dest_folio": "",
"dpc": false,
"phys_or_demat": "xxx",
"start_date": "2025-01-23",

BSE StARMF v2 API

244
 "end_date": "2035-01-23",
"freq": "y",
"txn_date": 23,
"payment_ref_id": "",
"bank_acct": null,
"ninstallments": 0,
"status": "active",
"next_due_date": null,
"previous_paid_date": "",
"n_installment_paid": 0,
"total_amt_paid": 0
}
],
"total_count": 65
},
"messages": []
}

8.3.7 sxp_get
Endpoint: /s4/sxp_get

8.3.7.1 Request

"data": {

"reg_no": "4c52d2f8-ad27-4306-88c6-13ea5ac72718",

"type": "SIP"

8.3.7.2 Response
{
"status": "success",
"data": {
"sxp": {
"sxp_type": "SIP",
"mem_sxp_ref_id": null,
"referenced_from": null,
"ucc": "xxx",
"member": "xxx",

BSE StARMF v2 API

245
 "src_scheme": "xxx",
"dest_scheme": "",
"amc_code": "xxx",
"exch_mandate_id": 0,
"amount": 3234,
"cur": "INR",
"src_folio": "",
"dest_folio": "",
"phys_or_demat": "xx",
"is_units": false,
"dpc": false,
"start_date": "2025-01-23",
"end_date": "2035-01-23",
"freq": "y",
"txn_date": 23,
"info": {
"mem_details": {
"euin_flag": true,
"mem_type": "xxx",
"partner_id": "xxx",
"sub_br_arn": "xxx",
"sub_br_code": "xxx"
}
},
"depository_acct": {
"client_id": "",
"depository": "",
"dp_id": ""
},
"bank_acct": {
"ifsc": "",
"name": "",
"no": "",
"type": ""
},
"remark": "xxx",
"email": "xxx",
"mobnum": "xxx",
"ref_type": null,
"brokerage": 0,
"kyc_passed": false,
"special_product": {
"goal_amt": 0,
"goal_type": "",
"sip_tenure": 0,

BSE StARMF v2 API

246
 "special_prod_name": "",
"special_prod_type": "",
"target_amt": 0,
"target_scheme": ""
},
"holder": null,
"nomination": null,
"next_due_date": null,
"previous_paid_date": "",
"n_installment_paid": 0,
"total_amt_paid": 0
},
"sprod_sxp": null
},
"messages": []
}

8.3.8 sxp_get_history
Endpoint: /s4/sxp_get_history

8.3.8.1 Request
{
"data": {
"reg_no": "12312",
"fields": [
"ALL"
],
"filter_param": {
"no_of_txn": 1
}
}
}

8.3.8.2 Response
{
"status": "success",
"data": {
"lists": [
{
"all_units": false,
"amount": 1000,
"cur": "...",
"date": "...",
"dest_folio": "...",

BSE StARMF v2 API

247
 "dest_scheme": "...",
"folio": "...",
"history": [
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."
},
{
"event_status": "...",
"msg": "...",
"when": "...",
"user": "..."
}
],
"id": 5000000172,
"is_units": false,
"mem_ord_ref_id": "...",
"member": "...",
"payment_ref_id": "...",
"phys_or_demat": "...",
"regst_no": "...",
"src_scheme": "...",
"status": "...",
"txn_type": "...",
"ucc": "..."
}
]
},
"messages": null
}

8.4 NFT

8.4.1 Nominee Change

8.4.1.1 Request
{
"data": {
"user_id": "1000001",
"member_code": "10000",
"password": "45s6",
"amc": "amc",

BSE StARMF v2 API

248
 "rta": "kfin",
"member_id": "1212",
"client_code": "1212sa",
"entity_type": "UCC",
"ref_id": 123,
"nominee_change_info": [
{
"amc_code": "RMF",
"user_code": "INA100009859",
"folio_no": "495070943",
"nct_type": "NCTCF02",
"tax_number": "AAHPB9209R",
"twofa_auth": "B",
"email": "santhosh@tantiv4.com",
"mobile_no": "1111111111",
"j1_email": "santhosh+testing@tantiv4.com",
"j1_mobile": "1111111111",
"broke_cd": "INA100009859",
"ria_code": "INA100009859",
"nom_opt": "N",
"nom1_name": "Shivam",
"nom1_rela": "Father",
"nom1_per": "50.0",
"nom1_pan": "OHSPS1271J",
"nom1_min_f": "Y",
"nom1_dob": "2020-01-01",
"nom1_guard": "Guardian One",
"nom1_grela": "F",
"nom1_gpan": "OHSPS1271J",
"nom2_name": "Nominee Two",
"nom2_rela": "Brother",
"nom2_per": "20.0",
"nom2_pan": "OHSPS1271J",
"nom2_min_f": "N",
"nom2_dob": "2000-01-02",
"nom2_guard": "",
"nom2_grela": "",
"nom2_gpan": "",
"nom3_name": "Nominee Three",
"nom3_rela": "Sister",
"nom3_per": "30.0",
"nom3_pan": "OHSPS1271J",
"nom3_min_f": "Y",
"nom3_dob": "2020-05-05",
"nom3_guard": "Guardian Three",

BSE StARMF v2 API

249
 "nom3_grela": "M",
"nom3_gpan": "OHSPS1271J"
}
]
}
}

8.4.1.2 Response
{
"request_id": "..."
}

8.4.2 Contact Change

8.4.2.1 Request
{
"data": {
"user_id": "1000001",
"member_code": "10000",
"password": "45s6",
"amc": "amc",
"rta": "kfin",
"member_id": "1212",
"client_code": "1212sa",
"entity_type": "UCC",
"ref_id": 123,
"contact_info": [
{
"amc_code": "RMF",
"user_code": "INA100009859",
"folio_no": "495070943",
"nct_type": "NCTCF03",
"tax_number": "AAHPB9209R",
"broke_cd": "INA100009859",
"ria_code": "INA100009859",
"twofa_auth": "B",
"doc_type": "E",
"nom_opt": "N",
"email": "example@example.com",
"mobile_no": "1234567890sss",
"j1_email": "j1@example.com",
"j1_mobile": "9876543210",
"j2_email": "j2@example.com",
"j2_mobile": "9876543211",

BSE StARMF v2 API

250
 "ph_ema_dec": "SE",
"ph_mob_dec": "SP",
"j1_ema_dec": "DC",
"j1_mob_dec": "DS",
"j2_ema_dec": "DP",
"j2_mob_dec": "GD"
}
],
"image": "data:image/png;base64,iVBORw0K...=="
}
}

8.4.2.2 Response
{
"request_id": "..."
}

8.4.3 Bank Account Change

8.4.3.1 Request
{
"data": {
"user_id": "1000001",
"member_code": "10000",
"password": "45s6",
"amc": "amc",
"rta": "kfin",
"member_id": "1212",
"client_code": "1212sa",
"entity_type": "UCC",
"ref_id": 123,
"bank_change_info": [
{
"amc_code": "RMF",
"user_code": "INA100009859",
"folio_no": "495070943",
"user_txn_no": "202409300000041",
"nct_type": "NCTCF04",
"tax_number": "AAHPB9209R",
"broke_cd": "INA100009859",
"ria_code": "INA100009859",
"twofa_auth": "B",
"nom_opt": "N",
"doc_type": "E",

BSE StARMF v2 API

251
 "pb_act_no": "1234123123",
"pb_hld_nam": "John Doe",
"pb_ifsc_cd": "PKGB0010889",
"pb_act_ty": "Savin",
"pb_nam": "Canara",
"pb_br_nam": "Mumbai",
"ab1_act_no": "1234123123",
"ab1_hld_na": "John Doe",
"ab1_ifs_cd": "PKGB0010889",
"ab1_act_ty": "Savin",
"ab1_name": "Canara",
"ab1_br_nam": "Mumbai",
"ab2_act_no": "1234123123",
"ab2_hld_na": "John Doe",
"ab2_ifs_cd": "PKGB0010889",
"ab2_act_ty": "Savin",
"ab2_name": "Canara",
"ab2_br_nam": "Mumbai",
"ab3_act_no": "1234123123",
"ab3_hld_na": "John Doe",
"ab3_ifs_cd": "PKGB0010889",
"ab3_act_ty": "Savi",
"ab3_name": "Canara",
"ab3_br_nam": "Mumbai",
"ab4_act_no": "1234123123",
"ab4_hld_na": "John Doe",
"ab4_ifs_cd": "PKGB0010889",
"ab4_act_ty": "Save",
"ab4_name": "Canara",
"ab4_br_nam": "Mumbai",
"ab5_act_no": "1234123122",
"ab5_hld_na": "John Doe",
"ab5_ifs_cd": "PKGB0010889",
"ab5_act_ty": "Save",
"ab5_name": "Canara",
"ab5_br_nam": "Mumbai"
}
],
"image": "data:image/png;base64,iVBORw0KGg....=="
}
}

8.4.3.2 Response
{

BSE StARMF v2 API

252
 "request_id": "..."
}

8.5 PA MIS

8.5.1 upload_mis

8.5.1.1 Request
{
"data": [
{
"mis_type": "XSIP",
"payment_ref_id": "DSFFJ",
"agency_code": "abcd1234",
"member": "14000",
"investor": {
"ucc": "8508394940",
"holding_nature": "SI",
"client_code": "8508394940"
},
"amount": 1,
"credit_dt": "20240510",
"credit_at": "15:30:34",
"bank_txn_ref": "ABC13456",
"src_bank_acc": {
"ifsc": "ICIC0001556",
"no": "155601509844",
"type": "SB",
"name": "some other name"
},
"dest_bank_acc": {
"ifsc": "ICIC0001556",
"no": "348702010085595",
"type": "SB",
"name": "some other name"
},
"exchorder_num": "12312312312",
"paymt_mode": "NEFT",
"custom_ref_num": "22331231123",
"info": {
"umrn": "cvsdv",
"src": "sip",
"reg_no": "REG12345",
"mem_details": {

BSE StARMF v2 API

253
 "sub_br_code": "SUB001",
"sub_br_arn": "ARN123456",
"partner_id": "PART123456"
}
},
"remark": "SomeRemarknothing",
"status": "someStautsu11"
}
]
}

8.5.1.2 Response
{
"status": "success",
"data": "Accepted",
"messages": null
}

8.6 Mandate

8.6.1 mandate_register

8.6.1.1 Request
{
"data": {
"investor": {
"ucc": "8kr4EBmr"
// "pan_holders": [
// ""
// ],
// "holding_nature": "SI"
},
"member":"0103",

"mem_details": {
"euin": "",
"euin_flag": true,
"sub_br_code": "code",

BSE StARMF v2 API

254
 "sub_br_arn": "arn",
"partner_id": "partner_id"
},

// "parent_client_code": "87654678",
"investor_bank_details": {
"ifsc": "UTIB0000145",
"no": "6986598569865",
"type": "SA",
"name": "zdsd",
"branch": "Ghansoli",
"vpa": [
"shivam02ahirrao@oksbi"
]
},

// "mem_mandate_info": {
// "member_mandate_id": "MM123456789",
// "mandate_status_date": "2024-02-12T10:30:00Z",
// "umrn_number": "UMRN987654321",
// "utility_code": "UTL000123",
// "sponsor_code": "SPN456789"
// },

"amount": 2000,
"start_date": "2025-02-21",
"valid_till": "2035-03-15",
"reg_date": "2025-01-15",
"type": "U",

// "identifier": {
// "identifier_type": "nach_scan_img",
// "file_name": "nach_scan_img.png",
// "file_blob":
"iVBORw0KGgoAAAANSUhEUgAAAWgAAAFgBAMAAABkmP6LAAAAG1BMVEVnrs9Xn8V4vdrv7+9Gj7uLzuX///
+f4PHH4uwR+sD+AAAgAElEQVR42uydy27jOhKGGwcYzGscMGDHy4ENXx5jwIBW1jF8Wcdg5OWBDVt57BGri
hdJFGlZitIBRnFsOWGxPv5VRUqK3P1rh9tmhtsXvf0syu1zqJ5/jQC9+sxpO/4Y6FWen2DLi5L6h0Av8xPq
XJRfHz8FuihQaKCe/QzowmR0yXzKTz8EGvO50DqXmXL5EdC5U1rnyPFnQBegM+S0rsmfprTOacqP0aA/Py/
dPR1AaT1J03YaE3oFHh+ANkJDjhQ0640DvSLfXT3tSWm3XcaDLsjzsTM0CX3SZajL8Tga9BKSQ2MvOkKfkB
VmDtjrD02vC/p529uDdljgZJtsXHlbIClYFziJ3G3b8vZeaDzqwczsCo2kuZmn87GgD7l1Wh5fdvKU46oCR
0uk+GIcaHt4CVs36JyO73IbqpGgqfxxBshvHTyt7JqS2/XlNgr00jo82RXmbuiTixJNJONA5/5WYCXd6WlJ
tIUTOv8YA3oFMx16Ppn4doI2szSKPQq0lcgE+ni/pyIv/EW8GE3pPA/nR7cBu9QeA3qJ/jz3lB8dBlzk3qn
iSNCUjoVx/tEV2p5wjaV0UYkt8neAtjld5CPO09Xl0EvqO2xX1aUFpb6NlB61nMak7gCd1417Qd9xIHvImz
PAvcfE+3qI9NNlhJOAQxX5ZM9Ou0D7GTbGmcumIhRtm/s8LSuznXeS+OWnW6G8vNNTUdP5NJbSQejjfZ5Cp
vdG6Y+CPo2idNHiOW27+T7ofUtSp20PbUH6P/T90Jd7PO2/D7pNrwehx7mW11ZOadtl2xQ/wrW8LOw7bVt8

BSE StARMF v2 API

255
I3T+KHT+p0Ffvg+6+3UPd3qatg0WQ/cD6Icu1hQPQq++E3oedp60XYYHOw500Hn2p0MH57wHoW8jQa/q0Cr
PcnVL2obSSi1Ggp5pTPwqafUXxDlpW4BFPUAjQS+Uk9jt3AFNQcGvcq98ZKNBk0OQWO+oklmdkrYVoZU/44
0BTRN1poktwmvSNse0gmGiea4+RoO+lmEtN620gl1I7pTtqmyaK6929bvxoOdWaaIA6iQ0DE0pZQNU6n4bE
RpqCJUG0TT3JWG7RG0RFjY7440Bvaca1OxKYYrk6piCxoxQyhZkubcbEToDTpyqFYU6BX3NndKmGk9DQN95
FyMkpSKRsSoztU7YXjUrwhpq9ZI8Yv7UU9Xn56L3rROr0reC+jf5odV7SdhC0xyZFS2mxxT0SmofUslT7/s
9lFlTqB5h/ktBg74gNUw2uiJM8UZvLEFRSuqe0HZJBPcKB/CasM2wIS4wlCbJ2zavijKwXHJ7Ql99pRHGHk
a02W4yOtogU/0ik2eBZoYqzeSlJzT4tYLRRBa3PdgiRAswTjlaZnbZz+yBwoPQc1zXcIXIaJFLKL3PTEJje
CCj7lInJzN16QW9JNcm3oiegKZhIjZmVBI6zxx1po59oVErhCDN47ZzExAz3nJ7Sd1sTT3TkvDaG1q5/ujd
Imp7dflkhpyvE46uWDUmrVQv6FWWZZ7YiCJvUVuP2JjI1O31XtVA+0svaKkCWwI6z7yNLBI3pmZZ1aYX9Ex
VkwM2+RGz3WTNTS7ijuZVUUwlDgDt6Ncx20MWMEk4qgan7KAf9DWkWxw6kFFZ4k8ODZNjn3tNy8PMgNKvMd
tlYJhZ4i6tRvt1n3tNd9tMqkx/4wNfOkO/xh01dekHDWuyFz0SLmI7V26M5hGH1ofStQT86AcNTp171Dtme
+2s9Bx6VZ4j1Q/6UE0P7FbGbJXyWtLuS9TRFaNpY9pb6Y3NZYKBvUsMOnP5T/rJY9QRDZG4Af3WC3onqb+y
Y+iufJYyBg1NHDEQXWKOlhQYRVb6XU9oAHazh0amaTRse5AEnGXSlLCMQl8pijRAMN/1g0aJDbVEFaPQygG
bJIk6khQQSmzt57Un9FVCl7YOIX4v7bZ7KYFWodxAI6N/65CuACgPzZWVx6ErSiO/jEBvM5QZQIgmizm6Gn
2hb8yRW0/ordQdlQ/YIPUyPLMI284lDg2fAEOvoO2OUIaK0tmuL7QRDktKQsFEoK+6EUmGrZWMQS8tMymtB
9kXeo9Ko9QQev0VgTYTXkarnIQSaHU0lyiKiY3eXfeFPpjswOkOpYhAK8okk1DaKgaNcx31DUZmEX/0qinM
SDLDIAOJQpp2W0lHP+ZF231EruxIozRwI3zfD5yVFFY6lZGCSrZekF3JmtJ6LwI9xyIhkVHp1/7QSprJDpX
WcwLMSS3QmPQ0yMy0bj0LNsWKTcFoPQi0lRqEkBjwsO2SZgCTTiYuredmVOLKKS1v/aGvtBxKqkLoet1mO7
dZYZMJKqDF0ZZaKhMZvbsYAtpQ2NcsCm01w2TCtaLFkZL13stFYNcfeu5VlC2v1zbbq4u1s2t3RGtspfv1Q
NDKm3fj0MoLiHlubWwF8cpFlWXbH3rpKayS4jWjHSkAl3q+xW4A6JWsbyoBrSoTu2qHXrni9jJwCOiZDG3x
xqrSNjI/1puW28vXQS/uDYuU4hatWhqkwkPU2ErUBVq1gIQLILDdBolhf+i2w4l5aIDtJR7YsmGgr6G+1/d
Dy+SyVUvpfvea4tu3YN/hxudQ27aegyE89r51Ak9VQ31Pwo1D4rWdMRx4lxF2hN53gBbhpsHGwVTKBoJuUy
TUONTytfWCWzjtxoYONm3hCLYVx4Ggd1w2oy7uhhYt0MFSiV7a7AQtSxQuao9Ly5UdoUfI6/NBoPG7blYfJ
J8NBf0ejmMQWlMIHKMbXqhnCgo1oi8pB4M+S1HXWWdqCFr75XdFfMubQgucaQaBngaEDkNP9fDq4wv3fJbS
CmzkpvwfBPqtoTPXs2+g8VnIZtEGe97Y6nZ6lx1fBoPeorbuofsP/j0TahDSWY9NP3H+HOx5y3XFckFxQyG
oDgeB3oN/BIbw6xqT4fUC4y1wlAASTtMz6SwsuX6dDAcNhS4Q2IRfiNCfwrjJUj1K4YPUG+seQArQAnc5pf
Qg0DuuN9M7uRCX4CJXURoi8hT8XIdJDKsFJNZliHtN6a2gOHJpZzQuAjfLzI3S3MCUO8FbFs6U8mZwoArnQ
3zgzEGj0qgxeChhAtCYorgkInY5uFDP1EQirFF6MiT0O6JwXLug7GUIeoqTNCktYaAsdO/QAbvjNoSow8uQ
0GezDNIsDd9PzcZn+hWOjZQO3Vo2tYMHpVEGLgb95xSnwoM1E+wkAC0cNTxKOxbqWdiQ0cigy+dBod+4tNl
M3OVTo/FC0LGSa2OLq9L4APljRkhrS5kdg0JvOfOIySFrNhZeNOhJPAd6fsMEwga0eOpJdFDoPR3TCJMmgN
68YRhakISGfxLo+R0bUDu0kIIP+0+EHjhxSvtaOmrcMb/iZhNuSnhq9nxgwh8dRqUc3rDQG+vF3xqfTVhyU
4Ie9+9mz1s7CREw7h8H/sdYQ8xi0rjZmntSc8qVwEc1zlZmOhrEzJsNDP0ueXN7rjee+kOyC2ej51DcqLtB
oc8hpXm9caAVZx+NnrcBASjbhoXmoa3eOBAPIW6NnsOdscvQ0NNWN35jwQJKLxo9B6taPKcxuh1Pz6ZBR/W
PGAYbNW/wCEM/DfaBM/N2zlm5KNon/GK/a421+gK/8cnLIddzS3bcBofW6nAm6MkU/FO18YEx+L3+hmb67X
OjZwEjbzx2g0OvGKiBrKimTsPa5wCZmb2QHHYmLeOvPdjT8NAz7R8dQI6gY1a/KsBJam7BxFOjPDhnrfUxL
DQzicoYqg37i0rjN0poGwm9+7velagobb5rXQ0CvUBlKWWt0tU7Qqf6RxRtqFf9vK7fEs7x5yYS9D3ZfYHS
Z+ZRW7jq/eTnitI0vvrH+aeMc4fMqCu2/hJoy8xguhOB6vHC7rSs/2sPNKngo54dA0NPGdMuGM17FOLnSmM
/7IyyiC1qF6sY496sYab9591XQOujTvDHUWnITFaZXGc6CuYhTOMa9JvOCcwtihdkye8vgd4yBu4EsoBLU4
nUeMVwUYEHsXFW/6MC9cMwoakvc1TVjvH5CPQSkYVRGqOP9WPOfn2lTVh4tasNlCEul9wx8xTG/NfkAegVA
xrCYYyof3uN56xCjaP7d+2Pv1pjbp4s9SSBUVYCe+kOPWPMzk+4JkLmTrzGUyZcfnDimlS7OmPpabk5d4de
xzjGDGrktuv8H3YIEpjRhtzcazyFnzuloVon1a6wEpzSqDZLYJzB4rn7/zIiuAus8Vy+VrrmDojT2J6qN1b
Q7wRFCpKobBTH2NJ0e+kM/Y8hFsxorve8EzucEyDZGe3r3/tdnZnbhPteRzEORoKXztD/YcyPLLNK2sasui
F7FZphBbulBztdRDH+azxPOkO/VaJuKpFNbOONmVFs+PVT5fLc0qsJkhuLNYZxti15Z+itF1fuMvdf7jr5X
17cKfPZ3xXof/7H3LX0tq1j4UNmcuMlmU4wXTIK2mbZxqjqbRcDzNJNUd8uOxGiepne4nadB+rkZw95HiT1
chVHBYa2rBcf3/nOx0NakZyiN622tquL2FceDVowtagK38j573a6D1CjKgn0ac6BqdzS7jqvbGfQ7fRRMl+

BSE StARMF v2 API

256
05d4B/a6v/IviYFu7y+i+8x1A1/2Yi9MG6K1Mnw2qY/gikc6dOxnoeFH5+peg+ytw5Zbr4g33Pr4j1ucDbd
6NBb3oF9hsuN2FK54I+qoYEjXlvdrqh3BNtb/8y+F2ly0lPh709aCoe8eWLtPLfk9tBtu9bbnm5PGgvwyAL
raBzpgeUMfB8B3y7QKrx4O+GMDsvjfHlkbaT1VtU0dfuy1Bh97z6Pl0mKH1J7qG9K4X9ItU1fVQPx54ILmj
pv3HfwmYD40uOJL3OJMbihN5vaVwT7u3nfx7O4AWTTa95grtvtP3lu2g+40qhm6l6U4K3I8dQM89vPBGnOk
dIu0cJ0PZQXrpDHRQRw9sGLgrZe06WXW9C2iup9u0Djl7w7QuYlWuaJsb3sVAu8uUV1w72wW0rwjryMgMK+
eXUxwI8Cy+nGwHekQdrnc47G83F7TjFlc7MU3dX2uuyiWB6434gVALzT6TVHXdJJrtc6vedt8CZRDLWR27g
H7tAWuErRmwxg8P7rSaR4VzBmzM+dmQqEM32SPU/b+c4ThD/PAH9nYFnZD6elBujN59XhPDTsBpNCYM0imK
aywUmUad9jW01IkR1F+o98duoM+0RiCo5IJQEEpXwCddkCPYIGH6R/ISK6aI/nDuZV9Dt6wwLMH9N4ShnUC
/FZwFk0oAqFpHu466DWEOfXRVx/kamYw52Hwo+35lANBNSABX5/O+3BH0mppCwZG6kWbtHPdKVnwhB0ODf/
DAxE6msixrN+u7aJjkzExjheWOoBfQSUS2Rlc7oRv7KUNn1b7WTJ7WkWkX1NFtaKljTfhBhfbqHUHPX8ivU
fOjneeFE+gcoRx3UKFfu/2a1OEosjPT9IJNt6FbzQLjYEe9gIjeCXQpu2VdlmEJs+T7TwUCR+3J4tIgg78L
zySTblBVYTnoNvQWYi3ZhzvZ5V7T4V2PfF4vfp4TcBp1NYPCVfhickFWaPYFdVEPpVPzWgxufLj9cqdbJ36
5Wz0gcCfylhWSdFVojjXJD5qm0q0vhTo3WLbg+/z3gMYvVH97jevkXZSD10AFJAjqfSIO0O2qyltwmcxEbD
CrfiPoeTl/OA+4I+qArawvWZxFMiVs7XW+FOKUgyOLKySMwGZS0CWlXOLz+f0yxBNu3bf/sr7iLd1IsGnVv
HbMrkvaCPhX9ZSgFw/3+ETh/cPDQzjG3aVeEGxOuhYbROkMqF3zUruM6Jj260lAh2vg95+8DpTCOE2rF38+
hCdBMPO7c4IdMEDRZFjAzNr3XkMOlaOjL/5jCtDV4qePzMajguRqDTTOvJB/4OzZjicbaEQkcNK6EbGZK6a
9+smgq+oBQ7LmQblBHyDyF3c8TkSjil6m7xo1r1uKj6l8Mmgf1BTE0JX3KvFpwK3/xEtdi5+B43iyxbRu1r
yEXtSwqp8Keo0TDU1LAMObAgaYcE93+BGGKtNIB82sUfPZgDgO6ilACziGyJ8Qt0gAHvarEP4qT7bYKG9en
eQ1f4XcYSnB5umgq4QN4pJt+CUAws4Hh6/u/HCzOA8dIMMs4Fb5XwpdyyJ5n9RPB127EDKQvCDeiFnj4cS3
o6ChP/sIGMhuiToUVPktn1cgBjWsA11PALpaiguJMqQ1RmSiSijDSLJ/V84Dj8BZXbI4q/kMdJ86NHx82r2
mvHuFYQwc40o4A3RsFJgo3jGvyqqc/yVQo1UaYs3lW5AatY75wmv21DtraPcG1cpu1KkB0gWwScQo8glKe2
VXt6k/0jp6Pkw5Yo0uF7Xrfu3dDfRrYKYJYuo9UeGZIolXT7Yfkt45EDvIKQn0EnTGdBJ1EMckoL8g04w6J
5V5zgIF4QDMf1eVC2diYMfy8s3tOkqLmI7lD+qJQF8I0yhoTEQOgcTeh8cZs8a3J60s50sj2dFiuSESxFWk
46g4DNGTgL7keZFL0yXikmCyNVoMwcOY4ZWfdd8ayk5lJPKTJdhVIEYdv5zUU4H+aigsUQucCCRjjkzLwmb
th79IGMbnP1TJERrYcJYN2u2Xo3oy0GsjF2nAxegEAhRRaubLcSiQ04g6sgqAtx6fGcygIwOR6c10oCvDgh
Ogol/NkF37GhTHBB/7zHc/XTXckR2Ei3OXEIedFObDEXVSTwe6NhFLik4ZwGwQSdYR/36g8THszEr+517Qx
zFHa63rKUHH0Vg32GSlQg/PLKBw1nyu658iBo2CBhncY/TAMqtJQTto8CqhhFcydsSQl7klJDuj3ogKWJ2Z
Zl06+mRWTwr6Q4NQ6Yi6YYED6NpGOdWsrq4NHdqHGBQFLG8fluWkoL/lzLV7nWtsM/ON6AjKT6BuTVdDjXQ
3nxb0TU9LrWAybAhOoGZldWV6RBajkDqtpnlCP+7ewG4pYfcKqZemRW5u8dFkD5zJ7ht4clIHdfVh+PRhOT
noG5gA9axeq8GTq3py0K8nAA32tP46gFqd1v+noEO8vjS9Z47q3wD6wkyC2s8trvtqMpvfAfpyGtBgPzcCn
9gy6a9OpCfDJwIN9uP6uNtDq98Cej0VaK+Er7Yd7TaPezC4Ggl6waANKFBPk7XZnDUZsHePeJq5ni/uz52v
xULxUP6CeDAqvAkxbdN76BUuv0dwJmb2NRyWN6YpjvGgF387a60xoS5rZ+V20IleBY0mCUi2yHF6s63NoXF
+DMm8w3L0c+P1rQec++io3PpHt2NqXgluehN+01iMHIamnUi+MRiu1xbERPtxPhr0peW/9IS20e9HWy2Osw
aTi9owIAPEpxHULAixjZvC/H7Dnrw2ZJlRz6vRoH3cMUbMpzrt/mYL0x/AmCjr5HX6MBkuMqZJNgnERHbB3
H1j15jNiCBG8+nqA7auAhlhhc3Zoy3T65voZRXFSi4yyCvWwet0xOAelUJvKDJOmQUeUWpv/POIZ8HJ0gpT
YcLUYLDwG0VQ0TskbdSniIId7yORTZFD+iaVQvoV1aP+dUu7m9Ggv1qqAhf2e2DBHpRDhf8rHBtyvREXhdJ
Kjht1OL+1dMQYbiKUY6bJ0HBcza7D6nD8k58fjBEngwKJtr4yy3/47xb+QmDF1UYiH/cL5tR4ifrpp2UFI6
sqhhWWJHrK2M9BPc9Ggz6z1LtFc9izDHmXfhmqW/gCGTMkUQkMRjiVbXgevudVS0skizMJKXBhjuGHf/mjq
7Gg10rqEVnEqj1q/BGuPtCUkwc2k4Vq3CcsdkVl3ynL3hNnMjexb/rGDh2YciTo8sYqhqwiT0md9nvVV/hS
Ym4WfhWYVJC2N1zWk22R63iKeyKbiVZq9e96LNMWIkzFvUTJYOA/zV3VDzr1L5U2wETV+GRfxpbukeyovKz
J5N+Dj2OZfm1MRgFtgay8QdbPFLuFvxowWZsRakNqrGm+K8TZaJ94VfwrDY+8/ALlh4wyrjWlcNRPQ7qF1y
ZPqqWMBCQZXFZ+ehNViCaRYmLfV3Ys6IXNsYLpSXa/56GIrP1YDjdN6iDQNLhcHNvMTrGU1gH7UTUS9IVpN
mzyXsnJ7nUL26zbNklveMoe5Q/dI9mknKSqVO7ZWKbf2GYzqodqZbu/YKF6U9dTvktkZaufynarl/THWNDf
1K+TsXY1DnRPsvZjVraur60dsNVH9ZGg+5jtkTWF/azw8biCoez700bZdz1kU8a7saCv31vPZHjTmoqHzSZ
fh5vGvBaDjjF2BNVg7b6P9Wkuvlja3nJm7EUBqCNqQMgRutjCFuD3r6zwDWeMq8Ee4Su2foTKygZl98A+Gg

BSE StARMF v2 API

257
+6/vbeRNYYhsnwM/s2zPhy0CZhVjn4/G25wijseHvc8XvbasCY/zwCNHJN6jBGmgkbiSs8afMLP2HGEuURV
m280Vg6ZW3zNyCrn/9oyDHsPHsMaOTactNIKrMWXmQFsXWSFX7zPuVRuGrAjqbg+ZDxn63HJNee7P81cz7P
bdtKHB9N9Tw+CiniybVT1+NjXzjm01Frr1Mf48bjybGvGDM6Pr90em7qRJM/uwB2Fz8oiSElSDKkKCRFAp/
94oslRFOivcRfR4OgzW3oLEUKczVRJ+ccpdKLmW+V7w3ai9Qi5fmFoqe3/E76Zevi/v+1ikHanc4GQTfNLd
tDIEcst9fSy+zbhuRWM/OohJGx/K4TDsVXIM6mLRpaPxxgxZZhbl/Gi4HQ5lQ4SR5pcEIaj0TIyzo5+BZGb
A/Fqgpf6PHQZwQPrV/wMP8DRQ3bHXQ9ELqZswVIqiiXrZA8wzxpF5u3EAIk/0xUkhNofcQm4UrP65zj4gfF
blKqGQptHhThOUr3j16YlcekfersL2WPwFaaiBs8+4iHJ2kewnDV6xd8v3n4jPJWKTbkcOj6NQT3scgTHn4
+FDKsbfU4resW/LsTiVFxpyjpIwlW+kKp2VN+4ct8UZwGhkNX9V8EwL1M5lbiWG7cpa7jpC7zyTdIb00kTG
YdjUKwEzGZfYXz/CqhP63b8mIDaDuwCJGolRhykpjGb9fZr2RbrSXQ4CmOtq20PPVxPiOwn2m0feN6I2g3G
KVNP7iCzckCfpPVCj6apC6bQ6Rz2N08G5gk0Utyoa36ZetPDvYzDaqbjaCrqZaWiZd1p8VEQniXDqZHUGG/
aG3efRLslvShm0At/YKHHgCdTVXtYIztRYiEhxqdZfdDkUM4s4mtRpIvMtoRC6DhXZPPmJvpce+bIVq3Tjx
ChBzl+CoiKHWZ/mybmwUEjSdttSdxYZTYnYbj0Fs2Vt/vcZq1lDSYELvB6E+N8UYbUEtllAU6WYoCX9amEP
SFzkijMq1G9XVal7mDGNkoGRMJ+CQ4hbf480wR6Pr1CtFWFTdnSy6DPELeN+2uWlnF7MemCHRV3ame1K+yu
m6/HWxy0uRlOG/KQM91T2p8lf6dwPzQs4vyOo7LQFd9DUJntnjs7UbULxZFoOs/oL9OybGbaa1nixLQ1Xzc
W6fz9O8E80Ct0ZV+MWh4XwK6dwZxWqe51pzSgTh5/1RVX39V/bjxuAB0Vd/1pnbTkGQQO2qN5/wF7erLGHt
R+/PMltBu5tTXkpY6OXZ+C3r2FIeH+aL7xK8vP5qtoeufYQB1mmutQxZZp03HvajhfGvoqj7VSiuwz+Rh5e
cXt+rf9u1lf/ybv2udL+a9qNVsCPSameuDmBH4n8qpk3d1Pr1e+naaN3o8zNUQH8DS+Nn0Rh8C0m9VfwKq1
TcnqkZWVt6TaP4os/YuLToclqpJy1UB6DAWYysQ/CL6a9ZP0yfstTeHvE5RfS3yiJtOSkDbsWjr8gppphWV
tdM+MzhpvbYl220yCFpS27q19t15VgK6qsaeSQdbA3h8L62Y1L24LQgL09GSGcdxoEmFLAAr+n0R6PoCE17
3JE5SGvJUYh3yseuevgtvaBe1TuwVraJwUUZpO3ECaUhM4Qn9MssVfI7w1NGSO8dqyUMufqA+8nW6B9ZloC
ub9jRbgYach6TWkvQXtO66FfcB+TgA7jkSQbPS0BSCduPH6+mbER+DH4Y6paa9cNbRxVZqPi52GVnFp0+4L
AXtE6x3nWcEUpqMocQcLL4LCaFe39IHpOjFXcByk9H43FIC2p1hxLTQWgAtw0iF/sAO6Oozj0UaEErkJnfr
q2LQPlWRmpxk4wIJL0pTPNjV0gOCHMlhh9RnF47KQVf/RW6HWyKrgM/N1D6t0l6dSjensY9kSepWeF8Q2rY
kikgRdVCBSlZ9dyy6qvodpC55shpajiwF/TuKlnTC5YbjUjCP/Yd/dlVlUOXhJzLgoBvmv/ndrbEILX0bQm
g17zYddVVV34UMFCQIz+0/I6YtXaDOiwomSXSmgjemq+GfIe4tY5HLtSkJXZlPCN8oOo7GzqqmMeG0y1VZa
Jv2AFa1s6w+IJ51xo+t/YPgeFKVhXbTBq2hV9E3nZecQ5+1LGczXmno+hPqngVw0VHVfFlpCWJRGtpdFugu
qEU7NxQ7B+JKpTU0xaGtRIRFdMtPVlk7Vy86Ut5yj0ny2AE0G6SPq63U66qax7DDP1rHmx1AV80f2KW0e7D
miN+tubhfJ7mzNbTxzS6g67lGWGuOYGvA+FFgqappWgOwBrzhbCfQzW+ImPgQU1u6trVIiHizuqrPmDBjUN
ttwMVuoG2brnZ3qdyB8bIrmgag8wjS4qtVVf2GMmYpZu4XCrbZEbTR3ICMnzTfIQnuetxFc7ZclSEnxJi1k
Nvyy66g7SQVk5GXL+ocBd8tVXWHojTtzrGS9m+GQveeyNafyQokVpY60EPIRrfhVX5Hh511SfLJh7A/Eo8G
/ozjkK+rjj2Pcy1qTDwNwJ0uG2yRu6b9ZUHPjJwbk/4CftzvEPrCZxCfRZLsIbhhI1GD3JNvmulIYtE8XkO
4pHS1Q2h3YiTsXGntxPa2iRtc+deT456+DVuJOU2Wnvna7BDaTq09GKcLOhWjKJ2ZXIJSigPRKy5BaU8AAA
IGSURBVJRGVvpql0r7mRP5OhGaOjkk8WjrvERPh+mHjMOz3UI3/0a2gaSCCAqSWfx/gJmgifgas6DRW3qn0
D7f5jwiI7ZgoCU0SpgcQsh8YHYNPeekHAxJwLkfNCTM0PLxUrnZObSfOa30LWdeOjnyRAQhwGtI0hx3Db17
snN7iEF0tIBeM/QybwTu9iEaF3uANjpz7fK4antabJzFFvhxZvYAHQ2yHlSvGY6rjHWzF2g7te5b1meTyH9
U7QXaaCxQJIjFBtAb/OJVfYHlynWZu8V6rH4uB/1mb9DNuBj0/f6gP5RihmZ/0HbmVKZc7RO6OS0DfbZX6H
lRd+wJuuvE2L/c7Bl6aWq9kTvqPUMXODHOzL6hCxjkav/Q2xtkUe0feluDXJsDQNevt4M+qQ4AveXMCTb+c
s4G8+l0dbzlBG+jdreFftgCujkU9BYzp6vDQW9ukOaA0B+2mpQeCHrDEyM0B4VuNsrWJweGNtPhZ8bL5tDQ
9XTwaLw/OLT7isXAyb95BtC1+WuQOerqGUBb7L8HTUmfB3TV/Kf3B/TvzHOBtnOwnhb53lTPBtquPuheg3D
bhrabT7dX+4zH77dvqCy0/1ZcL+ZnBe1+Xq6L+cfmWUJbA35Zp/ZlZernCe1WL1Ziv2/KNLQj6KaZ/jpqXU
06r031zKHd+lcBn/30NXx/tUDN/wCr1MAOVjApiAAAAABJRU5ErkJggg==",
// "file_size": 1024
// },
"mode": "DD",
"frequency": "AS AND WHEN PRESENTED",

BSE StARMF v2 API

258
 "request_type": "Entry"
}
}

8.6.1.2 Response

{
"status": "success",
"data": {
"investor": {
"ucc": "8kr4EBmr"
},
"member": "0103",
"exch_mandate_id": 30
},
"messages": null
}

8.6.2 mandate_get

8.6.2.1 Request
{
"data": {
"exch_mandate_id": 30
}
}

8.6.2.2 Response
{
"status": "success",
"data": {
"exch_mandate_id": 30,
"investor_bank_details": {
"no": "6986598569865",
"vpa": [
"shivam02ahirrao@oksbi"
],
"ifsc": "UTIB0000145",

BSE StARMF v2 API

259
 "name": "zdsd",
"type": "SA",
"branch": "Ghansoli",
"micr_code": ""
},
"max_txn_amt": 2000,
"cur": "INR",
"valid_till": "2035-03-15T00:00:00Z",
"status": "RC",
"start_date": "2025-02-21T00:00:00Z",
"reg_date": "2025-01-15T00:00:00Z",
"type": "U",
"ucc": "8kr4EBmr",
"member": "0103",
"details": {
"field1": "",
"blod_id": ""
},
"others": {
"mode": "DD",
"status": null,
"investor": {
"ucc": "8kr4EBmr"
},
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"client_name": "",
"mem_details": {
"euin_flag": true,
"member_id": "",
"partner_id": "partner_id",
"sub_br_arn": "arn",
"broker_code": "",
"sub_br_code": "code"
},
"request_type": "Entry",
"mem_mandate_info": {
"umrn_number": "",
"sponsor_code": "",
"utility_code": "",
"member_mandate_id": "",
"mandate_status_date": ""
}
},
"audit_trail": [
{
"msg": "Mandate registered successful pending for 2fa",

BSE StARMF v2 API

260
 "user": "member/0103/isec.maker",
"when": "2025-02-21T11:14:15.870888963Z",
"event_status": "mandate_registered"
}
],
"identifier": {
"identifier": {}
}
},
"messages": []
}

8.6.3 mandate_list

8.6.3.1 Request
{
"data": {
"start": 0,
"length": 50,
"fields": [
"id",
"umrn",
"src_acct",
"dest_acct",
"max_txn_amt",
"cur",
"valid_till",
"type",
"details",
"is_active",
"is_verified",
"verified_on",
"verified_by_org",
"cancelled_at",
"cancelled_by",
"created_at",
"ALL"
],
"format": "json",
"count_only": false,
"sort_dir": "a",
"is_compressed": false,
"search": {
"value": ""

BSE StARMF v2 API

261
 },
"filter_param": {
"is_active": true,
"is_verified": true,
"type": ["U"],
"member_code": "",
"status": ["A"],
"ucc": "",
"created_at_after": "",
"created_at_before": ""
}
}
}

8.6.3.2 Response
{
"status": "success",
"data": {
"lists": [
{
"exch_mandate_id": 9,
"ucc": "8kr4EBmr",
"man_2fa": "n",
"man_2fa_action_at": "2023-02-15 00:00:00",
"member_code": "0103",
"amount": 200,
"cur": "INR",
"ifsc": "UTIB0000145",
"acct_no": "6986598569865",
"bank_name": "John Doe",
"bank_branch": "Ghansoli",
"acct_type": "SA",
"mode": "DD",
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"reg_date": "2023-02-15",
"start_date": "2025-02-18",
"end_date": "2065-02-15",
"type": "U",
"details": {
"field1": "",
"blod_id": ""

BSE StARMF v2 API

262
 },
"is_active": true,
"is_verified": true,
"cancelled_at": "0001-01-01",
"status": "A",
"created_at": "2025-02-18",
"audit_trail": [
{
"msg": "Mandate registered successful",
"user": "member/0103/isec.maker",
"when": "2025-02-18T12:31:48.783716754Z",
"event_status": "mandate_registered"
}
],
"others": {
"mode": "DD",
"status": null,
"investor": {
"ucc": "8kr4EBmr"
},
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"client_name": "",
"mem_details": {
"euin_flag": true,
"member_id": "",
"partner_id": "partner_id",
"sub_br_arn": "arn",
"broker_code": "",
"sub_br_code": "code"
},
"request_type": "Entry",
"mem_mandate_info": {
"umrn_number": "UMRN987654321",
"sponsor_code": "SPN456789",
"utility_code": "UTL000123",
"member_mandate_id": "MM123456789",
"mandate_status_date": "2024-02-12T10:30:00Z"
}
}
},
{
"exch_mandate_id": 28,
"ucc": "8kr4EBmr",
"man_2fa": "n",

BSE StARMF v2 API

263
 "man_2fa_action_at": "2025-01-15 00:00:00",
"member_code": "0103",
"amount": 2000,
"cur": "INR",
"ifsc": "UTIB0000145",
"acct_no": "6986598569865",
"bank_name": "zdsd",
"bank_branch": "Ghansoli",
"acct_type": "SA",
"mode": "DD",
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"reg_date": "2025-01-15",
"start_date": "2025-02-21",
"end_date": "2035-03-15",
"type": "U",
"details": {
"field1": "",
"blod_id": ""
},
"is_active": true,
"is_verified": true,
"cancelled_at": "0001-01-01",
"status": "A",
"created_at": "2025-02-21",
"audit_trail": [
{
"msg": "Mandate registered successful",
"user": "member/0103/isec.maker",
"when": "2025-02-21T10:50:32.169068276Z",
"event_status": "mandate_registered"
}
],
"others": {
"mode": "DD",
"status": null,
"investor": {
"ucc": "8kr4EBmr"
},
"frequency": "AS AND WHEN PRESENTED",
"debit_type": "Maximum",
"client_name": "",
"mem_details": {
"euin_flag": true,
"member_id": "",

BSE StARMF v2 API

264
 "partner_id": "partner_id",
"sub_br_arn": "arn",
"broker_code": "",
"sub_br_code": "code"
},
"request_type": "Entry",
"mem_mandate_info": {
"umrn_number": "UMRN987654321",
"sponsor_code": "SPN456789",
"utility_code": "UTL000123",
"member_mandate_id": "MM123456789",
"mandate_status_date": "2024-02-12T10:30:00Z"
}
}
}
],
"total_count": 2
},
"messages": null
}

8.6.4 mandate_update

8.6.4.1 Request
{
"data": {
"investor": {
"ucc": "8kr4EBmr"
},
"exch_mandate_id": 32,
"member": "0103",
"identifier": {
"identifier_type": "nach_scan_img",
"file_name": "nach_scan_img.png",
"file_blob":
"iVBORw0KGgoAAAANSUhEUgAAAWgAAAFgBAMAAABkmP6LAAAAG1BMVEVnrs9Xn8V4vdrv7+9Gj7uLzuX///
+f4PHH4uwR+sD+AAAgAElEQVR42uydy27jOhKGGwcYzGscMGDHy4ENXx5jwIBW1jF8Wcdg5OWBDVt57BGri
hdJFGlZitIBRnFsOWGxPv5VRUqK3P1rh9tmhtsXvf0syu1zqJ5/jQC9+sxpO/4Y6FWen2DLi5L6h0Av8xPq
XJRfHz8FuihQaKCe/QzowmR0yXzKTz8EGvO50DqXmXL5EdC5U1rnyPFnQBegM+S0rsmfprTOacqP0aA/Py/
dPR1AaT1J03YaE3oFHh+ANkJDjhQ0640DvSLfXT3tSWm3XcaDLsjzsTM0CX3SZajL8Tga9BKSQ2MvOkKfkB
VmDtjrD02vC/p529uDdljgZJtsXHlbIClYFziJ3G3b8vZeaDzqwczsCo2kuZmn87GgD7l1Wh5fdvKU46oCR
0uk+GIcaHt4CVs36JyO73IbqpGgqfxxBshvHTyt7JqS2/XlNgr00jo82RXmbuiTixJNJONA5/5WYCXd6WlJ

BSE StARMF v2 API

265
tIUTOv8YA3oFMx16Ppn4doI2szSKPQq0lcgE+ni/pyIv/EW8GE3pPA/nR7cBu9QeA3qJ/jz3lB8dBlzk3qn
iSNCUjoVx/tEV2p5wjaV0UYkt8neAtjld5CPO09Xl0EvqO2xX1aUFpb6NlB61nMak7gCd1417Qd9xIHvImz
PAvcfE+3qI9NNlhJOAQxX5ZM9Ou0D7GTbGmcumIhRtm/s8LSuznXeS+OWnW6G8vNNTUdP5NJbSQejjfZ5Cp
vdG6Y+CPo2idNHiOW27+T7ofUtSp20PbUH6P/T90Jd7PO2/D7pNrwehx7mW11ZOadtl2xQ/wrW8LOw7bVt8
I3T+KHT+p0Ffvg+6+3UPd3qatg0WQ/cD6Icu1hQPQq++E3oedp60XYYHOw500Hn2p0MH57wHoW8jQa/q0Cr
PcnVL2obSSi1Ggp5pTPwqafUXxDlpW4BFPUAjQS+Uk9jt3AFNQcGvcq98ZKNBk0OQWO+oklmdkrYVoZU/44
0BTRN1poktwmvSNse0gmGiea4+RoO+lmEtN620gl1I7pTtqmyaK6929bvxoOdWaaIA6iQ0DE0pZQNU6n4bE
RpqCJUG0TT3JWG7RG0RFjY7440Bvaca1OxKYYrk6piCxoxQyhZkubcbEToDTpyqFYU6BX3NndKmGk9DQN95
FyMkpSKRsSoztU7YXjUrwhpq9ZI8Yv7UU9Xn56L3rROr0reC+jf5odV7SdhC0xyZFS2mxxT0SmofUslT7/s
9lFlTqB5h/ktBg74gNUw2uiJM8UZvLEFRSuqe0HZJBPcKB/CasM2wIS4wlCbJ2zavijKwXHJ7Ql99pRHGHk
a02W4yOtogU/0ik2eBZoYqzeSlJzT4tYLRRBa3PdgiRAswTjlaZnbZz+yBwoPQc1zXcIXIaJFLKL3PTEJje
CCj7lInJzN16QW9JNcm3oiegKZhIjZmVBI6zxx1po59oVErhCDN47ZzExAz3nJ7Sd1sTT3TkvDaG1q5/ujd
Imp7dflkhpyvE46uWDUmrVQv6FWWZZ7YiCJvUVuP2JjI1O31XtVA+0svaKkCWwI6z7yNLBI3pmZZ1aYX9Ex
VkwM2+RGz3WTNTS7ijuZVUUwlDgDt6Ncx20MWMEk4qgan7KAf9DWkWxw6kFFZ4k8ODZNjn3tNy8PMgNKvMd
tlYJhZ4i6tRvt1n3tNd9tMqkx/4wNfOkO/xh01dekHDWuyFz0SLmI7V26M5hGH1ofStQT86AcNTp171Dtme
+2s9Bx6VZ4j1Q/6UE0P7FbGbJXyWtLuS9TRFaNpY9pb6Y3NZYKBvUsMOnP5T/rJY9QRDZG4Af3WC3onqb+y
Y+iufJYyBg1NHDEQXWKOlhQYRVb6XU9oAHazh0amaTRse5AEnGXSlLCMQl8pijRAMN/1g0aJDbVEFaPQygG
bJIk6khQQSmzt57Un9FVCl7YOIX4v7bZ7KYFWodxAI6N/65CuACgPzZWVx6ErSiO/jEBvM5QZQIgmizm6Gn
2hb8yRW0/ordQdlQ/YIPUyPLMI284lDg2fAEOvoO2OUIaK0tmuL7QRDktKQsFEoK+6EUmGrZWMQS8tMymtB
9kXeo9Ko9QQev0VgTYTXkarnIQSaHU0lyiKiY3eXfeFPpjswOkOpYhAK8okk1DaKgaNcx31DUZmEX/0qinM
SDLDIAOJQpp2W0lHP+ZF231EruxIozRwI3zfD5yVFFY6lZGCSrZekF3JmtJ6LwI9xyIhkVHp1/7QSprJDpX
WcwLMSS3QmPQ0yMy0bj0LNsWKTcFoPQi0lRqEkBjwsO2SZgCTTiYuredmVOLKKS1v/aGvtBxKqkLoet1mO7
dZYZMJKqDF0ZZaKhMZvbsYAtpQ2NcsCm01w2TCtaLFkZL13stFYNcfeu5VlC2v1zbbq4u1s2t3RGtspfv1Q
NDKm3fj0MoLiHlubWwF8cpFlWXbH3rpKayS4jWjHSkAl3q+xW4A6JWsbyoBrSoTu2qHXrni9jJwCOiZDG3x
xqrSNjI/1puW28vXQS/uDYuU4hatWhqkwkPU2ErUBVq1gIQLILDdBolhf+i2w4l5aIDtJR7YsmGgr6G+1/d
Dy+SyVUvpfvea4tu3YN/hxudQ27aegyE89r51Ak9VQ31Pwo1D4rWdMRx4lxF2hN53gBbhpsHGwVTKBoJuUy
TUONTytfWCWzjtxoYONm3hCLYVx4Ggd1w2oy7uhhYt0MFSiV7a7AQtSxQuao9Ly5UdoUfI6/NBoPG7blYfJ
J8NBf0ejmMQWlMIHKMbXqhnCgo1oi8pB4M+S1HXWWdqCFr75XdFfMubQgucaQaBngaEDkNP9fDq4wv3fJbS
CmzkpvwfBPqtoTPXs2+g8VnIZtEGe97Y6nZ6lx1fBoPeorbuofsP/j0TahDSWY9NP3H+HOx5y3XFckFxQyG
oDgeB3oN/BIbw6xqT4fUC4y1wlAASTtMz6SwsuX6dDAcNhS4Q2IRfiNCfwrjJUj1K4YPUG+seQArQAnc5pf
Qg0DuuN9M7uRCX4CJXURoi8hT8XIdJDKsFJNZliHtN6a2gOHJpZzQuAjfLzI3S3MCUO8FbFs6U8mZwoArnQ
3zgzEGj0qgxeChhAtCYorgkInY5uFDP1EQirFF6MiT0O6JwXLug7GUIeoqTNCktYaAsdO/QAbvjNoSow8uQ
0GezDNIsDd9PzcZn+hWOjZQO3Vo2tYMHpVEGLgb95xSnwoM1E+wkAC0cNTxKOxbqWdiQ0cigy+dBod+4tNl
M3OVTo/FC0LGSa2OLq9L4APljRkhrS5kdg0JvOfOIySFrNhZeNOhJPAd6fsMEwga0eOpJdFDoPR3TCJMmgN
68YRhakISGfxLo+R0bUDu0kIIP+0+EHjhxSvtaOmrcMb/iZhNuSnhq9nxgwh8dRqUc3rDQG+vF3xqfTVhyU
4Ie9+9mz1s7CREw7h8H/sdYQ8xi0rjZmntSc8qVwEc1zlZmOhrEzJsNDP0ueXN7rjee+kOyC2ej51DcqLtB
oc8hpXm9caAVZx+NnrcBASjbhoXmoa3eOBAPIW6NnsOdscvQ0NNWN35jwQJKLxo9B6taPKcxuh1Pz6ZBR/W
PGAYbNW/wCEM/DfaBM/N2zlm5KNon/GK/a421+gK/8cnLIddzS3bcBofW6nAm6MkU/FO18YEx+L3+hmb67X
OjZwEjbzx2g0OvGKiBrKimTsPa5wCZmb2QHHYmLeOvPdjT8NAz7R8dQI6gY1a/KsBJam7BxFOjPDhnrfUxL
DQzicoYqg37i0rjN0poGwm9+7velagobb5rXQ0CvUBlKWWt0tU7Qqf6RxRtqFf9vK7fEs7x5yYS9D3ZfYHS
Z+ZRW7jq/eTnitI0vvrH+aeMc4fMqCu2/hJoy8xguhOB6vHC7rSs/2sPNKngo54dA0NPGdMuGM17FOLnSmM
/7IyyiC1qF6sY496sYab9591XQOujTvDHUWnITFaZXGc6CuYhTOMa9JvOCcwtihdkye8vgd4yBu4EsoBLU4
nUeMVwUYEHsXFW/6MC9cMwoakvc1TVjvH5CPQSkYVRGqOP9WPOfn2lTVh4tasNlCEul9wx8xTG/NfkAegVA
xrCYYyof3uN56xCjaP7d+2Pv1pjbp4s9SSBUVYCe+kOPWPMzk+4JkLmTrzGUyZcfnDimlS7OmPpabk5d4de
xzjGDGrktuv8H3YIEpjRhtzcazyFnzuloVon1a6wEpzSqDZLYJzB4rn7/zIiuAus8Vy+VrrmDojT2J6qN1b

BSE StARMF v2 API

266
Q7wRFCpKobBTH2NJ0e+kM/Y8hFsxorve8EzucEyDZGe3r3/tdnZnbhPteRzEORoKXztD/YcyPLLNK2sasui
F7FZphBbulBztdRDH+azxPOkO/VaJuKpFNbOONmVFs+PVT5fLc0qsJkhuLNYZxti15Z+itF1fuMvdf7jr5X
17cKfPZ3xXof/7H3LX0tq1j4UNmcuMlmU4wXTIK2mbZxqjqbRcDzNJNUd8uOxGiepne4nadB+rkZw95HiT1
chVHBYa2rBcf3/nOx0NakZyiN622tquL2FceDVowtagK38j573a6D1CjKgn0ac6BqdzS7jqvbGfQ7fRRMl+
05d4B/a6v/IviYFu7y+i+8x1A1/2Yi9MG6K1Mnw2qY/gikc6dOxnoeFH5+peg+ytw5Zbr4g33Pr4j1ucDbd
6NBb3oF9hsuN2FK54I+qoYEjXlvdrqh3BNtb/8y+F2ly0lPh709aCoe8eWLtPLfk9tBtu9bbnm5PGgvwyAL
raBzpgeUMfB8B3y7QKrx4O+GMDsvjfHlkbaT1VtU0dfuy1Bh97z6Pl0mKH1J7qG9K4X9ItU1fVQPx54ILmj
pv3HfwmYD40uOJL3OJMbihN5vaVwT7u3nfx7O4AWTTa95grtvtP3lu2g+40qhm6l6U4K3I8dQM89vPBGnOk
dIu0cJ0PZQXrpDHRQRw9sGLgrZe06WXW9C2iup9u0Djl7w7QuYlWuaJsb3sVAu8uUV1w72wW0rwjryMgMK+
eXUxwI8Cy+nGwHekQdrnc47G83F7TjFlc7MU3dX2uuyiWB6434gVALzT6TVHXdJJrtc6vedt8CZRDLWR27g
H7tAWuErRmwxg8P7rSaR4VzBmzM+dmQqEM32SPU/b+c4ThD/PAH9nYFnZD6elBujN59XhPDTsBpNCYM0imK
aywUmUad9jW01IkR1F+o98duoM+0RiCo5IJQEEpXwCddkCPYIGH6R/ISK6aI/nDuZV9Dt6wwLMH9N4ShnUC
/FZwFk0oAqFpHu466DWEOfXRVx/kamYw52Hwo+35lANBNSABX5/O+3BH0mppCwZG6kWbtHPdKVnwhB0ODf/
DAxE6msixrN+u7aJjkzExjheWOoBfQSUS2Rlc7oRv7KUNn1b7WTJ7WkWkX1NFtaKljTfhBhfbqHUHPX8ivU
fOjneeFE+gcoRx3UKFfu/2a1OEosjPT9IJNt6FbzQLjYEe9gIjeCXQpu2VdlmEJs+T7TwUCR+3J4tIgg78L
zySTblBVYTnoNvQWYi3ZhzvZ5V7T4V2PfF4vfp4TcBp1NYPCVfhickFWaPYFdVEPpVPzWgxufLj9cqdbJ36
5Wz0gcCfylhWSdFVojjXJD5qm0q0vhTo3WLbg+/z3gMYvVH97jevkXZSD10AFJAjqfSIO0O2qyltwmcxEbD
CrfiPoeTl/OA+4I+qArawvWZxFMiVs7XW+FOKUgyOLKySMwGZS0CWlXOLz+f0yxBNu3bf/sr7iLd1IsGnVv
HbMrkvaCPhX9ZSgFw/3+ETh/cPDQzjG3aVeEGxOuhYbROkMqF3zUruM6Jj260lAh2vg95+8DpTCOE2rF38+
hCdBMPO7c4IdMEDRZFjAzNr3XkMOlaOjL/5jCtDV4qePzMajguRqDTTOvJB/4OzZjicbaEQkcNK6EbGZK6a
9+smgq+oBQ7LmQblBHyDyF3c8TkSjil6m7xo1r1uKj6l8Mmgf1BTE0JX3KvFpwK3/xEtdi5+B43iyxbRu1r
yEXtSwqp8Keo0TDU1LAMObAgaYcE93+BGGKtNIB82sUfPZgDgO6ilACziGyJ8Qt0gAHvarEP4qT7bYKG9en
eQ1f4XcYSnB5umgq4QN4pJt+CUAws4Hh6/u/HCzOA8dIMMs4Fb5XwpdyyJ5n9RPB127EDKQvCDeiFnj4cS3
o6ChP/sIGMhuiToUVPktn1cgBjWsA11PALpaiguJMqQ1RmSiSijDSLJ/V84Dj8BZXbI4q/kMdJ86NHx82r2
mvHuFYQwc40o4A3RsFJgo3jGvyqqc/yVQo1UaYs3lW5AatY75wmv21DtraPcG1cpu1KkB0gWwScQo8glKe2
VXt6k/0jp6Pkw5Yo0uF7Xrfu3dDfRrYKYJYuo9UeGZIolXT7Yfkt45EDvIKQn0EnTGdBJ1EMckoL8g04w6J
5V5zgIF4QDMf1eVC2diYMfy8s3tOkqLmI7lD+qJQF8I0yhoTEQOgcTeh8cZs8a3J60s50sj2dFiuSESxFWk
46g4DNGTgL7keZFL0yXikmCyNVoMwcOY4ZWfdd8ayk5lJPKTJdhVIEYdv5zUU4H+aigsUQucCCRjjkzLwmb
th79IGMbnP1TJERrYcJYN2u2Xo3oy0GsjF2nAxegEAhRRaubLcSiQ04g6sgqAtx6fGcygIwOR6c10oCvDgh
Ogol/NkF37GhTHBB/7zHc/XTXckR2Ei3OXEIedFObDEXVSTwe6NhFLik4ZwGwQSdYR/36g8THszEr+517Qx
zFHa63rKUHH0Vg32GSlQg/PLKBw1nyu658iBo2CBhncY/TAMqtJQTto8CqhhFcydsSQl7klJDuj3ogKWJ2Z
Zl06+mRWTwr6Q4NQ6Yi6YYED6NpGOdWsrq4NHdqHGBQFLG8fluWkoL/lzLV7nWtsM/ON6AjKT6BuTVdDjXQ
3nxb0TU9LrWAybAhOoGZldWV6RBajkDqtpnlCP+7ewG4pYfcKqZemRW5u8dFkD5zJ7ht4clIHdfVh+PRhOT
noG5gA9axeq8GTq3py0K8nAA32tP46gFqd1v+noEO8vjS9Z47q3wD6wkyC2s8trvtqMpvfAfpyGtBgPzcCn
9gy6a9OpCfDJwIN9uP6uNtDq98Cej0VaK+Er7Yd7TaPezC4Ggl6waANKFBPk7XZnDUZsHePeJq5ni/uz52v
xULxUP6CeDAqvAkxbdN76BUuv0dwJmb2NRyWN6YpjvGgF387a60xoS5rZ+V20IleBY0mCUi2yHF6s63NoXF
+DMm8w3L0c+P1rQec++io3PpHt2NqXgluehN+01iMHIamnUi+MRiu1xbERPtxPhr0peW/9IS20e9HWy2Osw
aTi9owIAPEpxHULAixjZvC/H7Dnrw2ZJlRz6vRoH3cMUbMpzrt/mYL0x/AmCjr5HX6MBkuMqZJNgnERHbB3
H1j15jNiCBG8+nqA7auAhlhhc3Zoy3T65voZRXFSi4yyCvWwet0xOAelUJvKDJOmQUeUWpv/POIZ8HJ0gpT
YcLUYLDwG0VQ0TskbdSniIId7yORTZFD+iaVQvoV1aP+dUu7m9Ggv1qqAhf2e2DBHpRDhf8rHBtyvREXhdJ
Kjht1OL+1dMQYbiKUY6bJ0HBcza7D6nD8k58fjBEngwKJtr4yy3/47xb+QmDF1UYiH/cL5tR4ifrpp2UFI6
sqhhWWJHrK2M9BPc9Ggz6z1LtFc9izDHmXfhmqW/gCGTMkUQkMRjiVbXgevudVS0skizMJKXBhjuGHf/mjq
7Gg10rqEVnEqj1q/BGuPtCUkwc2k4Vq3CcsdkVl3ynL3hNnMjexb/rGDh2YciTo8sYqhqwiT0md9nvVV/hS
Ym4WfhWYVJC2N1zWk22R63iKeyKbiVZq9e96LNMWIkzFvUTJYOA/zV3VDzr1L5U2wETV+GRfxpbukeyovKz
J5N+Dj2OZfm1MRgFtgay8QdbPFLuFvxowWZsRakNqrGm+K8TZaJ94VfwrDY+8/ALlh4wyrjWlcNRPQ7qF1y

BSE StARMF v2 API

267
ZPqqWMBCQZXFZ+ehNViCaRYmLfV3Ys6IXNsYLpSXa/56GIrP1YDjdN6iDQNLhcHNvMTrGU1gH7UTUS9IVpN
mzyXsnJ7nUL26zbNklveMoe5Q/dI9mknKSqVO7ZWKbf2GYzqodqZbu/YKF6U9dTvktkZaufynarl/THWNDf
1K+TsXY1DnRPsvZjVraur60dsNVH9ZGg+5jtkTWF/azw8biCoez700bZdz1kU8a7saCv31vPZHjTmoqHzSZ
fh5vGvBaDjjF2BNVg7b6P9Wkuvlja3nJm7EUBqCNqQMgRutjCFuD3r6zwDWeMq8Ee4Su2foTKygZl98A+Gg
+6/vbeRNYYhsnwM/s2zPhy0CZhVjn4/G25wijseHvc8XvbasCY/zwCNHJN6jBGmgkbiSs8afMLP2HGEuURV
m280Vg6ZW3zNyCrn/9oyDHsPHsMaOTactNIKrMWXmQFsXWSFX7zPuVRuGrAjqbg+ZDxn63HJNee7P81cz7P
bdtKHB9N9Tw+CiniybVT1+NjXzjm01Frr1Mf48bjybGvGDM6Pr90em7qRJM/uwB2Fz8oiSElSDKkKCRFAp/
94oslRFOivcRfR4OgzW3oLEUKczVRJ+ccpdKLmW+V7w3ai9Qi5fmFoqe3/E76Zevi/v+1ikHanc4GQTfNLd
tDIEcst9fSy+zbhuRWM/OohJGx/K4TDsVXIM6mLRpaPxxgxZZhbl/Gi4HQ5lQ4SR5pcEIaj0TIyzo5+BZGb
A/Fqgpf6PHQZwQPrV/wMP8DRQ3bHXQ9ELqZswVIqiiXrZA8wzxpF5u3EAIk/0xUkhNofcQm4UrP65zj4gfF
blKqGQptHhThOUr3j16YlcekfersL2WPwFaaiBs8+4iHJ2kewnDV6xd8v3n4jPJWKTbkcOj6NQT3scgTHn4
+FDKsbfU4resW/LsTiVFxpyjpIwlW+kKp2VN+4ct8UZwGhkNX9V8EwL1M5lbiWG7cpa7jpC7zyTdIb00kTG
YdjUKwEzGZfYXz/CqhP63b8mIDaDuwCJGolRhykpjGb9fZr2RbrSXQ4CmOtq20PPVxPiOwn2m0feN6I2g3G
KVNP7iCzckCfpPVCj6apC6bQ6Rz2N08G5gk0Utyoa36ZetPDvYzDaqbjaCrqZaWiZd1p8VEQniXDqZHUGG/
aG3efRLslvShm0At/YKHHgCdTVXtYIztRYiEhxqdZfdDkUM4s4mtRpIvMtoRC6DhXZPPmJvpce+bIVq3Tjx
ChBzl+CoiKHWZ/mybmwUEjSdttSdxYZTYnYbj0Fs2Vt/vcZq1lDSYELvB6E+N8UYbUEtllAU6WYoCX9amEP
SFzkijMq1G9XVal7mDGNkoGRMJ+CQ4hbf480wR6Pr1CtFWFTdnSy6DPELeN+2uWlnF7MemCHRV3ame1K+yu
m6/HWxy0uRlOG/KQM91T2p8lf6dwPzQs4vyOo7LQFd9DUJntnjs7UbULxZFoOs/oL9OybGbaa1nixLQ1Xzc
W6fz9O8E80Ct0ZV+MWh4XwK6dwZxWqe51pzSgTh5/1RVX39V/bjxuAB0Vd/1pnbTkGQQO2qN5/wF7erLGHt
R+/PMltBu5tTXkpY6OXZ+C3r2FIeH+aL7xK8vP5qtoeufYQB1mmutQxZZp03HvajhfGvoqj7VSiuwz+Rh5e
cXt+rf9u1lf/ybv2udL+a9qNVsCPSameuDmBH4n8qpk3d1Pr1e+naaN3o8zNUQH8DS+Nn0Rh8C0m9VfwKq1
TcnqkZWVt6TaP4os/YuLToclqpJy1UB6DAWYysQ/CL6a9ZP0yfstTeHvE5RfS3yiJtOSkDbsWjr8gppphWV
tdM+MzhpvbYl220yCFpS27q19t15VgK6qsaeSQdbA3h8L62Y1L24LQgL09GSGcdxoEmFLAAr+n0R6PoCE17
3JE5SGvJUYh3yseuevgtvaBe1TuwVraJwUUZpO3ECaUhM4Qn9MssVfI7w1NGSO8dqyUMufqA+8nW6B9ZloC
ub9jRbgYach6TWkvQXtO66FfcB+TgA7jkSQbPS0BSCduPH6+mbER+DH4Y6paa9cNbRxVZqPi52GVnFp0+4L
AXtE6x3nWcEUpqMocQcLL4LCaFe39IHpOjFXcByk9H43FIC2p1hxLTQWgAtw0iF/sAO6Oozj0UaEErkJnfr
q2LQPlWRmpxk4wIJL0pTPNjV0gOCHMlhh9RnF47KQVf/RW6HWyKrgM/N1D6t0l6dSjensY9kSepWeF8Q2rY
kikgRdVCBSlZ9dyy6qvodpC55shpajiwF/TuKlnTC5YbjUjCP/Yd/dlVlUOXhJzLgoBvmv/ndrbEILX0bQm
g17zYddVVV34UMFCQIz+0/I6YtXaDOiwomSXSmgjemq+GfIe4tY5HLtSkJXZlPCN8oOo7GzqqmMeG0y1VZa
Jv2AFa1s6w+IJ51xo+t/YPgeFKVhXbTBq2hV9E3nZecQ5+1LGczXmno+hPqngVw0VHVfFlpCWJRGtpdFugu
qEU7NxQ7B+JKpTU0xaGtRIRFdMtPVlk7Vy86Ut5yj0ny2AE0G6SPq63U66qax7DDP1rHmx1AV80f2KW0e7D
miN+tubhfJ7mzNbTxzS6g67lGWGuOYGvA+FFgqappWgOwBrzhbCfQzW+ImPgQU1u6trVIiHizuqrPmDBjUN
ttwMVuoG2brnZ3qdyB8bIrmgag8wjS4qtVVf2GMmYpZu4XCrbZEbTR3ICMnzTfIQnuetxFc7ZclSEnxJi1k
Nvyy66g7SQVk5GXL+ocBd8tVXWHojTtzrGS9m+GQveeyNafyQokVpY60EPIRrfhVX5Hh511SfLJh7A/Eo8G
/ozjkK+rjj2Pcy1qTDwNwJ0uG2yRu6b9ZUHPjJwbk/4CftzvEPrCZxCfRZLsIbhhI1GD3JNvmulIYtE8XkO
4pHS1Q2h3YiTsXGntxPa2iRtc+deT456+DVuJOU2Wnvna7BDaTq09GKcLOhWjKJ2ZXIJSigPRKy5BaU8AAA
IGSURBVJRGVvpql0r7mRP5OhGaOjkk8WjrvERPh+mHjMOz3UI3/0a2gaSCCAqSWfx/gJmgifgas6DRW3qn0
D7f5jwiI7ZgoCU0SpgcQsh8YHYNPeekHAxJwLkfNCTM0PLxUrnZObSfOa30LWdeOjnyRAQhwGtI0hx3Db17
snN7iEF0tIBeM/QybwTu9iEaF3uANjpz7fK4antabJzFFvhxZvYAHQ2yHlSvGY6rjHWzF2g7te5b1meTyH9
U7QXaaCxQJIjFBtAb/OJVfYHlynWZu8V6rH4uB/1mb9DNuBj0/f6gP5RihmZ/0HbmVKZc7RO6OS0DfbZX6H
lRd+wJuuvE2L/c7Bl6aWq9kTvqPUMXODHOzL6hCxjkav/Q2xtkUe0feluDXJsDQNevt4M+qQ4AveXMCTb+c
s4G8+l0dbzlBG+jdreFftgCujkU9BYzp6vDQW9ukOaA0B+2mpQeCHrDEyM0B4VuNsrWJweGNtPhZ8bL5tDQ
9XTwaLw/OLT7isXAyb95BtC1+WuQOerqGUBb7L8HTUmfB3TV/Kf3B/TvzHOBtnOwnhb53lTPBtquPuheg3D
bhrabT7dX+4zH77dvqCy0/1ZcL+ZnBe1+Xq6L+cfmWUJbA35Zp/ZlZernCe1WL1Ziv2/KNLQj6KaZ/jpqXU
06r031zKHd+lcBn/30NXx/tUDN/wCr1MAOVjApiAAAAABJRU5ErkJggg==",

BSE StARMF v2 API

268
 "file_size": 1024
}
}
}

8.6.4.2 Response

{
"status": "success",
"data": {
"investor": {
"ucc": "8kr4EBmr"
},
"member": "0103",
"exch_mandate_id": 32
},
"messages": null
}

8.6.5 mandate_cancel

8.6.5.1 Request
{
"data": {
"ids": [
32
],
"investor": {
"ucc": "8kr4EBmr"
// "pan_holders": [
// ""
// ],
// "holding_nature": "SI"
}
// "parent_client_code": ""
}
}

8.6.5.2 Response
{

BSE StARMF v2 API

269
 "status": "success",
"data": {
"success_id": [
32
],
"investor": {
"ucc": "8kr4EBmr"
}
},
"messages": []
}

8.6.6 mandate_link

8.6.6.1 Request
{
"data": {
"reg_no": "d18b4e71-83d4-4ce1-80d1-81a67d262da0",
"exch_mandate_id": 14
}
}

8.6.6.2 Response
{
"status": "success",
"data": {
"reg_no": "d18b4e71-83d4-4ce1-80d1-81a67d262da0"
},
"messages": []
}

8.6.7 mandate_delink

8.6.7.1 Request
{

BSE StARMF v2 API

270
 "data": {
"reg_nos": [
"d18b4e71-83d4-4ce1-80d1-81a67d262da0"
]
}
}

8.6.7.2 Response

{
"status": "success",
"data": {
"SuccessIds": [
"d18b4e71-83d4-4ce1-80d1-81a67d262da0"
],
"FailedIds": null
},
"messages": null
}

8.6.8 get_2fa_link

8.6.8.1 Request
{
"data": [
{
"event": "verify_order_new",
"order": "5000000016"
},
{
"event": "verify_sxp_reg",
"sxp": "50f51953-ce35-4c60-90dd-5053c2185375"
},
{
"event": "verify_mandate_cancel",
"mandate": "1234560041"
},
{

BSE StARMF v2 API

271
 "event": "UCC_ELOG",
"investor": {
"client_code": "ucc45",
"pan_holder": [
""
],
"holding_nature": ""
},
"parent_client_code": "",
"member_code": "MBR00100"
}
]
}

8.6.8.2 Response

​ "status": "success",

​ "data": [

​ {

​ "member": "0103",

​ "investor": {

​ "client_code": "CLNT22041996",

​ "pan_holder": null,

​ "holding_nature": ""

​ },

​ "parent_client_code": "",

​ "action": {

​ "msgcode": "",

​ "at": "2025-02-21T08:23:53.21071Z",

​ "event": "UCC_NOM",

BSE StARMF v2 API

272
​ "event_object": [

​ {

​ "holder_rank": "1",

​ "pan": "NOTPA0008A",

​ "2fa_url":
"https://qa.starmfv2.remiges.tech/api/2fa_view_object/292c581d-f065-45fb-a5d0-60b27
2f530d0"

​ }

​]

​ }

​ },

​ "member": "0103",

​ "investor": {

​ "client_code": "CLNT22041996",

​ "pan_holder": null,

​ "holding_nature": ""

​ },

​ "parent_client_code": "",

​ "action": {

​ "msgcode": "",

​ "at": "2025-02-21T08:23:53.194752Z",

​ "event": "UCC_ELOG",

​ "event_object": [

​ {

​ "holder_rank": "1",

BSE StARMF v2 API

273
 ​ "pan": "NOTPA0008A",

​ "2fa_url":
"https://qa.starmfv2.remiges.tech/api/2fa_view_object/ca49cc2f-8eb3-4799-9a60-5a7bf
927593b"

​ }

​]

​ }

​ },

​ "member": "0103",

​ "investor": {

​ "client_code": "8kr4EBmr",

​ "pan_holder": null,

​ "holding_nature": ""

​ },

​ "parent_client_code": "",

​ "action": {

​ "msgcode": "",

​ "at": "2025-02-20T09:10:58.208871Z",

​ "event": "verify_sxp_reg",

​ "event_object": [

​ {

​ "holder_rank": "",

​ "pan": "",

​ "2fa_url":
"https://qa.starmfv2.remiges.tech/api/s4/2fa_view_object/sxp/eb51227e-0927-4b77-85b
0-7511577af70f"

BSE StARMF v2 API

274
 ​ }

​]

​ }

​ },

​ "member": "0103",

​ "investor": {

​ "client_code": "AJEET007",

​ "pan_holder": null,

​ "holding_nature": ""

​ },

​ "parent_client_code": "",

​ "action": {

​ "msgcode": "",

​ "at": "2025-02-21T07:39:55.236159Z",

​ "event": "verify_order_cancel",

​ "event_object": [

​ {

​ "holder_rank": "",

​ "pan": "",

​ "2fa_url":
"https://qa.starmfv2.remiges.tech/api/s2/2fa_view_object/orders/d711f70b-f278-4fab-
af8d-0ddca5edad26"

​ }

​]

​ }

BSE StARMF v2 API

275
 ​ },

​ "member": "0103",

​ "investor": {

​ "client_code": "8kr4EBmr",

​ "pan_holder": null,

​ "holding_nature": ""

​ },

​ "parent_client_code": "",

​ "action": {

​ "msgcode": "",

​ "at": "2025-02-20T09:10:58.208871Z",

​ "event": "mandate",

​ "event_object": [

​ {

​ "holder_rank": "",

​ "pan": "",

​ "2fa_url":
"https://qa.starmfv2.remiges.tech/api/s4/2fa_view_object/sxp/eb51227e-0927-4b77-85b
0-7511577af70f"

​ }

​]

​ }

​ }

​ ],

​ "messages": null

BSE StARMF v2 API

276
}

9 Annexure

9.1 Error Message Parsing in Angular

Following is the sample Code to parse the error messages from the APIs and form the error
message.
The below example can be used in angular.
The consumer of the API may need to write their own version of the below code to support
other languages.

interface Message {
msgid: number;
field?: string;
vals?: string[];
}

interface MessageDictionary {
[msgid: number]: { [language: string]: string };
}

generateErrorMessage(
message: Message,
languageDictionary: MessageDictionary,
language: string
): string {
// Retrieve the message template based on msgid and language
const messageTemplate = languageDictionary[message.msgid]?.[language];

// Fallback if no message template is found

if (!messageTemplate) {
console.log(
`Error message not found for msgid: ${message.msgid} and language ${language}`
);
return `Something went wrong. Please contact support`;
}

let errorMessage = messageTemplate;

// Replace placeholders for the field

if (message.field) {
errorMessage = errorMessage.replace(/@<field>@/g, message.field);

BSE StARMF v2 API

277
 }

// Replace placeholders for vals

if (message.vals && message.vals.length > 0) {
message.vals.forEach((value: any, index: any) => {
// const placeholder = new RegExp(`{@<val_${index}>@}`, "g");
const placeholder = `@<val_${index}>@`;
errorMessage = errorMessage.replace(placeholder, value);
});
}

// Remove any remaining placeholders

errorMessage = errorMessage.replace(/@<[^>]+>@/g, "");

return errorMessage;
}

9.2 Scheme List Sample

Success response

Attribute M List Type Limit Description and example(s)

status Y N String "success"

data Y Y Object "data": {

"count": 7809,
"lists": [
{
"parent_scheme_code": "P-DBT-FMP",
"parent_scheme_name": "ICICI PRUDENTIAL
FIXED MATURITY PLAN SERIES 83 - 1113 DAYS PLAN E",
"name": "ICICI PRUDENTIAL FIXED MATURITY
PLAN SERIES 83 - 1113 DAYS PLAN E DIRECT PLAN
CUMULATIVE",
"scheme_plan": "Direct",
"scheme_option": "Growth",
"scheme_option_frequency": "",
"scheme_addon": "",
"scheme_transaction_mode_allowed": [
{

"scheme_transaction_mode_demat_physical_allowed":
"Demat"
},
{

"scheme_transaction_mode_demat_physical_allowed":
"Physical"
}
],
"scheme_isin": "INF109KC1EL9",

BSE StARMF v2 API

278
 "scheme_amc_code": "F831113E",
"scheme_rta_code": "9315",
"scheme_amfi_code": "",
"scheme_bse_code": "IC9315-GR",
"scheme_cpc_code": "P9315",
"scheme_amc_name": "ICICI PRUDENTIAL
MUTUAL FUND",
"scheme_rta_name": "CAMS",
"scheme_sub_category": "Fixed Maturity Plan",
"scheme_sector": "",
"scheme_benchmark": "",
"scheme_face_value": 10,
"scheme_offer_status": "OPEN",
"scheme_offer_type": "",
"scheme_investment_mode": "Active",
"scheme_redemption_settlement_days": "",
"scheme_nfo_date_time_detail": [
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "New Fund Offer"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Purchase"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Systematic Transfer
Plan - IN"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Switch-IN"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Systematic
Investment Plan"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Systematic Transfer
Plan - OUT"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Systematic
Withdrawal Plan"
},
{
"nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Switch-OUT"
},
{

BSE StARMF v2 API

279
 "nfo_cutoff_date": "",
"nfo_cutoff_time": "18:00:00",
"nfo_transaction_type": "Redemption"
}
],
"nfo_payment_details": [
{
"nfo_payment_cutoff_date": "2024-01-01",
"nfo_payment_cutoff_time": "23:59:59",
"nfo_payment_mode_name": "Cheque"
},
{
"nfo_payment_cutoff_date": "2024-01-01",
"nfo_payment_cutoff_time": "23:59:59",
"nfo_payment_mode_name": "NEFT/RTGS"
},
{
"nfo_payment_cutoff_date": "2024-01-01",
"nfo_payment_cutoff_time": "23:59:59",
"nfo_payment_mode_name": "Mandate"
},
{
"nfo_payment_cutoff_date": "2024-01-01",
"nfo_payment_cutoff_time": "23:59:59",
"nfo_payment_mode_name": "UPI"
},
{
"nfo_payment_cutoff_date": "2024-01-01",
"nfo_payment_cutoff_time": "23:59:59",
"nfo_payment_mode_name": "DirectCredit/
NodalPayment"
}
],
"nfo_open_date": "2018-05-28T00:00:00Z",
"nfo_close_date": "2018-05-28T00:00:00Z",
"nfo_allotment_date": "2018-05-28T00:00:00Z",
"reopen_date": "2018-05-28T00:00:00Z",
"scheme_interval_lifecycle": null,
"scheme_last_order_closure_date":
"2018-05-28T00:00:00Z",
"scheme_final_closure_date": "",
"scheme_entry_load": "",
"scheme_entry_load_remarks": "",
"scheme_exit_load": "0",
"scheme_exit_load_remarks": "",
"scheme_lockin_period": 0,
"scheme_lockin_period_type": "",
"lumpsum": [
{
"scheme_transaction_allowed_options": {
"scheme_sxp_first_order_today_allowed":
null,
"scheme_sxp_paused": null,
"scheme_sxp_registration_allowed": null,
"scheme_sxp_trigger_allowed": null
},
"scheme_transaction_cutoff_time": "15:00:00",
"scheme_transaction_effective_end_date":
"2018-06-11T00:00:00",
"scheme_transaction_effective_start_date":
"2018-05-28T00:00:00",
"scheme_transaction_mode_allowed": [

BSE StARMF v2 API

280
 {

"scheme_transaction_mode_demat_physical_allowed":
"Demat"
},
{

"scheme_transaction_mode_demat_physical_allowed":
"Physical"
}
],
"scheme_transaction_single_details": {
"scheme_transaction_amt": {
"scheme_transaction_max_amt":
100000000000,
"scheme_transaction_min_adtnl_amt":
5000,
"scheme_transaction_min_amt": 5000,
"scheme_transaction_mult_amt": 10
},
"scheme_transaction_units": {
"scheme_transaction_max_unit": 0,
"scheme_transaction_min_unit": 0,
"scheme_transaction_mult_unit": 0
}
},
"scheme_transaction_type": "Purchase",
"scheme_transaction_type_tag_name":
"Purchase"
},
{
"scheme_transaction_allowed_options": {
"scheme_sxp_first_order_today_allowed":
null,
"scheme_sxp_paused": null,
"scheme_sxp_registration_allowed": null,
"scheme_sxp_trigger_allowed": null
},
"scheme_transaction_cutoff_time": "15:00:00",
"scheme_transaction_effective_end_date":
"2018-06-11T00:00:00",
"scheme_transaction_effective_start_date":
"2018-05-28T00:00:00",
"scheme_transaction_mode_allowed": [
{

"scheme_transaction_mode_demat_physical_allowed":
"Demat"
},
{

"scheme_transaction_mode_demat_physical_allowed":
"Physical"
}
],
"scheme_transaction_single_details": {
"scheme_transaction_amt": {
"scheme_transaction_max_amt":
100000000000,
"scheme_transaction_min_adtnl_amt": 0,
"scheme_transaction_min_amt": 1,
"scheme_transaction_mult_amt": 0

BSE StARMF v2 API

281
 },
"scheme_transaction_units": {
"scheme_transaction_max_unit":
100000000000,
"scheme_transaction_min_unit": 0.001,
"scheme_transaction_mult_unit": 0.001
}
},
"scheme_transaction_type": "Redemption",
"scheme_transaction_type_tag_name":
"Redemption"
},
{
"scheme_transaction_allowed_options": {
"scheme_sxp_first_order_today_allowed":
null,
"scheme_sxp_paused": null,
"scheme_sxp_registration_allowed": null,
"scheme_sxp_trigger_allowed": null
},
"scheme_transaction_cutoff_time": "15:00:00",
"scheme_transaction_effective_end_date":
"2018-06-11T00:00:00",
"scheme_transaction_effective_start_date":
"2018-05-28T00:00:00",
"scheme_transaction_mode_allowed": [
{

"scheme_transaction_mode_demat_physical_allowed":
"Demat"
},
{

"scheme_transaction_mode_demat_physical_allowed":
"Physical"
}
],
"scheme_transaction_single_details": {
"scheme_transaction_amt": {
"scheme_transaction_max_amt":
100000000000,
"scheme_transaction_min_adtnl_amt":
5000,
"scheme_transaction_min_amt": 5000,
"scheme_transaction_mult_amt": 10
},
"scheme_transaction_units": {
"scheme_transaction_max_unit": 0,
"scheme_transaction_min_unit": 0,
"scheme_transaction_mult_unit": 0
}
},
"scheme_transaction_type": "Switch-IN",
"scheme_transaction_type_tag_name":
"Switch-IN"
},
{
"scheme_transaction_allowed_options": {
"scheme_sxp_first_order_today_allowed":
null,
"scheme_sxp_paused": null,
"scheme_sxp_registration_allowed": null,

BSE StARMF v2 API

282
 "scheme_sxp_trigger_allowed": null
},
"scheme_transaction_cutoff_time": "15:00:00",
"scheme_transaction_effective_end_date":
"2018-06-11T00:00:00",
"scheme_transaction_effective_start_date":
"2018-05-28T00:00:00",
"scheme_transaction_mode_allowed": [
{

"scheme_transaction_mode_demat_physical_allowed":
"Demat"
},
{

"scheme_transaction_mode_demat_physical_allowed":
"Physical"
}
],
"scheme_transaction_single_details": {
"scheme_transaction_amt": {
"scheme_transaction_max_amt":
100000000000,
"scheme_transaction_min_adtnl_amt": 0,
"scheme_transaction_min_amt": 1,
"scheme_transaction_mult_amt": 0
},
"scheme_transaction_units": {
"scheme_transaction_max_unit":
100000000000,
"scheme_transaction_min_unit": 0.001,
"scheme_transaction_mult_unit": 0.001
}
},
"scheme_transaction_type": "Switch-OUT",
"scheme_transaction_type_tag_name":
"Switch-OUT"
}
],
"systematic": null,
"scheme_category": "Debt",
"amc_active_flag": true,
"is_active": true
}
]
}

messages Y Y object []

BSE StARMF v2 API

283