Skip to content

RMS (Risk Management System) — Fields consumed

Why this page is structured this way: This is the destination-first view for RMS (Risk Management System). Engineers building an integration with this destination get the complete field list on one page. To see where each field originated in onboarding, follow the per-section links via the atlas overview.

  • 33 unique fields consumed by RMS (Risk Management System).
  • Source spans sections: A, F, G, H, K, L, M, U, V, W, X, Y.
  • 42 rows cite a public spec source; 30 are [industry typical].

Sorted by source_section, then field_id.

source_sectionfield_idfield_namedestination_field_namedestination_formatfrequencytransformationquirks_notesspec_source
AA-date_of_birthDate of Birthclient_dobDATE YYYYMMDDone-timeformattedage-group derives client category for RMS exposure limits[industry typical]
AA-pan_numberPAN Numberclient_panCHAR(10)on-modifyuppercasePAN is the primary client key for margin envelope keyed by UCC->PAN[industry typical]
AA-residential_statusResidential Statusresi_categoryVARCHAR(3)on-modify[direct]NRI flag triggers PIS-route segment block in pre-trade pipeline[industry typical]
FF-gross_annual_income_rangeGross Annual Income Rangeincome_tierVARCHAR(2)on-modifylookup against Rincome-tier feeds maximum-allowed exposure multiplier[industry typical]
FF-net_worthNet Worthclient_net_worthNUMBER(15,2)on-modify[direct]net-worth threshold gates F&O segment limit[industry typical]
GG-account_numberBank Account Number (Primary)client_bank_noVARCHAR(18)on-modify[direct]primary bank for collected-margin reconciliation; UPI-Block destinationSEBI/HO/MIRSD/POD-1/P/CIR/2024/118
GG-account_numberBank Account Numbermargin_availableNUMBER(15,2)on-tradederived from Yavailable margin = collected - utilized; recomputed each orderSEBI/HO/MRD2/DCAP/CIR/P/2020/127
GG-account_numberBank Account Numbermargin_collected_cashNUMBER(15,2)dailyderived from Ycash margin collected from client funds bank; BOD reload valueSEBI/HO/MIRSD/MIRSD-PoD-1/P/CIR/2023/71
GG-account_numberBank Account Numbercfr_funds_collectedNUMBER(15,2)dailyderived from Yclient funds collected; T+1 holding+balance API submission (replaces weekly)NSE/INSP/55039
GG-account_numberBank Account Numbercfr_funds_deployedNUMBER(15,2)dailyderived from Yclient funds deployed against marginNSE/INSP/55039
GG-account_numberBank Account Numbercfr_funds_freeNUMBER(15,2)dailyderived from Yclient funds free; CFR weekly aggregate uses daily valuesNSE/INSP/55039
GG-account_numberBank Account Numberupi_block_amountNUMBER(15,2)on-tradederived from YASBA-like UPI Block amount in client bank (not pool); QSB mandatory Feb 2025SEBI/HO/MIRSD/POD-1/P/CIR/2024/118
GG-account_numberBank Account Numberupi_block_utilisedNUMBER(15,2)on-tradederived from Yexecuted amount debited from block; residual auto-releasesSEBI/HO/MIRSD/POD-1/P/CIR/2024/118
GG-is_primaryIs Primary Flagprimary_bank_flgCHAR(1)on-modify[direct]only primary considered for fund-balance calculation[industry typical]
HH-account_statusDemat Statusdemat_status_flagVARCHAR(2)on-modify[direct]FR/CL blocks all new buy orders in pre-trade pipeline[industry typical]
HH-bo_idBO IDclient_bo_idVARCHAR(16)one-time[direct]primary key for pledged-collateral lookup; CSMFA/CUSPA mappingNCL/CMPT/63669
HH-depositoryDepositorydepository_for_pledgeVARCHAR(4)one-time[direct]drives margin-pledge file format (CDSL vs NSDL)[industry typical]
KK-is_pepIs PEPpep_risk_flgCHAR(1)on-modify[direct]Y forces conservative exposure limits and additional surveillance marginSEBI/HO/MIRSD/SECFATF/P/CIR/2024/78
KK-is_pepIs PEPrms_aml_risk_tierVARCHAR(2)dailyderived from YAML risk tier (Low/Med/High); High forces conservative exposureSEBI/HO/MIRSD/SECFATF/P/CIR/2024/78
LL-segment_commoditySegment Commodityseg_com_activeCHAR(1)on-modify[direct]pre-trade hard-block on MCX orders if N[industry typical]
LL-segment_currencySegment Currencyseg_cd_activeCHAR(1)on-modify[direct]pre-trade hard-block on CD orders if N[industry typical]
LL-segment_equity_cashSegment Equity Cashseg_cm_activeCHAR(1)on-modify[direct]pre-trade hard-block on CM orders if N[industry typical]
LL-segment_equity_cashSegment Equity Cashposition_segmentVARCHAR(2)on-trade[direct]segment qualifier on each position row (CM/FNO/CD/COM)[industry typical]
LL-segment_equity_cashSegment Equity Cashposition_qty_cmNUMBER(10)on-tradederived from Ynet qty per CM scrip; updated on each trade fill[industry typical]
LL-segment_equity_cashSegment Equity Cashposition_avg_priceNUMBER(15,4)on-tradederived from YVWAP across buys for the position; reset on full square-off[industry typical]
LL-segment_equity_cashSegment Equity Cashposition_mtm_realisedNUMBER(15,2)on-tradederived from Yrealised P&L; locked at trade fill[industry typical]
LL-segment_equity_cashSegment Equity Cashmargin_blocked_deliveryNUMBER(15,2)on-tradederived from Ydelivery margin for physical-settled contracts in tender windowNCL/CMPT/61801
LL-segment_equity_cashSegment Equity Cashmargin_var_cmNUMBER(15,2)on-tradederived from YVaR margin in CM segment; upfront 20% acceptable per NSE/INSP/45534SEBI/HO/MRD2/DCAP/CIR/P/2020/127
LL-segment_equity_fnoSegment F&Oseg_fno_activeCHAR(1)on-modify[direct]pre-trade hard-block on F&O orders if N; pre-margin lock appliesSEBI/HO/MRD2/DCAP/CIR/P/2020/127
LL-segment_equity_fnoSegment F&Oposition_qty_fnoNUMBER(10)on-tradederived from Ynet qty per F&O contract; updated tick-by-tick[industry typical]
LL-segment_equity_fnoSegment F&Oposition_mtm_unrealisedNUMBER(15,2)on-tradederived from Yunrealised P&L; tick-by-tick MTM against LTP[industry typical]
LL-segment_equity_fnoSegment F&Omargin_blocked_spanNUMBER(15,2)on-tradederived from YSPAN margin per position; from BOD nsccl.YYYYMMDD.s.spn.gzNCL/CMPT/44391
LL-segment_equity_fnoSegment F&Omargin_blocked_elmNUMBER(15,2)on-tradederived from YELM margin per position; from ael_DDMMYYYY.csvNCL/CMPT/61801
LL-segment_equity_fnoSegment F&Omargin_blocked_exposureNUMBER(15,2)on-tradederived from Yexposure margin per position; combined with SPAN+ELM at pre-tradeNCL/CMPT/61801
LL-segment_equity_fnoSegment F&Omargin_blocked_additionalNUMBER(15,2)on-tradederived from Yadditional/surveillance margin; 5% ASM-for-spoofing if flaggedNSE/SURV/41107
LL-segment_equity_fnoSegment F&Omwpl_breach_flagCHAR(1)on-tradederived from YMarket-Wide Position Limit breach hard-block at pre-tradeNSE/SURV/74008
LL-segment_equity_fnoSegment F&Ospan_scanrange_file_loaded_flagCHAR(1)dailyderived from YBOD parameter reload status; if N pre-trade defaults to stale marginNCL/CMPT/44391
LL-segment_equity_fnoSegment F&Oelm_ratio_loaded_flagCHAR(1)dailyderived from YBOD ELM ratio reload status from ael fileNCL/CMPT/61801
LL-segment_equity_fnoSegment F&Occm_obligationNUMBER(15,2)dailyderived from YConsolidated Crystallised Obligation Margin per MG-12 CnsltdCrstllsdOblgtnMrgNCL/CMPT/56502
LL-segment_equity_fnoSegment F&Ocross_margin_benefitNUMBER(15,2)on-tradederived from Yspread-margin benefit on same/different-expiry offsetting pairsNCL/CMPT/62978
LL-settlement_typeSettlement Typesettle_cycleVARCHAR(2)on-modify[direct]T+0 flag routes to separate settlement-session margin envelopeSEBI/HO/MRD/POD-3/P/CIR/2024/172
LL-trading_preferenceTrading Preferencedefault_productVARCHAR(5)on-modify[direct]default product-tag for MIS/NRML decision in RMS[industry typical]
LL-trading_preferenceTrading Preferencemis_squareoff_timeTIMESTAMPon-tradelookup against RMIS auto square-off cut-off; equity 15:20, CDS 15:30; member RMS policy[industry typical]
MM-risk_appetiteRisk Appetiterms_risk_tierCHAR(1)on-modify[direct]L tier may cap MTF and F&O exposure multiplier[industry typical]
MM-risk_categoryRisk Categoryrms_client_catVARCHAR(2)on-modify[direct]feeds exposure-limit lookup[industry typical]
MM-risk_categoryRisk Categoryrms_client_risk_catVARCHAR(2)on-modify[direct]Conservative/Moderate/Aggressive; caps for MTF and F&O[industry typical]
UU-mcx_client_categoryMCX Client Categorymcx_categoryVARCHAR(2)on-modify[direct]Hedger gets higher position limits than Speculator[industry typical]
UU-nse_ucc_statusNSE UCC Statusnse_statusVARCHAR(2)on-event[direct]non-AP blocks NSE order entry at pre-trade[industry typical]
UU-ucc_client_typeUCC Client Typeclient_typeVARCHAR(2)on-modify[direct]drives institutional vs retail exposure logic[industry typical]
UU-ucc_codeUCC CodeuccVARCHAR(10)one-timeuppercaseprimary key for per-client margin envelope; SEG file uses UCCNCL/CMPT/55381
UU-ucc_codeUCC Codeucc_position_keyVARCHAR(10)on-tradeuppercaseUCC is the key for client-level position aggregation; SEG file primary keyNCL/CMPT/55381
UU-ucc_codeUCC Codepeak_margin_1130NUMBER(15,2)on-tradederived from Y11:30 IST snapshot; preserves margin position for DMF reconciliationSEBI/HO/MRD2/DCAP/CIR/P/2020/127
UU-ucc_codeUCC Codepeak_margin_1230NUMBER(15,2)on-tradederived from Y12:30 IST snapshot; one of four daily peak capturesSEBI/HO/MRD2/DCAP/CIR/P/2020/127
UU-ucc_codeUCC Codepeak_margin_1330NUMBER(15,2)on-tradederived from Y13:30 IST snapshot; one of four daily peak capturesSEBI/HO/MRD2/DCAP/CIR/P/2020/127
UU-ucc_codeUCC Codepeak_margin_1430NUMBER(15,2)on-tradederived from Y14:30 IST snapshot; final peak of day; clearing-corp picks one at random per CCSEBI/HO/MRD2/DCAP/CIR/P/2020/127
UU-ucc_codeUCC Codesurveillance_otr_flagCHAR(1)on-tradederived from YOTR breach cooling-off flag; 15-min order cooling-off next dayNSE/SURV/45016
UU-ucc_codeUCC Codesurveillance_gsm_block_flagCHAR(1)on-tradelookup against RGSM-list scrip flag on the order; stage III/IV imposes 100% marginNSE/SURV/74008
UU-ucc_codeUCC Codesurveillance_asm_margin_upliftNUMBER(5,2)on-tradelookup against RASM stage margin uplift %; applied to scrip-level ordersNSE/SURV/74008
UU-ucc_codeUCC Codeseg_file_allocationNUMBER(15,2)EODderived from YSEG file (SEGCM/SEGTM) client-level allocation; SA01-SA06 reason codes on short-allocationNCL/CMPT/55381
UU-ucc_codeUCC Codemg12_client_marginNUMBER(15,2)EODderived from YMG-12 client-level margin file row; submitted to clearing corpNCL/CMPT/45516
VV-nri_trading_routeNRI Trading Routenri_routeVARCHAR(2)on-modify[direct]PI route hard-blocks intraday/F&O orders at pre-trade[industry typical]
VV-repatriation_statusRepatriation Statusrepat_flagVARCHAR(2)on-modify[direct]drives separate margin envelope (NRE vs NRO funds)[industry typical]
WW-conversion_to_major_doneConversion Donemajority_done_flgCHAR(1)on-event[direct]N past majority freezes order entry at pre-trade[industry typical]
WW-is_minor_accountMinor Account Flagminor_block_flgCHAR(1)on-modifyderived from Yminor flag blocks F&O/intraday at pre-trade pipeline[industry typical]
XX-collateral_type_preferenceCollateral Typecoll_mixVARCHAR(2)on-modify[direct]50% cash-equivalent rule applied at margin computationNCL/CMPT/65498
XX-collateral_type_preferenceCollateral Type Preferencemargin_50pct_cash_checkCHAR(1)on-tradederived from YY/N flag; 50% cash-equivalent rule applied at order entryNCL/CMPT/61800
XX-daily_margin_report_statusDMR Statusdmr_statusVARCHAR(2)EOD[direct]NC triggers next-day pre-trade margin freeze for that clientSEBI/HO/MRD2/DCAP/CIR/P/2020/127
XX-mtf_enabledMTF Enabledmtf_activeCHAR(1)on-modify[direct]MTF-active client routes to CSMFA pledge envelopeNCL/CMPT/63669
XX-mtf_limit_sanctionedMTF Limit Sanctionedmtf_capNUMBER(15,2)on-modify[direct]hard cap on MTF exposure at order entry[industry typical]
XX-total_pledged_valueTotal Pledged Value (post-haircut)pledged_post_haircutNUMBER(15,2)EODderived from Ypost-haircut value feeds available-margin calc; recomputed at EOD parameter reloadNCL/CMPT/65498
XX-total_pledged_valueTotal Pledged Valuemargin_collected_collateralNUMBER(15,2)dailyderived from Ypost-haircut collateral value at BOD parameter reloadNCL/CMPT/65498
YY-account_statusAccount Statusclient_statusVARCHAR(2)on-event[direct]IN/DO/SU/CL blocks all new orders at pre-tradeSEBI framework for automated deactivation Jul 2022

2026-05-14


AI-generated and not legal advice. See the project README for full disclaimer.