Jump to Content

v1.0

API Reference

v1.0API Reference

Preface

Introduction
Authentication
Environments
HTTP Status Codes

Account balance API

Overview
Check Account Balance APIget
- Sample Response

Aadhaar XML Verification API

Overview
Aadhaar XML Verification APIpost
Aadhaar XML APIget
- Sample Response
Sample Test Cases

Bank Account Verification

Overview
Bank Account Verification APIpost
Verification Status APIget
Test Cases

Business Bureau Soft Pull API

Overview
Generate OTPpost
- Sample Response
Verify OTPput
- Sample Response
Pull Credit Reportpost
- Sample Response
- Pull Business Credit Report API Parameters

Bureau Hard Pull API

Overview
Pull Credit Reportpost
- Sample Response
- Pull Credit Report API Parameters
Run Policy APIget
FAQs

Bureau Soft Pull API

Overview
Generate OTP APIpost
- Sample Response
Verify OTP APIput
- Sample Response
Pull Credit Report APIpost
Run Policy APIget
Example of Calculation of Variables
Sample Test Cases

CIBIL Bureau Soft Pull API

Overview
Initiate Transaction APIpost
Initiate Customer Authenticationpost
- Sample Response
- Stage Choices
Verify Customer Authentication APIpost
Run Policy APIpost
CIBIL Error Codes
Example of Calculation of Variables
Sample Test Cases

CKYC API

Overview
CKYC APIpost
Sample Response
- Response API Parameters
Sample Test Cases

E-Signature API

Overview
E-Signature APIpost
E-Signature Statusget

Loan Booking API

Overview
Loan Booking APIpost
Bulk Document Upload API
Upload Document APIpost
- Upload document API Parameters
- Document IDs
Upload Credit Report APIpost
Address Create APIpost
- Address Create API Parameters
Generate Document API - Optionalpost
- Generate Document API Parameters
Onboarding Completedpost
- Webhooks
Disburse Loan API
- Status Details
- Webhooks
Repayment Schedule APIget
Repayment APIpost
- Repayment API parameters
- Allocation Detail Parameters
Tips for robust integration
Upload Bank Statementpost
Charges APIpost
- Charges API parameters
Reject Loan APIpost
Loan Created Details APIget
Get Co-Lending Repayments details APIget
- Choices for charge_type and payment_type
- API Parameters

Credit Line Loan Booking APIs

Overview
Line Creation - Onboarding APIpost
Upload Document APIpost
- Upload Document Parameters
- DOC_type
Onboarding Statusget
Onboarding Completed APIpost
Tranche Creation APIpost
Upload Document To Loan Tranche APIpost
Disburse Tranchepost
Repayment APIpost
- Repayment API Parameters
- Allocation Detail Parameters
Change Limit Request APIpost
Sample Flow
FAQ
Update Tranche Status

PAN Verification API

Overview
PAN Verification APIpost
PAN Verification API Parameters
- trigger_pan_verification
PAN Details APIget

Bank Statement Analysis

Upload Bank Statementpost
Download BSA Reportpost
Link Loan Documentspost
Get Bank Namesget
Get Updated bank Listget
WEBHOOKS

NACH Placement API

Overview
Auto-Debit File Upload APIpost
Auto-Debit Request Detailsget
- Sample Response - Success

E-NACH Registration API

Overview
Initiate ENach registrationpost
- For production environment
- Mandate Initiation Parameters
ENach registration statusget
- Mandate Status Parameters
Register UPI Mandate APIpost

Physical NACH Registration API

Overview
Initiate Physical NACH registrationpost
- Mandate Initiation Parameters
Physical NACH registration uploadput
- Sample Response
Physical NACH Registration Statusget
- Mandate Status Parameters
FAQ

Initiate Physical NACH registration

Getting Started With Your API

Physical NACH registration upload

Getting Started With Your API

Physical NACH registration status

Getting Started With Your API

Aadhar Consent Api

aadhaar-file
aadhar-consent
aadhar-otp

Penny drop api

penny drop api
Penny drop status api

Nach Mandate sharing API

Nach Mandate Sharing API

Amount fetching api

Bill API - Customer levelget
Bill API - Tranche Levelget
Upcoming Bill API - Customer Levelget
Upcoming Bill API - Tranche Levelget
Foreclosure API - Tranche Levelget

UPdate mobile number

Update mobile numberpost

Powered by

Preface

Introduction
Authentication
Environments
HTTP Status Codes

Account balance API

Overview
Check Account Balance APIget
- Sample Response

Aadhaar XML Verification API

Overview
Aadhaar XML Verification APIpost
Aadhaar XML APIget
- Sample Response
Sample Test Cases

Bank Account Verification

Overview
Bank Account Verification APIpost
Verification Status APIget
Test Cases

Business Bureau Soft Pull API

Overview
Generate OTPpost
- Sample Response
Verify OTPput
- Sample Response
Pull Credit Reportpost
- Sample Response
- Pull Business Credit Report API Parameters

Bureau Hard Pull API

Overview
Pull Credit Reportpost
- Sample Response
- Pull Credit Report API Parameters
Run Policy APIget
FAQs

Bureau Soft Pull API

Overview
Generate OTP APIpost
- Sample Response
Verify OTP APIput
- Sample Response
Pull Credit Report APIpost
Run Policy APIget
Example of Calculation of Variables
Sample Test Cases

CIBIL Bureau Soft Pull API

Overview
Initiate Transaction APIpost
Initiate Customer Authenticationpost
- Sample Response
- Stage Choices
Verify Customer Authentication APIpost
Run Policy APIpost
CIBIL Error Codes
Example of Calculation of Variables
Sample Test Cases

CKYC API

Overview
CKYC APIpost
Sample Response
- Response API Parameters
Sample Test Cases

E-Signature API

Overview
E-Signature APIpost
E-Signature Statusget

Loan Booking API

Overview
Loan Booking APIpost
Bulk Document Upload API
Upload Document APIpost
- Upload document API Parameters
- Document IDs
Upload Credit Report APIpost
Address Create APIpost
- Address Create API Parameters
Generate Document API - Optionalpost
- Generate Document API Parameters
Onboarding Completedpost
- Webhooks
Disburse Loan API
- Status Details
- Webhooks
Repayment Schedule APIget
Repayment APIpost
- Repayment API parameters
- Allocation Detail Parameters
Tips for robust integration
Upload Bank Statementpost
Charges APIpost
- Charges API parameters
Reject Loan APIpost
Loan Created Details APIget
Get Co-Lending Repayments details APIget
- Choices for charge_type and payment_type
- API Parameters

Credit Line Loan Booking APIs

Overview
Line Creation - Onboarding APIpost
Upload Document APIpost
- Upload Document Parameters
- DOC_type
Onboarding Statusget
Onboarding Completed APIpost
Tranche Creation APIpost
Upload Document To Loan Tranche APIpost
Disburse Tranchepost
Repayment APIpost
- Repayment API Parameters
- Allocation Detail Parameters
Change Limit Request APIpost
Sample Flow
FAQ
Update Tranche Status

PAN Verification API

Overview
PAN Verification APIpost
PAN Verification API Parameters
- trigger_pan_verification
PAN Details APIget

Bank Statement Analysis

Upload Bank Statementpost
Download BSA Reportpost
Link Loan Documentspost
Get Bank Namesget
Get Updated bank Listget
WEBHOOKS

NACH Placement API

Overview
Auto-Debit File Upload APIpost
Auto-Debit Request Detailsget
- Sample Response - Success

E-NACH Registration API

Overview
Initiate ENach registrationpost
- For production environment
- Mandate Initiation Parameters
ENach registration statusget
- Mandate Status Parameters
Register UPI Mandate APIpost

Physical NACH Registration API

Overview
Initiate Physical NACH registrationpost
- Mandate Initiation Parameters
Physical NACH registration uploadput
- Sample Response
Physical NACH Registration Statusget
- Mandate Status Parameters
FAQ

Initiate Physical NACH registration

Getting Started With Your API

Physical NACH registration upload

Getting Started With Your API

Physical NACH registration status

Getting Started With Your API

Aadhar Consent Api

aadhaar-file
aadhar-consent
aadhar-otp

Penny drop api

penny drop api
Penny drop status api

Nach Mandate sharing API

Nach Mandate Sharing API

Amount fetching api

Bill API - Customer levelget
Bill API - Tranche Levelget
Upcoming Bill API - Customer Levelget
Upcoming Bill API - Tranche Levelget
Foreclosure API - Tranche Levelget

UPdate mobile number

Update mobile numberpost

Powered by

initiate-ckyc

Initiate ckyc view.

View Name:- v1:kyc:initiate-ckyc

View Path:- kyc.v1.views.InitiateCKYCView

URL Path:- /api/v1/kyc/ckyc/