Combined Credit Snapshot

The single source of truth for the landing page UI. One request returns the user's identity, all loans, journey states, eligibility per asset class, and any in-progress top-up references.

Path Params
string
required

Your gateway partner name.

Body Params
string

Omit for pre-onboarding pure eligibility (user will be null). Include once Create User has returned an ID — required to fetch user state + loans

stockHoldings
array of objects

Pass to compute STOCKS eligibility. Each entry must include dpId. See holding shape below.

stockHoldings
mfHoldings
array of objects

Pass to compute MUTUAL FUND eligibility. See holding shape below.

mfHoldings
brokerHoldings
array

Broker raw holdings (currently kite) for cross-validation against stockHoldings.

brokerHoldings
boolean
Defaults to false

When true, MF distribution is aggregated by ISIN. No effect on STOCKS.

string

User's PAN

number

Validated against the lender's allowed age range when provided.

string

Use isNri — isNRI is deprecated. NRI users rejected with not_eligible_wrt_nri_status (4407).

string

User's name.

string

Enables PL pre-approved offers in creditLimit[].

string

Country code for phone number.

lenders
array of strings

Filter eligibility to specific lenders.

lenders
string

Defaults to your partner name.

Headers
string
required
Defaults to gatewayDemo_secret

apiSecret shared for authentication.

string
required
Defaults to eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJndWVzdCI6dHJ1ZSwiaWF0IjoxNjU0MzIxMDAwfQ.qiZ_w1yFYXhkdLMlqI28XJOXitfZwr64e2oL-lMEHZU

JWT created with payload {"iss":"<your_gateway_name>"}, signed with the shared secret.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json