Skip to main content
POST
finance.institutions.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
financialType
enum<string>

Require support for this financial record type.

Available options:
DEPOSIT,
TERM_DEPOSIT,
RECURRING_DEPOSIT,
SIP,
CP,
GOVT_SECURITIES,
EQUITIES,
BONDS,
DEBENTURES,
MUTUAL_FUNDS,
ETF,
IDR,
CIS,
AIF,
INSURANCE_POLICIES,
NPS,
INVIT,
REIT,
GSTR1_3B,
OTHER
status
enum<string>

Filter by institution state.

Available options:
active,
inactive,
temporarily_inactive
limit
integer
default:10

Maximum rows per page, up to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque next page cursor returned by this capability.

Required string length: 1 - 512

Response

The result

results
object[]
required

Financial institutions.

Maximum array length: 100
nextCursor
string

Opaque next page cursor.

Required string length: 1 - 512