Documentation

API reference

73 APIs. Each page has its request fields, sample code and a sample response. An API works for your account once it is switched on for you.

Document AI

Read document → JSONPOST /v1/read/document
KYC document OCRPOST /v1/read/kyc-ocr
Document forgery checkPOST /v1/read/forgery

KYC / Identity

Penny-drop bank accountPOST /v1/verify/bank-account
IFSC lookupGET /v1/lookup/ifsc
Verify passportPOST /v1/verify/passport
Verify voter IDPOST /v1/verify/voter-id
Mobile ownership: send OTPPOST /v1/verify/mobile/otp
Mobile ownership: verify OTPPOST /v1/verify/mobile/otp/verify
Silent mobile checkPOST /v1/verify/mobile/silent
Revoked-number check (MNRL)POST /v1/verify/mobile/mnrl
ICSI membershipPOST /v1/verify/icsi-membership
Electricity bill (proof of address)POST /v1/verify/electricity-bill
Reverse penny drop: send amountPOST /v1/verify/bank-account/dynamic
Reverse penny drop: confirm amountPOST /v1/verify/bank-account/dynamic/confirm

Wealth / MF

MF scheme masterGET /v1/mf/scheme-master
MF NAV historyGET /v1/mf/nav
Capital gains + XIRRPOST /v1/mf/capital-gains

Tax

Income tax calculatorPOST /v1/tax/income
Capital-gains taxPOST /v1/tax/capital-gains

Market Data

Data-source licence matrixGET /v1/marketdata/sources
FX ratesGET /v1/fx/rates
Equity quoteGET /v1/marketdata/equity

CAS (portfolio fetch)

CAS provider matrixGET /v1/cas/request/providers
3.1 CAS Auto Request — open sessionPOST /v1/cas/request/session
3.1 CAS Auto Request — submitPOST /v1/cas/request/submit
3.1 CAS Auto Request — one callPOST /v1/cas/request/auto
3.2 CAS Auto Read — mailbox scanPOST /v1/cas/read/mailbox/scan
3.3 CAS Auto Import — import parsed CASPOST /v1/cas/import/document
3.3 CAS Auto Import — current portfolioGET /v1/cas/portfolio
3.3 CAS Auto Import: upload and importPOST /v1/cas/import
3.3 CAS Auto Import: one importGET /v1/cas/imports/:id
3.2 CAS Auto Read: uploadPOST /v1/cas/read
3.1 CAS Auto Request: historyGET /v1/cas/requests
3.1 CAS Auto Request: one requestGET /v1/cas/requests/:id

Depository / Broker

Unified broker connectPOST /v1/broker/connect
Connect LIVE account (real data)POST /v1/broker/connect
HoldingsGET /v1/broker/holdings
List connectionsGET /v1/broker/connections
Rotate daily tokenPOST /v1/broker/connections/:id/token
Revoke connectionDELETE /v1/broker/connections/:id
Broker login: startPOST /v1/broker/login/start
Broker login: callbackPOST /v1/broker/login/callback
Broker profileGET /v1/broker/profile

Portfolio+

Consolidated portfolioGET /v1/portfolio
Deduplicated holdingsGET /v1/portfolio/holdings
Allocation + concentrationGET /v1/portfolio/allocation
Portfolio scoreGET /v1/portfolio/score

Lending

EMI / amortizationPOST /v1/emi/schedule

PMS / AIF

PMS performancePOST /v1/pms/performance

Vehicle / DL

RC lookupPOST /v1/vehicle/rc
DL verifyPOST /v1/vehicle/dl
FASTag last locationPOST /v1/vehicle/fastag/history
Reverse RC searchPOST /v1/vehicle/reverse-search

Business / KYB

Udyam (MSME) verificationPOST /v1/business/udyam
Udyam by OTP: sendPOST /v1/business/udyam/otp
Udyam by OTP: verifyPOST /v1/business/udyam/otp/verify
TAN verificationPOST /v1/business/tan
TIN lookupPOST /v1/business/tin
Shop and establishmentPOST /v1/business/shop-establishment
Director search by DINPOST /v1/business/director

Employment

EPF employment historyPOST /v1/employment/uan
Employee search in an establishmentPOST /v1/employment/employee-search
EPFO establishment detailsPOST /v1/employment/establishment

Credit

Credit bureau reportPOST /v1/credit/bureau-report

Income (ITR)

ITR fetchPOST /v1/tax/itr/fetch
ITR-V verificationPOST /v1/tax/itr/verify

Risk & Location

IP quality checkPOST /v1/risk/ip
IP geo-fencingPOST /v1/risk/geo-fence
Reverse geocodePOST /v1/geo/reverse-geocode
Negative due diligencePOST /v1/risk/negative-due-diligence

Account

Wallet balanceGET /v1/wallet
Usage historyGET /v1/usage

Error reference

Every failure returns the same shape. Quote request_id when you contact support. A call that fails because of an error on our side or at the data source is refunded to your wallet automatically; a "no record found" answer is charged.

{
  "error": {
    "code": "not_found",
    "message": "No record found for these details",
    "request_id": "req_01HZY3K8M2"
  }
}
CodeHTTPMeaningWhat to do
missing_api_key401No Bearer token was sent.Send the Authorization header.
invalid_api_key401The key is wrong or revoked, or the calling IP or domain is not on its allowlist.Read the message, then check the key and its allowlist.
insufficient_balance402The wallet cannot cover this call.Recharge the wallet.
insufficient_scope403The key does not carry the scope this API needs.Add the scope to the key.
api_not_activated403This API is not switched on for your account yet. We switch each API on after your payment.Subscribe to the API in Dashboard → API access.
consent_required403No valid consent is on file for this data.Capture consent, then retry.
consent_expired403The consent has expired.Capture consent again.
consent_revoked403The person withdrew consent.Do not retry without new consent.
purpose_mismatch403The consent was given for a different purpose.Capture consent for this purpose.
not_found404No record matched these details.Check the details. The check was carried out, so the call is charged.
idempotency_key_reused409This Idempotency-Key was used with a different request.Use a new key for a new request.
validation_failed422A field is missing or has the wrong format.Fix the fields listed in error.details.
rate_limited429Too many requests from your account.Wait a few seconds and retry.
internal500Something went wrong on our side.Retry, and quote request_id to support if it continues.
upstream_unavailable503This check is temporarily unavailable.Retry shortly. The call is refunded.
api_unavailable503This API is not available for calls yet.Contact us; nothing is charged.