MF Engine V2 API (1.0.0)

Download OpenAPI specification:

Auto-generated API documentation for Mutual Fund Engine V2.

Authentication & Authorization

This API uses JWT tokens for authentication. Different endpoints require different user roles:

  • Partner Authentication: Required for partner-specific operations. Partners have restricted access to schemes based on their type:

    • MFD (Multi-channel Financial Distributor): Can only sell non-direct schemes from empanelled AMCs
    • RIA (Registered Investment Adviser): Can only sell direct schemes from all AMCs
  • Investor Authentication: Required for investor operations. NRI investors may have additional restrictions based on AMC policies for their tax status and country of residence.

Scheme Access Restrictions

The scheme endpoints (/scheme and /scheme/{id}) automatically apply the following restrictions based on the authenticated user:

Partner Restrictions

  • MFD Partners: Limited to non-direct schemes from their empanelled AMCs only
  • RIA Partners: Limited to direct schemes from all AMCs
  • Other Partners: Limited to non-direct schemes from all AMCs

NRI Investor Restrictions

  • Investors with NRI tax status may be blocked from certain AMCs based on regulatory restrictions
  • Restrictions are determined by the investor's tax status and country of birth
  • Blocked schemes return 404 Not Found for restricted investors

Query Parameters

  • limit: Maximum number of results (default: 10)
  • page: Page number for pagination (default: 1)
  • name: Case-insensitive search by scheme name

address

Auto-generated stub for POST /address

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
line1
required
string >= 10 characters
line2
string [ 10 .. 120 ] characters
line3
string [ 10 .. 120 ] characters
city
required
string >= 2 characters
state
required
string >= 2 characters
postal_code
required
string >= 3 characters
country
required
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"
type
required
string
Enum: "RESIDENTIAL_OR_BUSINESS" "RESIDENTIAL" "BUSINESS" "REGISTERED_OFFICE" "UNSPECIFIED" "RESIDENT_OR_BUSINESS_FOREIGN" "RESIDENTIAL_FOREIGN" "BUSINESS_FOREIGN" "REGISTERED_OFFICE_FOREIGN" "UNSPECIFIED_FOREIGN"

Responses

Request samples

Content type
application/json
{
  • "line1": "stringstri",
  • "line2": "stringstri",
  • "line3": "stringstri",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "AFG",
  • "type": "RESIDENTIAL_OR_BUSINESS"
}

Auto-generated stub for PATCH /address/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
line1
string >= 10 characters
line2
string [ 10 .. 120 ] characters
line3
string [ 10 .. 120 ] characters
city
string >= 2 characters
state
string >= 2 characters
postal_code
string >= 3 characters
country
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"
type
string
Enum: "RESIDENTIAL_OR_BUSINESS" "RESIDENTIAL" "BUSINESS" "REGISTERED_OFFICE" "UNSPECIFIED" "RESIDENT_OR_BUSINESS_FOREIGN" "RESIDENTIAL_FOREIGN" "BUSINESS_FOREIGN" "REGISTERED_OFFICE_FOREIGN" "UNSPECIFIED_FOREIGN"

Responses

Request samples

Content type
application/json
{
  • "line1": "stringstri",
  • "line2": "stringstri",
  • "line3": "stringstri",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "AFG",
  • "type": "RESIDENTIAL_OR_BUSINESS"
}

artifacts

Auto-generated stub for GET /artifacts

Authorizations:
PARTNER

Responses

augment

Auto-generated stub for GET /augment/routes

Authorizations:
None

Responses

Auto-generated stub for POST /augment/auth/login

Authorizations:
None
Request Body schema: application/json
required
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

aum

Auto-generated stub for POST /aum_report_data

Authorizations:
None

Responses

Auto-generated stub for POST /aum/drilldown

Authorizations:
None

Responses

Auto-generated stub for POST /aum/drilldown_by_category

Authorizations:
None

Responses

Auto-generated stub for POST /aum/drilldown_for_chart

Authorizations:
None

Responses

Auto-generated stub for POST /aum/get_clients

Authorizations:
None

Responses

Auto-generated stub for POST /aum/get_graph_drilldown

Authorizations:
None

Responses

Auto-generated stub for POST /aum/get_transaction_details

Authorizations:
None

Responses

Auto-generated stub for POST /aum/growth

Authorizations:
None

Responses

Auto-generated stub for POST /aum/growth_by_category

Authorizations:
None

Responses

Auto-generated stub for POST /aum/investor_report_data

Authorizations:
None

Responses

Auto-generated stub for POST /aum/overview

Authorizations:
None

Responses

Auto-generated stub for POST /aum/recent_transactions

Authorizations:
None

Responses

auth

Auto-generated stub for POST /user/signup

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
arn
required
string
email
required
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
required
string
partner_type
string
Enum: "MFD" "RIA"
password
required
string
confirm_password
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "arn": "string",
  • "email": "string",
  • "mobile": "string",
  • "partner_type": "MFD",
  • "password": "string",
  • "confirm_password": "string"
}

Auto-generated stub for POST /user/login

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
identifier
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "password": "string"
}

Auto-generated stub for PATCH /user/update_password

Authorizations:
INVESTOR
Request Body schema: application/json
required
old_password
required
string
new_password
required
string

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Auto-generated stub for POST /user/reset_password

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
otp_id
required
string
otp
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "otp_id": "string",
  • "otp": "string",
  • "password": "string"
}

bank_account

Auto-generated stub for POST /bank_account

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
account_holder_name
required
string [ 3 .. 50 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
account_number
required
string^[0-9]{9,18}$
ifsc_code
required
string^[A-Z]{4}0[A-Z0-9]{6}$
bank_type
required
string
Enum: "SAVINGS_BANK" "CURRENT_BANK" "NRE" "NRO"
bank_owner
required
string
Enum: "SELF" "GUARDIAN"
branch_name
string [ 2 .. 50 ] characters
bank_name
string [ 2 .. 50 ] characters
branch_address
string [ 5 .. 500 ] characters
branch_contact_number
string
branch_city
string <= 50 characters
branch_district
string <= 50 characters
branch_state
string <= 50 characters
cancelled_cheque_id
string

Responses

Request samples

Content type
application/json
{
  • "account_holder_name": "string",
  • "account_number": "string",
  • "ifsc_code": "string",
  • "bank_type": "SAVINGS_BANK",
  • "bank_owner": "SELF",
  • "branch_name": "string",
  • "bank_name": "string",
  • "branch_address": "string",
  • "branch_contact_number": "string",
  • "branch_city": "string",
  • "branch_district": "string",
  • "branch_state": "string",
  • "cancelled_cheque_id": "string"
}

Auto-generated stub for PATCH /bank_account/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
account_holder_name
string [ 3 .. 50 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
account_number
string^[0-9]{9,18}$
ifsc_code
string^[A-Z]{4}0[A-Z0-9]{6}$
bank_type
string
Enum: "SAVINGS_BANK" "CURRENT_BANK" "NRE" "NRO"
bank_owner
string
Enum: "SELF" "GUARDIAN"
branch_name
string [ 2 .. 50 ] characters
bank_name
string [ 2 .. 50 ] characters
branch_address
string [ 5 .. 500 ] characters
branch_contact_number
string
branch_city
string <= 50 characters
branch_district
string <= 50 characters
branch_state
string <= 50 characters
cancelled_cheque_id
string

Responses

Request samples

Content type
application/json
{
  • "account_holder_name": "string",
  • "account_number": "string",
  • "ifsc_code": "string",
  • "bank_type": "SAVINGS_BANK",
  • "bank_owner": "SELF",
  • "branch_name": "string",
  • "bank_name": "string",
  • "branch_address": "string",
  • "branch_contact_number": "string",
  • "branch_city": "string",
  • "branch_district": "string",
  • "branch_state": "string",
  • "cancelled_cheque_id": "string"
}

Auto-generated stub for DELETE /bank_account/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /bank_account/payment_options

Authorizations:
INVESTOR

Responses

Auto-generated stub for GET /bank_account/all

Authorizations:
ALL_ROLES

Responses

bucket

Auto-generated stub for POST /bucket

Authorizations:
PARTNER
Request Body schema: application/json
required
title
required
string >= 3 characters
description
required
string >= 5 characters
risk_level
required
string
Enum: "HIGHLY_CONSERVATIVE" "CONSERVATIVE" "MODERATE" "AGGRESSIVE" "HIGHLY_AGGRESSIVE"
investment_mode
required
string
Enum: "SIP" "LUMPSUM"
is_recommended
boolean
rebalance_threshold
number <= 100 characters
schemes
Array of objects
scheme_id
required
string
allocation_perc
required
number [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "risk_level": "HIGHLY_CONSERVATIVE",
  • "investment_mode": "SIP",
  • "is_recommended": true,
  • "rebalance_threshold": 0,
  • "schemes": [
    ],
  • "scheme_id": "string",
  • "allocation_perc": 0
}

Auto-generated stub for GET /bucket

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for PATCH /bucket

Authorizations:
PARTNER
Request Body schema: application/json
required
bank_account_id
string
payment_mode
string
Enum: "UPI" "MANDATE" "NETBANKING"
upi
string^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+$
mandate_id
string

Responses

Request samples

Content type
application/json
{
  • "bank_account_id": "string",
  • "payment_mode": "UPI",
  • "upi": "string",
  • "mandate_id": "string"
}

Auto-generated stub for DELETE /bucket/{id}

Authorizations:
PARTNER
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /bucket/{id}/purchase

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
amount
required
number
ninstallments
number
start_date
string

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "ninstallments": 0,
  • "start_date": "string"
}

Auto-generated stub for GET /bucket/{id}/performance

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /bucket/{id}/investor-performance

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /bucket/{id}/rebalance/check

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /bucket/rebalance/stats

Authorizations:
PARTNER
query Parameters
page
number
limit
number
search
string
status
string
refresh
boolean

Responses

Auto-generated stub for POST /bucket/{id}/rebalance/exec

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
bank_account_id
string
payment_mode
string
Enum: "UPI" "MANDATE" "NETBANKING"
upi
string^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+$
mandate_id
string

Responses

Request samples

Content type
application/json
{
  • "bank_account_id": "string",
  • "payment_mode": "UPI",
  • "upi": "string",
  • "mandate_id": "string"
}

cart

Auto-generated stub for GET /cart

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /cart

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
type
required
string
Enum: "ORDER" "SXP"
amount
required
number
scheme_id
required
string
dest_scheme_id
string
order_type
string
Enum: "PURCHASE" "REDEMPTION" "SWITCH"
folio
string
is_units
boolean
freq
string
Enum: "MONTHLY" "WEEKLY" "DAILY" "FORTNIGHTLY" "QUARTERLY" "HALF_YEARLY" "YEARLY"
end_date
string
sxp_type
string
Enum: "SIP" "SWP" "STP" "TOPUP" "SPROD"
ninstallments
number
start_date
string
first_order_today
boolean
bucket_id
string
bucket_version
number
target_percentage
number

Responses

Request samples

Content type
application/json
{
  • "type": "ORDER",
  • "amount": 0,
  • "scheme_id": "string",
  • "dest_scheme_id": "string",
  • "order_type": "PURCHASE",
  • "folio": "string",
  • "is_units": true,
  • "freq": "MONTHLY",
  • "end_date": "string",
  • "sxp_type": "SIP",
  • "ninstallments": 0,
  • "start_date": "string",
  • "first_order_today": true,
  • "bucket_id": "string",
  • "bucket_version": 0,
  • "target_percentage": 0
}

Auto-generated stub for POST /cart/delete

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
cart_ids
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "cart_ids": [
    ]
}

Auto-generated stub for GET /cart/{investorId}/approval_link

Authorizations:
PARTNER
path Parameters
investorId
required
integer

Responses

Auto-generated stub for PATCH /cart/bucket/{bucketId}

Authorizations:
ALL_ROLESALL_ROLES
path Parameters
bucketId
required
integer
bucketId
required
integer
Request Body schema: application/json
required
total_amount
required
number
start_date
string
ninstallments
number
freq
string
Enum: "MONTHLY" "WEEKLY" "DAILY" "FORTNIGHTLY" "QUARTERLY" "HALF_YEARLY" "YEARLY"
end_date
string
first_order_today
boolean

Responses

Request samples

Content type
application/json
{
  • "total_amount": 0,
  • "start_date": "string",
  • "ninstallments": 0,
  • "freq": "MONTHLY",
  • "end_date": "string",
  • "first_order_today": true
}

Auto-generated stub for DELETE /cart/bucket/{bucketId}

Authorizations:
ALL_ROLES
path Parameters
bucketId
required
integer

Responses

Auto-generated stub for PATCH /cart/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
type
required
string
Enum: "ORDER" "SXP"
amount
required
number
scheme_id
required
string
dest_scheme_id
string
order_type
string
Enum: "PURCHASE" "REDEMPTION" "SWITCH"
folio
string
is_units
boolean
freq
string
Enum: "MONTHLY" "WEEKLY" "DAILY" "FORTNIGHTLY" "QUARTERLY" "HALF_YEARLY" "YEARLY"
end_date
string
sxp_type
string
Enum: "SIP" "SWP" "STP" "TOPUP" "SPROD"
ninstallments
number
start_date
string
first_order_today
boolean
bucket_id
string
bucket_version
number
target_percentage
number

Responses

Request samples

Content type
application/json
{
  • "type": "ORDER",
  • "amount": 0,
  • "scheme_id": "string",
  • "dest_scheme_id": "string",
  • "order_type": "PURCHASE",
  • "folio": "string",
  • "is_units": true,
  • "freq": "MONTHLY",
  • "end_date": "string",
  • "sxp_type": "SIP",
  • "ninstallments": 0,
  • "start_date": "string",
  • "first_order_today": true,
  • "bucket_id": "string",
  • "bucket_version": 0,
  • "target_percentage": 0
}

Auto-generated stub for DELETE /cart/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /cart/order

Authorizations:
INVESTOR
Request Body schema: application/json
required
otp_id
required
string
otp
required
string
bank_account_id
string
payment_mode
string
Enum: "UPI" "MANDATE" "NETBANKING"
upi
string^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+$
mandate_id
string

Responses

Request samples

Content type
application/json
{
  • "otp_id": "string",
  • "otp": "string",
  • "bank_account_id": "string",
  • "payment_mode": "UPI",
  • "upi": "string",
  • "mandate_id": "string"
}

Auto-generated stub for POST /cart/payment-test

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /cart/augmont-test

Authorizations:
None
Request Body schema: application/json
required
url
required
string
method
string
payload
string
query
string
headers
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "method": "string",
  • "payload": "string",
  • "query": "string",
  • "headers": "string"
}

cas

Auto-generated stub for POST /cas

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Auto-generated stub for POST /cas/import

Authorizations:
ALL_ROLESALL_ROLES
Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Auto-generated stub for POST /cas/import_nsdl

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Auto-generated stub for GET /cas/recent-parses

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /cas/new-cas

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
pan
required
string^[A-Z]{5}[0-9]{4}[A-Z]{1}$
email
string
mobile
string
fromDate
required
string^\d{4}-\d{2}-\d{2}$|^\d{2}-\d{2}-\d{4}$|^\d{2...
toDate
required
string^\d{4}-\d{2}-\d{2}$|^\d{2}-\d{2}-\d{4}$|^\d{2...

Responses

Request samples

Content type
application/json
{
  • "pan": "string",
  • "email": "string",
  • "mobile": "string",
  • "fromDate": "string",
  • "toDate": "string"
}

Auto-generated stub for POST /cas/validate-qr

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
reqId
required
string
clientRefNo
required
string
qrCode
required
string

Responses

Request samples

Content type
application/json
{
  • "reqId": "string",
  • "clientRefNo": "string",
  • "qrCode": "string"
}

Auto-generated stub for POST /cas/analyze-cas-json

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /cas/recent-cas-parses

Authorizations:
ALL_ROLES

Responses

communication_test

Auto-generated stub for POST /communication_test

Authorizations:
PARTNER
Request Body schema: application/json
required
mode
string
partner_id
string
target_phone
string
target_email
string
template_type
string
override_template_id
string
sample_vars
string

Responses

Request samples

Content type
application/json
{
  • "mode": "string",
  • "partner_id": "string",
  • "target_phone": "string",
  • "target_email": "string",
  • "template_type": "string",
  • "override_template_id": "string",
  • "sample_vars": "string"
}

distributor

Auto-generated stub for GET /distributor

Authorizations:
ALL_ROLES
query Parameters
page
string
limit
string
search
string

Responses

Auto-generated stub for GET /distributor/search

Authorizations:
ALL_ROLES
query Parameters
page
string
limit
string
arn
string
arn_holder_name
string
city
string
pin
string
email
string
euin
string

Responses

Auto-generated stub for GET /distributor/{arn}

Authorizations:
ALL_ROLES
path Parameters
arn
required
integer
query Parameters
fetchIfNotFound
string

Responses

email_address

Auto-generated stub for POST /email_address

Authorizations:
INVESTOR
Request Body schema: application/json
required
email
required
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
belongs_to
required
string
Enum: "SELF" "SPOUSE" "DEPENDENT_CHILDREN" "DEPENDENT_SIBLINGS" "DEPENDENT_PARENTS" "GUARDIAN" "PMS" "CUSTODIAN" "POA" "NOT_APPLICABLE"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "belongs_to": "SELF"
}

Auto-generated stub for PATCH /email_address/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer
Request Body schema: application/json
required
email
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
belongs_to
string
Enum: "SELF" "SPOUSE" "DEPENDENT_CHILDREN" "DEPENDENT_SIBLINGS" "DEPENDENT_PARENTS" "GUARDIAN" "PMS" "CUSTODIAN" "POA" "NOT_APPLICABLE"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "belongs_to": "SELF"
}

fd_master

Auto-generated stub for GET /fd_master/address-types

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/districts

Authorizations:
ALL_ROLES
query Parameters
state
string

Responses

Auto-generated stub for GET /fd_master/genders

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/image-types

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/marital-statuses

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/occupations

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/relationships

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/salutations

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/states

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_master/tax-statuses

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /fd_master/bulk_upsert

Authorizations:
None
Request Body schema: application/json
required
items
Array of objects
provider
string
Value: "SHRIRAM"
master_type
required
string
Enum: "SALUTATION" "GENDER" "STATE" "RELATIONSHIP" "IMAGE_TYPE" "OCCUPATION" "MARITAL_STATUS" "ADDRESS_TYPE" "DISTRICT" "TAX_STATUS"
label
required
string
value
required
string
provider_code
string
metadata
string
sort_order
number
is_active
boolean non-empty

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "provider": "SHRIRAM",
  • "master_type": "SALUTATION",
  • "label": "string",
  • "value": "string",
  • "provider_code": "string",
  • "metadata": "string",
  • "sort_order": 0,
  • "is_active": true
}

fd_order

Auto-generated stub for GET /fd_order/approval

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /fd_order/approval/payment-url

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
order_id
required
string
device
string

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "device": "string"
}

Auto-generated stub for POST /fd_order/approval/check-status

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
order_id
required
string

Responses

Request samples

Content type
application/json
{
  • "order_id": "string"
}

Auto-generated stub for GET /fd_order/self

Authorizations:
INVESTOR

Responses

Auto-generated stub for POST /fd_order/self/initiate

Authorizations:
INVESTOR
Request Body schema: application/json
required
fd_scheme_id
required
string
amount
required
number

Responses

Request samples

Content type
application/json
{
  • "fd_scheme_id": "string",
  • "amount": 0
}

Auto-generated stub for GET /fd_order/self/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /fd_order/self/{id}/payment-url

Authorizations:
INVESTOR
path Parameters
id
required
integer
Request Body schema: application/json
required
device
string

Responses

Request samples

Content type
application/json
{
  • "device": "string"
}

Auto-generated stub for POST /fd_order/self/{id}/check-status

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /fd_order/initiate

Authorizations:
None
Request Body schema: application/json
required
investor_id
required
string
fd_scheme_id
required
string
amount
required
number

Responses

Request samples

Content type
application/json
{
  • "investor_id": "string",
  • "fd_scheme_id": "string",
  • "amount": 0
}

Auto-generated stub for POST /fd_order/shriram-proxy

Authorizations:
None
Request Body schema: application/json
required
url
required
string
method
string
payload
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "method": "string",
  • "payload": "string"
}

Auto-generated stub for GET /fd_order

Authorizations:
ALL_ROLES
query Parameters
investor_id
required
string

Responses

Auto-generated stub for POST /fd_order/{id}/send-link

Authorizations:
None
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /fd_order/{id}/check-status

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /fd_order/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

fd_profile

Auto-generated stub for GET /fd_profile/approval

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for PATCH /fd_profile/approval

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/approval/ekyc/get-otp

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/approval/ekyc/verify-otp

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
otp
required
string
txnTime
required
string
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "otp": "string",
  • "txnTime": "string",
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/approval/digilocker/link

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
pan
string
redirectUrl
string
guid
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "pan": "string",
  • "redirectUrl": "string",
  • "guid": "string",
  • "consent": "string"
}

Auto-generated stub for POST /fd_profile/approval/digilocker/documents

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
accessRequestId
required
string
pan
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "accessRequestId": "string",
  • "pan": "string",
  • "consent": "string"
}

Auto-generated stub for GET /fd_profile/self

Authorizations:
INVESTOR

Responses

Auto-generated stub for PATCH /fd_profile/self

Authorizations:
INVESTOR
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/self/ekyc/get-otp

Authorizations:
INVESTOR
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/self/ekyc/verify-otp

Authorizations:
INVESTOR
Request Body schema: application/json
required
otp
required
string
txnTime
required
string
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "otp": "string",
  • "txnTime": "string",
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/self/digilocker/link

Authorizations:
INVESTOR
Request Body schema: application/json
required
pan
string
redirectUrl
string
guid
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "pan": "string",
  • "redirectUrl": "string",
  • "guid": "string",
  • "consent": "string"
}

Auto-generated stub for POST /fd_profile/self/digilocker/documents

Authorizations:
INVESTOR
Request Body schema: application/json
required
accessRequestId
required
string
pan
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "accessRequestId": "string",
  • "pan": "string",
  • "consent": "string"
}

Auto-generated stub for POST /fd_profile/{investorId}/send-link

Authorizations:
None
path Parameters
investorId
required
integer

Responses

Auto-generated stub for GET /fd_profile/{investorId}

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer

Responses

Auto-generated stub for PATCH /fd_profile/{investorId}

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/{investorId}/ekyc/get-otp

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer
Request Body schema: application/json
required
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/{investorId}/ekyc/verify-otp

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer
Request Body schema: application/json
required
otp
required
string
txnTime
required
string
aadharOrVid
required
string
isAadhar
required
boolean
pan
string
refNo
string
applnSource
string

Responses

Request samples

Content type
application/json
{
  • "otp": "string",
  • "txnTime": "string",
  • "aadharOrVid": "string",
  • "isAadhar": true,
  • "pan": "string",
  • "refNo": "string",
  • "applnSource": "string"
}

Auto-generated stub for POST /fd_profile/{investorId}/digilocker/link

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer
Request Body schema: application/json
required
pan
string
redirectUrl
string
guid
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "pan": "string",
  • "redirectUrl": "string",
  • "guid": "string",
  • "consent": "string"
}

Auto-generated stub for POST /fd_profile/{investorId}/digilocker/documents

Authorizations:
ALL_ROLES
path Parameters
investorId
required
integer
Request Body schema: application/json
required
accessRequestId
required
string
pan
string
consent
string

Responses

Request samples

Content type
application/json
{
  • "accessRequestId": "string",
  • "pan": "string",
  • "consent": "string"
}

fd_scheme

Auto-generated stub for GET /fd_scheme

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /fd_scheme/active

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /fd_scheme/bulk_upsert

Authorizations:
None
Request Body schema: application/json
required
items
Array of objects
provider
string
Value: "SHRIRAM"
scheme_code
required
string
provider_scheme_code
string
provider_name
string
category
required
string
tenure_months
required
number non-empty
scheme_type
required
string
interest_frequency
required
string
interest_rate
required
number
min_amount
required
number >= 0 characters
max_amount
required
number >= 0 characters
delta
number
is_active
boolean
raw_payload
string non-empty

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "provider": "SHRIRAM",
  • "scheme_code": "string",
  • "provider_scheme_code": "string",
  • "provider_name": "string",
  • "category": "string",
  • "tenure_months": 0,
  • "scheme_type": "string",
  • "interest_frequency": "string",
  • "interest_rate": 0,
  • "min_amount": 0,
  • "max_amount": 0,
  • "delta": 0,
  • "is_active": true,
  • "raw_payload": "string"
}

fd_webhook

Auto-generated stub for POST /fd_webhook/shriram

Authorizations:
ALL_ROLES

Responses

file

Auto-generated stub for POST /file

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
purpose
required
string
Enum: "INVESTOR_AOF" "INVESTOR_SIGN" "PARTNER_BANNER" "PARTNER_LOGO" "CANCELLED_CHEQUE" "CAS_IMPORT_PDF" "NSDL_IMPORT_PDF" "CDSL_IMPORT_PDF" "FD_IDENTITY_PROOF" "FD_ADDRESS_PROOF" "FD_ADDRESS_PROOF_BACK" "FD_BANK_PROOF" "FD_PHOTO"

Responses

Request samples

Content type
application/json
{
  • "purpose": "INVESTOR_AOF"
}

Auto-generated stub for POST /file/base64

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
base64
required
string
purpose
required
string
Enum: "INVESTOR_AOF" "INVESTOR_SIGN" "PARTNER_BANNER" "PARTNER_LOGO" "CANCELLED_CHEQUE" "CAS_IMPORT_PDF" "NSDL_IMPORT_PDF" "CDSL_IMPORT_PDF" "FD_IDENTITY_PROOF" "FD_ADDRESS_PROOF" "FD_ADDRESS_PROOF_BACK" "FD_BANK_PROOF" "FD_PHOTO"
mimetype
required
string
filename
required
string

Responses

Request samples

Content type
application/json
{
  • "base64": "string",
  • "purpose": "INVESTOR_AOF",
  • "mimetype": "string",
  • "filename": "string"
}

holder

Auto-generated stub for POST /holder

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
first_name
required
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
middle_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
required
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
holder_rank
required
string
Enum: "FIRST" "SECOND" "THIRD" "GUARDIAN"
gender
required
string
Enum: "MALE" "FEMALE" "OTHER"
date_of_birth
required
string
place_of_birth
required
string [ 2 .. 50 ] characters
country_of_birth
required
string [ 2 .. 50 ] characters
occupation
required
string
Enum: "BUSINESS" "SERVICE" "PROFESSIONAL" "AGRICULTURIST" "RETIRED" "HOUSEWIFE" "STUDENT" "OTHERS" "DOCTOR" "PRIVATE_SECTOR_SERVICE" "PUBLIC_SECTOR_SERVICE" "FOREX_DEALER" "GOVERNMENT_SERVICE" "UNKNOWN_OR_NOT_APPLICABLE"
source_of_wealth
required
string
Enum: "SALARY" "BUSINESS" "GIFT" "ANCESTRAL_PROPERTY" "RENTAL_INCOME" "PRIZE_MONEY" "ROYALTY" "OTHERS"
income_slab
required
string
Enum: "BELOW_1_LAKH" "FROM_1_TO_5_LAKHS" "FROM_5_TO_10_LAKHS" "FROM_10_TO_25_LAKHS" "FROM_25_LAKHS_TO_1_CRORE" "ABOVE_1_CRORE"
pep_details
required
string
Enum: "YES" "NO" "RELATIVE"
email
required
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
required
string^[6-9]\d{9}$

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "holder_rank": "FIRST",
  • "gender": "MALE",
  • "date_of_birth": "string",
  • "place_of_birth": "string",
  • "country_of_birth": "string",
  • "occupation": "BUSINESS",
  • "source_of_wealth": "SALARY",
  • "income_slab": "BELOW_1_LAKH",
  • "pep_details": "YES",
  • "email": "string",
  • "mobile": "string"
}

Auto-generated stub for PATCH /holder/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
first_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
middle_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
holder_rank
string
Enum: "FIRST" "SECOND" "THIRD" "GUARDIAN"
gender
string
Enum: "MALE" "FEMALE" "OTHER"
date_of_birth
string
place_of_birth
string [ 2 .. 50 ] characters
country_of_birth
string [ 2 .. 50 ] characters
occupation
string
Enum: "BUSINESS" "SERVICE" "PROFESSIONAL" "AGRICULTURIST" "RETIRED" "HOUSEWIFE" "STUDENT" "OTHERS" "DOCTOR" "PRIVATE_SECTOR_SERVICE" "PUBLIC_SECTOR_SERVICE" "FOREX_DEALER" "GOVERNMENT_SERVICE" "UNKNOWN_OR_NOT_APPLICABLE"
source_of_wealth
string
Enum: "SALARY" "BUSINESS" "GIFT" "ANCESTRAL_PROPERTY" "RENTAL_INCOME" "PRIZE_MONEY" "ROYALTY" "OTHERS"
income_slab
string
Enum: "BELOW_1_LAKH" "FROM_1_TO_5_LAKHS" "FROM_5_TO_10_LAKHS" "FROM_10_TO_25_LAKHS" "FROM_25_LAKHS_TO_1_CRORE" "ABOVE_1_CRORE"
pep_details
string
Enum: "YES" "NO" "RELATIVE"
email
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
string^[6-9]\d{9}$

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "holder_rank": "FIRST",
  • "gender": "MALE",
  • "date_of_birth": "string",
  • "place_of_birth": "string",
  • "country_of_birth": "string",
  • "occupation": "BUSINESS",
  • "source_of_wealth": "SALARY",
  • "income_slab": "BELOW_1_LAKH",
  • "pep_details": "YES",
  • "email": "string",
  • "mobile": "string"
}

identifier

Auto-generated stub for POST /identifier

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
issue_date
string
expiry_date
string
investor_id
string
holder_id
string
related_party_id
string

Responses

Request samples

Content type
application/json
{
  • "issue_date": "string",
  • "expiry_date": "string",
  • "investor_id": "string",
  • "holder_id": "string",
  • "related_party_id": "string"
}

Auto-generated stub for PATCH /identifier/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
issue_date
string
expiry_date
string
investor_id
string
holder_id
string
related_party_id
string

Responses

Request samples

Content type
application/json
{
  • "issue_date": "string",
  • "expiry_date": "string",
  • "investor_id": "string",
  • "holder_id": "string",
  • "related_party_id": "string"
}

investor

Auto-generated stub for GET /investor

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for PATCH /investor

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
first_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
middle_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
date_of_birth
string
gender
string
Enum: "MALE" "FEMALE" "OTHER"
occupation
string
Enum: "BUSINESS" "SERVICE" "PROFESSIONAL" "AGRICULTURIST" "RETIRED" "HOUSEWIFE" "STUDENT" "OTHERS" "DOCTOR" "PRIVATE_SECTOR_SERVICE" "PUBLIC_SECTOR_SERVICE" "FOREX_DEALER" "GOVERNMENT_SERVICE" "UNKNOWN_OR_NOT_APPLICABLE"
income_slab
string
Enum: "BELOW_1_LAKH" "FROM_1_TO_5_LAKHS" "FROM_5_TO_10_LAKHS" "FROM_10_TO_25_LAKHS" "FROM_25_LAKHS_TO_1_CRORE" "ABOVE_1_CRORE"
source_of_wealth
string
Enum: "SALARY" "BUSINESS" "GIFT" "ANCESTRAL_PROPERTY" "RENTAL_INCOME" "PRIZE_MONEY" "ROYALTY" "OTHERS"
pep_details
string
Enum: "YES" "NO" "RELATIVE"
country_of_birth
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"
tax_status
string
Enum: "INDIVIDUAL" "ON_BEHALF_OF_MINOR" "HUF" "COMPANY" "AOP" "PARTNERSHIP_FIRM" "BODY_CORPORATE" "TRUST" "SOCIETY" "OTHERS" "NRI_OTHERS" "DFI" "SOLE_PROPRIETORSHIP" "NRE" "OCB" "FII" "NRO" "OVERSEAS_CORP_BODY_OTHERS" "NRI_CHILD" "NRI_HUF_NRO" "NRI_MINOR_NRO" "NRI_HUF_NRE" "PROVIDENT_FUND" "SUPER_ANNUATION_FUND" "GRATUITY_FUND" "PENSION_FUND" "MUTUAL_FUNDS_FOF_SCHEMES" "NPS_TRUST" "GLOBAL_DEVELOPMENT_NETWORK" "FCRA" "QFI_INDIVIDUAL" "QFI_MINORS" "QFI_CORPORATE" "QFI_PENSION_FUNDS" "QFI_HEDGE_FUNDS" "QFI_MUTUAL_FUNDS" "LLP" "NON_PROFIT_ORGANIZATION_NPO" "PUBLIC_LIMITED_COMPANY" "PRIVATE_LIMITED_COMPANY" "UNLISTED_COMPANY" "MUTUAL_FUNDS" "FPI_CATEGORY_I" "FPI_CATEGORY_II" "FPI_CATEGORY_III" "FINANCIAL_INSTITUTIONS" "BODY_OF_INDIVIDUALS" "INSURANCE_COMPANY" "OCI_REPATRIATION" "OCI_NON_REPATRIATION" "PERSON_OF_INDIAN_ORIGIN" "GOVERNMENT_BODY" "DEFENSE_ESTABLISHMENT" "NON_GOVERNMENT_ORGANISATION" "BANK_COOPERATIVE_BANK" "ARTIFICIAL_JURIDICAL_PERSON" "SEAFARER_NRE" "SEAFARER_NRO"
place_of_birth
string
pan
string^[A-Z]{3}P[A-Z][0-9]{4}[A-Z]$
signature_id
string
tin_no
string
tin_country
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "date_of_birth": "string",
  • "gender": "MALE",
  • "occupation": "BUSINESS",
  • "income_slab": "BELOW_1_LAKH",
  • "source_of_wealth": "SALARY",
  • "pep_details": "YES",
  • "country_of_birth": "AFG",
  • "tax_status": "INDIVIDUAL",
  • "place_of_birth": "string",
  • "pan": "string",
  • "signature_id": "string",
  • "tin_no": "string",
  • "tin_country": "AFG"
}

Auto-generated stub for GET /investor/list

Authorizations:
None

Responses

Auto-generated stub for POST /investor/prospect

Authorizations:
PARTNER
Request Body schema: application/json
required
first_name
required
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
required
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
phone
required
string^[6-9]\d{9}$

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "phone": "string"
}

Auto-generated stub for POST /investor/create_physical_ucc

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /investor/upload_aof

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /investor/bse_details

Authorizations:
ALL_ROLES
query Parameters
investor_id
string
holding_nature
string
Enum: "SINGLE" "JOINT" "ANYONE_OR_SURVIVOR"

Responses

Auto-generated stub for GET /investor/kyc_link

Authorizations:
ALL_ROLES
query Parameters
investor_id
string
holding_nature
string
Enum: "SINGLE" "JOINT" "ANYONE_OR_SURVIVOR"

Responses

Auto-generated stub for POST /investor/update_ucc

Authorizations:
INVESTOR
Request Body schema: application/json
required
otp_id
required
string
otp
required
string

Responses

Request samples

Content type
application/json
{
  • "otp_id": "string",
  • "otp": "string"
}

Auto-generated stub for GET /investor/{id}/related_party/approval_link

Authorizations:
PARTNER
path Parameters
id
required
integer

Responses

Auto-generated stub for DELETE /investor/clear

Authorizations:
PARTNER
Request Body schema: application/json
required
phone_number
string
email
string
investor_id
string
pan
string

Responses

Request samples

Content type
application/json
{
  • "phone_number": "string",
  • "email": "string",
  • "investor_id": "string",
  • "pan": "string"
}

ipo

Auto-generated stub for GET /ipo

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/board

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/gmp

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/reviews

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/allotment

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/stats

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ipo/by-slug/{slug}

Authorizations:
ALL_ROLES
path Parameters
slug
required
integer

Responses

Auto-generated stub for GET /ipo/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

job

Auto-generated stub for POST /job/enqueue

Authorizations:
None

Responses

mandate

Auto-generated stub for GET /mandate

Authorizations:
ALL_ROLES
query Parameters
limit
number
page
number
investor_id
string

Responses

Auto-generated stub for POST /mandate

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
amount
required
number
bank_account_id
required
string
type
required
string
Enum: "ENACH" "NACH" "UPI"
upi_id
string^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+$
Enum: "INITIATED" "ACTIVE" "REJECTED" "CANCELLED" "COMPLETED" "INVESTOR_AUTH_AWAITED" "IN_PROCESS_AGENCY" "AUTO_REJECTED" "PRE_DEBIT_NOTIFICATION_SENT_SUCCESSFULLY" "SCAN_UPLOAD_PENDING"

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "bank_account_id": "string",
  • "type": "ENACH",
  • "upi_id": "INITIATED"
}

Auto-generated stub for GET /mandate/{id}/bse_details

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /mandate/{id}/approval_link

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

mf_query

Auto-generated stub for POST /mf_query/screen

Authorizations:
PARTNER
Request Body schema: application/json
required
query
required
string <= 500 characters
options
string
limit
number [ 1 .. 50 ] characters
explanation_style
string
include_sql_preview
boolean

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "options": "string",
  • "limit": 0,
  • "explanation_style": "string",
  • "include_sql_preview": true
}

nav

Auto-generated stub for GET /nav/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

order

Auto-generated stub for GET /order

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /order/{id}/bse_details

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /order/{id}/cancel

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

otp_verification

Auto-generated stub for POST /otp/signup

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
identifier
required
string^[6-9]\d{9}$
type
required
string
Enum: "MOBILE" "EMAIL" "BOTH"
partner_id
required
string

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "type": "MOBILE",
  • "partner_id": "string"
}

Auto-generated stub for POST /otp/transaction

Authorizations:
INVESTOR
Request Body schema: application/json
required
cart_ids
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "cart_ids": [
    ]
}

Auto-generated stub for POST /otp/update_ucc

Authorizations:
INVESTOR
Request Body schema: application/json
required
type
required
string
Enum: "SIGN_UP" "FORGOT_PASSWORD" "TRANSACTION" "CANCEL_SXP" "UPDATE_ADDRESS" "ADD_BANK_ACCOUNT" "DELETE_BANK_ACCOUNT" "UPDATE_BANK_ACCOUNT" "UPDATE_PERSONAL_INFO" "ADD_NOMINEE" "UPDATE_NOMINEE" "DELETE_NOMINEE"
payload
string
id
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "SIGN_UP",
  • "payload": "string",
  • "id": "string"
}

Auto-generated stub for POST /otp/cancel_sxp

Authorizations:
INVESTOR
Request Body schema: application/json
required
sxp_id
required
string
reason
required
string
Enum: "NON_AVAILABILITY_OF_FUNDS" "SCHEME_NOT_PERFORMING" "SERVICE_ISSUE" "LOAD_REVISED" "WISH_TO_INVEST_IN_OTHER_SCHEMES" "CHANGE_IN_FUND_MANAGER" "GOAL_ACHIEVED" "NOT_COMFORTABLE_WITH_MARKET_VOLATILITY" "WILL_BE_RESTARTING_SIP_AFTER_FEW_MONTHS" "MODIFICATIONS_IN_BANK_MANDATE_DATE_ETC" "I_HAVE_DECIDED_TO_INVEST_ELSEWHERE" "THIS_IS_NOT_THE_RIGHT_TIME_TO_INVEST" "OTHERS"
reason_msg
string

Responses

Request samples

Content type
application/json
{
  • "sxp_id": "string",
  • "reason": "NON_AVAILABILITY_OF_FUNDS",
  • "reason_msg": "string"
}

Auto-generated stub for POST /otp/reset_password

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
identifier
required
string^[6-9]\d{9}$
type
required
string
Enum: "MOBILE" "EMAIL" "BOTH"

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "type": "MOBILE"
}

partner_amc

Auto-generated stub for GET /partner_amc/supported

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /partner_amc

Authorizations:
None
Request Body schema: application/json
required
object (createPartnerAmcSchema)

Responses

Request samples

Content type
application/json
{ }

Auto-generated stub for GET /partner_amc

Authorizations:
None

Responses

Auto-generated stub for GET /partner_amc/{id}

Authorizations:
None
path Parameters
id
required
integer

Responses

Auto-generated stub for PATCH /partner_amc/{id}

Authorizations:
None
path Parameters
id
required
integer
Request Body schema: application/json
required
object (patchPartnerAmcSchema)

Responses

Request samples

Content type
application/json
{ }

Auto-generated stub for DELETE /partner_amc/{id}

Authorizations:
None
path Parameters
id
required
integer

Responses

partner_whitelabeling

Auto-generated stub for GET /partner_whitelabeling/{referral_link}

Authorizations:
ALL_ROLES
path Parameters
referral_link
required
integer

Responses

partner

Auto-generated stub for POST /partner/signup

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
arn
required
string
email
required
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
required
string
partner_type
string
Enum: "MFD" "RIA"
password
required
string
confirm_password
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "arn": "string",
  • "email": "string",
  • "mobile": "string",
  • "partner_type": "MFD",
  • "password": "string",
  • "confirm_password": "string"
}

Auto-generated stub for POST /partner/login

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
identifier
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "password": "string"
}

Auto-generated stub for GET /partner/list

Authorizations:
None

Responses

Auto-generated stub for GET /partner

Authorizations:
PARTNER

Responses

Auto-generated stub for PATCH /partner

Authorizations:
PARTNER
Request Body schema: application/json
required
name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
email
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
referral_link
string
mobile
string^[6-9]\d{9}$
pan
string^[A-Z]{3}P[A-Z][0-9]{4}[A-Z]$
gst
string
dob
string
gender
string
Enum: "MALE" "FEMALE" "OTHER"
occupation
string
Enum: "BUSINESS" "SERVICE" "PROFESSIONAL" "AGRICULTURIST" "RETIRED" "HOUSEWIFE" "STUDENT" "OTHERS" "DOCTOR" "PRIVATE_SECTOR_SERVICE" "PUBLIC_SECTOR_SERVICE" "FOREX_DEALER" "GOVERNMENT_SERVICE" "UNKNOWN_OR_NOT_APPLICABLE"
payment_redirection_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "referral_link": "string",
  • "mobile": "string",
  • "pan": "string",
  • "gst": "string",
  • "dob": "string",
  • "gender": "MALE",
  • "occupation": "BUSINESS",
  • "payment_redirection_url": "string"
}

Auto-generated stub for GET /partner/{id}

Authorizations:
None
path Parameters
id
required
integer

Responses

Auto-generated stub for PATCH /partner/communication-config

Authorizations:
PARTNER
Request Body schema: application/json
required
company_name
string
sms_provider
string
sms_gateway_config
string
sms_template_ids
string
email_provider
string
email_sender_address
string
email_sender_name
string
email_config
string

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "sms_provider": "string",
  • "sms_gateway_config": "string",
  • "sms_template_ids": "string",
  • "email_provider": "string",
  • "email_sender_address": "string",
  • "email_sender_name": "string",
  • "email_config": "string"
}

past_order

Auto-generated stub for GET /past_order

Authorizations:
None

Responses

payment

Auto-generated stub for GET /payment/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

phone_number

Auto-generated stub for POST /phone_number

Authorizations:
INVESTOR
Request Body schema: application/json
required
isd
string
number
required
string^[6-9]\d{9}$
belongs_to
required
string
Enum: "SELF" "SPOUSE" "DEPENDENT_CHILDREN" "DEPENDENT_SIBLINGS" "DEPENDENT_PARENTS" "GUARDIAN" "PMS" "CUSTODIAN" "POA" "NOT_APPLICABLE"
type
required
string
Enum: "RESIDENTIAL" "OFFICE" "PRIMARY" "OTHER"

Responses

Request samples

Content type
application/json
{
  • "isd": "string",
  • "number": "string",
  • "belongs_to": "SELF",
  • "type": "RESIDENTIAL"
}

Auto-generated stub for GET /phone_number/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer
Request Body schema: application/json
required
isd
string
number
string^[6-9]\d{9}$
belongs_to
string
Enum: "SELF" "SPOUSE" "DEPENDENT_CHILDREN" "DEPENDENT_SIBLINGS" "DEPENDENT_PARENTS" "GUARDIAN" "PMS" "CUSTODIAN" "POA" "NOT_APPLICABLE"
type
string
Enum: "RESIDENTIAL" "OFFICE" "PRIMARY" "OTHER"

Responses

Request samples

Content type
application/json
{
  • "isd": "string",
  • "number": "string",
  • "belongs_to": "SELF",
  • "type": "RESIDENTIAL"
}

portfolio

Auto-generated stub for GET /portfolio

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /portfolio/partner

Authorizations:
PARTNER

Responses

Auto-generated stub for GET /portfolio/holdings

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /portfolio/analytics/import-orders

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /portfolio/scheme

Authorizations:
INVESTOR

Responses

Auto-generated stub for GET /portfolio/scheme/{id}

Authorizations:
INVESTOR
path Parameters
id
required
integer

Responses

related_party

Auto-generated stub for POST /related_party

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
first_name
required
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
middle_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
string^[A-Za-z]+(?:\s[A-Za-z]+)*$
date_of_birth
required
string
relationship
string
Enum: "AUNT" "BROTHER" "DAUGHTER" "DAUGHTER_IN_LAW" "FATHER" "FATHER_IN_LAW" "GRAND_DAUGHTER" "GRAND_SON" "GRAND_FATHER" "GRAND_MOTHER" "HUSBAND" "MOTHER" "MOTHER_IN_LAW" "NEPHEW" "NIECE" "FRIEND" "SISTER" "SON" "SON_IN_LAW" "UNCLE" "WIFE" "OTHERS"
minor_flag
boolean
nomination_percent
required
number [ 0 .. 100 ] characters ^[A-Z]{3}P[A-Z][0-9]{4}[A-Z]$
email
required
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
required
string^[6-9]\d{9}$
line1
required
string >= 10 characters
line2
string [ 10 .. 120 ] characters
line3
string [ 10 .. 120 ] characters
city
required
string >= 2 characters
state
string
postal_code
required
string >= 3 characters
country
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "date_of_birth": "string",
  • "relationship": "AUNT",
  • "minor_flag": true,
  • "nomination_percent": 0,
  • "email": "string",
  • "mobile": "string",
  • "line1": "stringstri",
  • "line2": "stringstri",
  • "line3": "stringstri",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "AFG"
}

Auto-generated stub for PATCH /related_party/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
first_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
middle_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
last_name
string [ 3 .. 30 ] characters ^[A-Za-z]+(?:\s[A-Za-z]+)*$
date_of_birth
string
relationship
string
Enum: "AUNT" "BROTHER" "DAUGHTER" "DAUGHTER_IN_LAW" "FATHER" "FATHER_IN_LAW" "GRAND_DAUGHTER" "GRAND_SON" "GRAND_FATHER" "GRAND_MOTHER" "HUSBAND" "MOTHER" "MOTHER_IN_LAW" "NEPHEW" "NIECE" "FRIEND" "SISTER" "SON" "SON_IN_LAW" "UNCLE" "WIFE" "OTHERS"
minor_flag
boolean
nomination_percent
number [ 0 .. 100 ] characters
email
string^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$
mobile
string^[6-9]\d{9}$
line1
string >= 10 characters
line2
string [ 10 .. 120 ] characters
line3
string [ 10 .. 120 ] characters
city
string >= 2 characters
state
string
postal_code
string >= 3 characters
country
string
Enum: "AFG" "ALA" "ALB" "DZA" "ASM" "AND" "AGO" "AIA" "ATA" "ATG" "ARG" "ARM" "ABW" "AUS" "AUT" "AZE" "BHS" "BHR" "BGD" "BRB" "BLR" "BEL" "BLZ" "BEN" "BMU" "BTN" "BOL" "BES" "BIH" "BWA" "BVT" "BRA" "IOT" "BRN" "BGR" "BFA" "BDI" "CPV" "KHM" "CMR" "CAN" "CYM" "CAF" "TCD" "CHL" "CHN" "CXR" "CCK" "COL" "COM" "COG" "COD" "COK" "CRI" "CIV" "HRV" "CUB" "CUW" "CYP" "CZE" "DNK" "DJI" "DMA" "DOM" "ECU" "EGY" "SLV" "GNQ" "ERI" "EST" "SWZ" "ETH" "FLK" "FRO" "FJI" "FIN" "FRA" "GUF" "PYF" "ATF" "GAB" "GMB" "GEO" "DEU" "GHA" "GIB" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GGY" "GIN" "GNB" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "IMN" "ISR" "ITA" "JAM" "JPN" "JEY" "JOR" "KAZ" "KEN" "KIR" "PRK" "KOR" "KWT" "KGZ" "LAO" "LVA" "LBN" "LSO" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MHL" "MTQ" "MRT" "MUS" "MYT" "MEX" "FSM" "MDA" "MCO" "MNG" "MNE" "MSR" "MAR" "MOZ" "MMR" "NAM" "NRU" "NPL" "NLD" "NCL" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "MKD" "MNP" "NOR" "OMN" "PAK" "PLW" "PSE" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "LCA" "MAF" "SPM" "VCT" "WSM" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SXM" "SVK" "SVN" "SLB" "SOM" "ZAF" "SGS" "SSD" "ESP" "LKA" "SDN" "SUR" "SJM" "SWE" "CHE" "SYR" "TWN" "TJK" "TZA" "THA" "TLS" "TGO" "TKL" "TON" "TTO" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "ARE" "GBR" "USA" "UMI" "URY" "UZB" "VUT" "VEN" "VNM" "VGB" "VIR" "WLF" "ESH" "YEM" "ZMB" "ZWE"

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "date_of_birth": "string",
  • "relationship": "AUNT",
  • "minor_flag": true,
  • "nomination_percent": 0,
  • "email": "string",
  • "mobile": "string",
  • "line1": "stringstri",
  • "line2": "stringstri",
  • "line3": "stringstri",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "AFG"
}

ria

Auto-generated stub for GET /ria/list

Authorizations:
ALL_ROLES
query Parameters
page
string
limit
string

Responses

Auto-generated stub for GET /ria/search

Authorizations:
ALL_ROLES
query Parameters
intm_id
string
name
string
registration_no
string
email
string
city
string
state
string
page
string
limit
string

Responses

Auto-generated stub for GET /ria/count

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /ria/{intm_id}

Authorizations:
ALL_ROLES
path Parameters
intm_id
required
integer

Responses

risk_profiling

Auto-generated stub for GET /risk/questionnaires

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for POST /risk/questionnaires

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
name
required
string <= 255 characters
version
required
number non-empty
description
string <= 2000 characters
partner_id
string
is_active
boolean
questions
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "partner_id": "string",
  • "is_active": true,
  • "questions": [
    ]
}

Auto-generated stub for GET /risk/questionnaires/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for PATCH /risk/questionnaires/{id}

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
name
string <= 255 characters
description
string <= 2000 characters
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true
}

Auto-generated stub for POST /risk/questionnaires/{id}/questions

Authorizations:
ALL_ROLES
path Parameters
id
required
integer
Request Body schema: application/json
required
question_text
string <= 1000 characters
question_order
number non-empty
options
Array of objects >= 2 items

Responses

Request samples

Content type
application/json
{
  • "question_text": "string",
  • "question_order": 0,
  • "options": [
    ]
}

Auto-generated stub for PATCH /risk/questionnaires/{questionnaireId}/questions/{questionId}

Authorizations:
ALL_ROLES
path Parameters
questionnaireId
required
integer
Request Body schema: application/json
required
question_text
string <= 1000 characters
question_order
number non-empty
options
Array of objects >= 2 items

Responses

Request samples

Content type
application/json
{
  • "question_text": "string",
  • "question_order": 0,
  • "options": [
    ]
}

Auto-generated stub for POST /risk/assessments

Authorizations:
ALL_ROLES
Request Body schema: application/json
required
risk_questionnaire_id
required
number non-empty
performed_by
string
Enum: "INVESTOR" "ADVISOR"
restart
boolean

Responses

Request samples

Content type
application/json
{
  • "risk_questionnaire_id": 0,
  • "performed_by": "INVESTOR",
  • "restart": true
}

Auto-generated stub for GET /risk/assessments

Authorizations:
ALL_ROLES
query Parameters
risk_questionnaire_id
required
number
investor_id
string

Responses

Auto-generated stub for GET /risk/buckets

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /risk/assessments/all

Authorizations:
ALL_ROLES
query Parameters
investor_id
string
page
number
limit
number

Responses

Auto-generated stub for GET /risk/assessments/{assessmentId}

Authorizations:
ALL_ROLES
path Parameters
assessmentId
required
integer

Responses

Auto-generated stub for POST /risk/assessments/{assessmentId}/answers

Authorizations:
ALL_ROLES
path Parameters
assessmentId
required
integer
Request Body schema: application/json
required
risk_question_id
required
number non-empty
risk_question_option_id
required
number non-empty

Responses

Request samples

Content type
application/json
{
  • "risk_question_id": 0,
  • "risk_question_option_id": 0
}

Auto-generated stub for POST /risk/assessments/{assessmentId}/complete

Authorizations:
ALL_ROLES
path Parameters
assessmentId
required
integer

Responses

scheme

Auto-generated stub for GET /scheme

List mutual fund schemes with partner and investor restrictions applied automatically.

Partner Restrictions:

  • MFD (Multi-channel Financial Distributor) partners can only access non-direct schemes from their empanelled AMCs
  • RIA (Registered Investment Adviser) partners can only access direct schemes from all AMCs

NRI Investor Restrictions:

  • Non-resident Indian investors cannot access schemes from AMCs that have restrictions based on their tax status and country of birth
  • Restrictions are applied automatically based on the authenticated user's investor profile

Query Parameters:

  • limit: Number of schemes to return (default: 10)
  • page: Page number for pagination (default: 1)
  • name: Search schemes by name (case-insensitive partial match)
Authorizations:
PARTNERALL_ROLESALL_ROLES
query Parameters
limit
number
page
number
name
string
q
string
amc
string
category
string
sub_category
string
plan
string
option
string
isin
string
investor_id
string
partner_id
string
sort_by
string
sort_dir
string

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Auto-generated stub for GET /scheme/mf-data/{id}

Authorizations:
PARTNERALL_ROLESALL_ROLES
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Auto-generated stub for GET /scheme/{id}/holding-changes

Get detailed information for a specific mutual fund scheme.

Access Restrictions:

  • Partners can only access schemes according to their type (MFD/RIA) and AMC mappings
  • NRI investors cannot access schemes from restricted AMCs
  • Returns 404 if the scheme is not accessible to the authenticated user
Authorizations:
PARTNERALL_ROLESALL_ROLES
path Parameters
id
required
integer
query Parameters
months
number
holding_type
string
holding_name
string

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Auto-generated stub for GET /scheme/{id}

Get detailed information for a specific mutual fund scheme.

Access Restrictions:

  • Partners can only access schemes according to their type (MFD/RIA) and AMC mappings
  • NRI investors cannot access schemes from restricted AMCs
  • Returns 404 if the scheme is not accessible to the authenticated user
Authorizations:
PARTNERALL_ROLESALL_ROLES
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Auto-generated stub for GET /scheme/factsheet/{isin}

Authorizations:
PARTNERALL_ROLESALL_ROLES
path Parameters
isin
required
integer

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

sip_book

Auto-generated stub for POST /sip_book/active_sips

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/cancelled_sips

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/drilldown

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/drilldown_by_category

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/drilldown_for_chart

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/get_clients

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/get_graph_drilldown

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/get_transaction_details

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/growth

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/growth_by_category

Authorizations:
None

Responses

Auto-generated stub for POST /sip_book/overview

Authorizations:
None

Responses

sxp

Auto-generated stub for GET /sxp

Authorizations:
ALL_ROLES

Responses

Auto-generated stub for GET /sxp/{id}/bse_details

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for GET /sxp/{id}/bse_trxn_history

Authorizations:
ALL_ROLES
path Parameters
id
required
integer

Responses

Auto-generated stub for POST /sxp/cancel

Authorizations:
INVESTOR
Request Body schema: application/json
required
otp_id
required
string
otp
required
string

Responses

Request samples

Content type
application/json
{
  • "otp_id": "string",
  • "otp": "string"
}

total_net_sales

Auto-generated stub for POST /total_net_sales

Authorizations:
None

Responses