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.
QuickstartAuthentication and securityOpenAPI 3.1 file
Document AI
| Read document → JSON | POST /v1/read/document |
| KYC document OCR | POST /v1/read/kyc-ocr |
| Document forgery check | POST /v1/read/forgery |
KYC / Identity
| Penny-drop bank account | POST /v1/verify/bank-account |
| IFSC lookup | GET /v1/lookup/ifsc |
| Verify passport | POST /v1/verify/passport |
| Verify voter ID | POST /v1/verify/voter-id |
| Mobile ownership: send OTP | POST /v1/verify/mobile/otp |
| Mobile ownership: verify OTP | POST /v1/verify/mobile/otp/verify |
| Silent mobile check | POST /v1/verify/mobile/silent |
| Revoked-number check (MNRL) | POST /v1/verify/mobile/mnrl |
| ICSI membership | POST /v1/verify/icsi-membership |
| Electricity bill (proof of address) | POST /v1/verify/electricity-bill |
| Reverse penny drop: send amount | POST /v1/verify/bank-account/dynamic |
| Reverse penny drop: confirm amount | POST /v1/verify/bank-account/dynamic/confirm |
Wealth / MF
| MF scheme master | GET /v1/mf/scheme-master |
| MF NAV history | GET /v1/mf/nav |
| Capital gains + XIRR | POST /v1/mf/capital-gains |
Tax
| Income tax calculator | POST /v1/tax/income |
| Capital-gains tax | POST /v1/tax/capital-gains |
Market Data
| Data-source licence matrix | GET /v1/marketdata/sources |
| FX rates | GET /v1/fx/rates |
| Equity quote | GET /v1/marketdata/equity |
CAS (portfolio fetch)
| CAS provider matrix | GET /v1/cas/request/providers |
| 3.1 CAS Auto Request — open session | POST /v1/cas/request/session |
| 3.1 CAS Auto Request — submit | POST /v1/cas/request/submit |
| 3.1 CAS Auto Request — one call | POST /v1/cas/request/auto |
| 3.2 CAS Auto Read — mailbox scan | POST /v1/cas/read/mailbox/scan |
| 3.3 CAS Auto Import — import parsed CAS | POST /v1/cas/import/document |
| 3.3 CAS Auto Import — current portfolio | GET /v1/cas/portfolio |
| 3.3 CAS Auto Import: upload and import | POST /v1/cas/import |
| 3.3 CAS Auto Import: one import | GET /v1/cas/imports/:id |
| 3.2 CAS Auto Read: upload | POST /v1/cas/read |
| 3.1 CAS Auto Request: history | GET /v1/cas/requests |
| 3.1 CAS Auto Request: one request | GET /v1/cas/requests/:id |
Depository / Broker
| Unified broker connect | POST /v1/broker/connect |
| Connect LIVE account (real data) | POST /v1/broker/connect |
| Holdings | GET /v1/broker/holdings |
| List connections | GET /v1/broker/connections |
| Rotate daily token | POST /v1/broker/connections/:id/token |
| Revoke connection | DELETE /v1/broker/connections/:id |
| Broker login: start | POST /v1/broker/login/start |
| Broker login: callback | POST /v1/broker/login/callback |
| Broker profile | GET /v1/broker/profile |
Portfolio+
| Consolidated portfolio | GET /v1/portfolio |
| Deduplicated holdings | GET /v1/portfolio/holdings |
| Allocation + concentration | GET /v1/portfolio/allocation |
| Portfolio score | GET /v1/portfolio/score |
Lending
| EMI / amortization | POST /v1/emi/schedule |
PMS / AIF
| PMS performance | POST /v1/pms/performance |
Vehicle / DL
| RC lookup | POST /v1/vehicle/rc |
| DL verify | POST /v1/vehicle/dl |
| FASTag last location | POST /v1/vehicle/fastag/history |
| Reverse RC search | POST /v1/vehicle/reverse-search |
Business / KYB
| Udyam (MSME) verification | POST /v1/business/udyam |
| Udyam by OTP: send | POST /v1/business/udyam/otp |
| Udyam by OTP: verify | POST /v1/business/udyam/otp/verify |
| TAN verification | POST /v1/business/tan |
| TIN lookup | POST /v1/business/tin |
| Shop and establishment | POST /v1/business/shop-establishment |
| Director search by DIN | POST /v1/business/director |
Employment
| EPF employment history | POST /v1/employment/uan |
| Employee search in an establishment | POST /v1/employment/employee-search |
| EPFO establishment details | POST /v1/employment/establishment |
Credit
| Credit bureau report | POST /v1/credit/bureau-report |
Income (ITR)
| ITR fetch | POST /v1/tax/itr/fetch |
| ITR-V verification | POST /v1/tax/itr/verify |
Risk & Location
| IP quality check | POST /v1/risk/ip |
| IP geo-fencing | POST /v1/risk/geo-fence |
| Reverse geocode | POST /v1/geo/reverse-geocode |
| Negative due diligence | POST /v1/risk/negative-due-diligence |
Account
| Wallet balance | GET /v1/wallet |
| Usage history | GET /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"
}
}| Code | HTTP | Meaning | What to do |
|---|---|---|---|
missing_api_key | 401 | No Bearer token was sent. | Send the Authorization header. |
invalid_api_key | 401 | The 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_balance | 402 | The wallet cannot cover this call. | Recharge the wallet. |
insufficient_scope | 403 | The key does not carry the scope this API needs. | Add the scope to the key. |
api_not_activated | 403 | This 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_required | 403 | No valid consent is on file for this data. | Capture consent, then retry. |
consent_expired | 403 | The consent has expired. | Capture consent again. |
consent_revoked | 403 | The person withdrew consent. | Do not retry without new consent. |
purpose_mismatch | 403 | The consent was given for a different purpose. | Capture consent for this purpose. |
not_found | 404 | No record matched these details. | Check the details. The check was carried out, so the call is charged. |
idempotency_key_reused | 409 | This Idempotency-Key was used with a different request. | Use a new key for a new request. |
validation_failed | 422 | A field is missing or has the wrong format. | Fix the fields listed in error.details. |
rate_limited | 429 | Too many requests from your account. | Wait a few seconds and retry. |
internal | 500 | Something went wrong on our side. | Retry, and quote request_id to support if it continues. |
upstream_unavailable | 503 | This check is temporarily unavailable. | Retry shortly. The call is refunded. |
api_unavailable | 503 | This API is not available for calls yet. | Contact us; nothing is charged. |