v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

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.

post/backend/{gatewayName}/v1/combinedCreditSnapshot

Path parameters

gatewayNamestring required

Your gateway partner name.

Headers

x-gateway-secretstring required

apiSecret shared for authentication.

x-gateway-authtokenstring required

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

Request body

unityUserIdstring

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

brokerHoldingsobject[]

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

aggregateFundsboolean

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

panstring

User's PAN

agenumber

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

isNriboolean

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

namestring

User's name.

referrerstring

Defaults to your partner name.

Response

Pre-onboarding (no unityUserId)

dataobject

messagestring

codeinteger