Jump to Content
OneFin
API Reference
v1.0

Log InOneFin
API Reference
Log In
latestAPI 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
    • XML Verification API Parameters
    • Sample Response
    • Response Parameters
  • Aadhaar XML APIget
    • Sample Response
  • Sample Test Cases

Bank Account Verification

  • Overview
  • Bank Account Verification APIpost
    • API Parameters
    • Sample Response
    • Webhooks
    • Sample Webhook : Success
    • Sample Webhook : Failure
  • 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
    • Sample Response
    • Supported Credit Policy Parameters
    • Supported Operators
    • Example of Calculation of Variables
  • FAQs

Bureau Soft Pull API

  • Overview
  • Generate OTP APIpost
    • Sample Response
  • Verify OTP APIput
    • Sample Response
  • Pull Credit Report APIpost
    • Sample Response
    • Pull Consumer Credit Report API Parameters
    • Cibil Credit Report Pullpost
  • Run Policy APIget
    • Sample Payload
    • Sample Response
    • Supported Credit Policy Parameters
    • Supported Operators
  • Example of Calculation of Variables
  • Sample Test Cases

CIBIL Bureau Soft Pull API

  • Overview
  • Initiate Transaction APIpost
    • Sample Response
    • Pull Credit Report API Parameters
    • States
    • Identifier Types
  • Initiate Customer Authenticationpost
    • Sample Response
    • Stage Choices
  • Verify Customer Authentication APIpost
    • Sample Payload for Alternate Number
    • Sample Payload for One Time Password
    • Sample Payload for Credit Report Questions
    • Sample Response
  • Run Policy APIpost
    • Sample Response
    • Supported Credit Policy Parameters
    • Supported Operators
  • CIBIL Error Codes
  • Example of Calculation of Variables
  • Sample Test Cases

CKYC API

  • Overview
    • CKYC Send OTP Verificationpost
    • Validate CKYC OTPpost
  • CKYC APIpost
    • Sample Request
    • CKYC API Parameters
    • initiate-ckyc
  • Sample Response
    • Response API Parameters
  • Sample Test Cases

E-Signature API

  • Overview
  • E-Signature APIpost
    • Sample Request
    • Sample Response
    • API Parameters
    • Signatory Configuration
    • Coordinates Parameters
    • API Response Parameters
    • Signatory Response Parameters
    • Sample Python Code
    • A Note on Coordinates
    • A Note to Callback URL
    • Bonus: Brand Logo
  • E-Signature Statusget
    • Sample Response
    • Status API Response
    • Success Status details
    • Signatory Status Details

Loan Booking API

  • Overview
  • Loan Booking APIpost
    • Loan Booking API Parameters
    • Institute Detail Parameters
    • Bank Account Parameters
    • KYC Parameters
    • Disbursal Detail Parameters
    • Repayment Schedule Parameters
  • 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
  • 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
    • Credit Line API Parameters
    • Bank Account Parameters
    • KYC Parameters
  • Upload Document APIpost
    • Upload Document Parameters
    • DOC_type
  • Onboarding Statusget
  • Onboarding Completed APIpost
  • Tranche Creation APIpost
    • Tranche Create Parameters
    • Disbursal Detail Parameters
    • Repayment Schedule Parameters
  • 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
    • Response
    • Supported PANs
    • Possible Status in Response
    • Aadhaar Seeding Status
  • 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
    • Request Payload
    • Sample Response - Success
    • Sample Response - Failure
    • NACH AutoDebit Response Status
  • 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

Miscellaneous API

  • Reject By Partnerpost
  • Loan Created Details APIpost
  • Create Co Applicant (Stand-Alone API)post
  • Update Co-Applicant (Stand-Alone)put
  • Fetch Co Applicantsget
  • Update-post-disbursal-datapost

CKYC OTP API's

  • Getting Started With Your API

CKYC OTP Validate

  • Getting Started With Your API
Powered by 

Sample Test Cases

Mobile NumberEmail IdNameTypeCredit Report Link
9999999998[email protected]shamarao manoharConsumer:
Deep Credit History
Deep Credit History
9999999995[email protected]NIGAMANANDA BARIKConsumer:
New To Credit
No Report
9999999994[email protected]Arvind ManilalConsumer:
Moderate Credit History
Moderate Credit History