"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"pan_number\": \"ATZPS4790T\",\n \"remark\": \"Optional client note or reference\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/itr/compliance-check"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:04:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"98-R3FywwuzENrwXNWIjEU+GrntjqE\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:04:59.501Z\",\n \"transaction_id\": \"6cf3e6f9-6c44-4f43-9544-a116fb6842e6\",\n \"status\": \"error\",\n \"error_message\": \"Verification Failed.\"\n}"}],"_postman_id":"5c003cfa-601c-450e-928a-4932a0e71dd0"},{"name":"PAN to CIN","id":"10235ebf-6c9b-446b-82f8-73f6fbb8a701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\":\"AADXX75XXE\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/pan-to-cin","description":"Introduction
\nThe PAN to CIN API allows users to map a Permanent Account Number (PAN) to its corresponding Corporate Identification Number (CIN) and retrieve the registered company name.
\nThis API is useful for business KYC, compliance checks, fraud detection, and entity verification.
\n
\nUse Cases
\n\nRetrieve the Corporate Identification Number (CIN) linked to a PAN.
\nVerify the company name associated with a PAN.
\nPerform Know Your Business (KYB) checks during onboarding.
\nSupport regulatory compliance by validating corporate registration.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/pan/pan-to-cin | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\nAuthorization | \nBearer YOUR_BEARER_TOKEN | \nYes | \n
\n\nContent-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\nid_number | \nstring | \nPAN Number of the entity (10 characters, alphanumeric) | \n\"AAXXX7XX1E\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Body Parameters
\nJSON Example
\n{\n \"timestamp\": \"2025-08-20T05:45:51.658Z\",\n \"transaction_id\": \"TXN-2e5e9451-9753-4203-bf94-53d801e7abbc\",\n \"status\": \"success\",\n \"data\": {\n \"company_name\": \"YOGESH INTEGRATIONS\",\n \"identity_number\": \"U6XXX0DL2025PTCXXX581\"\n }\n}\n\n
\nResponse Fields
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.company_name | \nstring | \nRegistered company name linked to the PAN | \n
\n\ndata.identity_number | \nstring | \nCorporate Identification Number (CIN) associated with the PAN | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| PAN to CIN | \n400–900 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 400 | \nMissing Required Parameters | \n\"id_number\" is missing from the request | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 422 | \nInvalid PAN | \nThe provided PAN number is invalid or not mapped to any CIN | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the Bearer Token is valid and active.
\nPAN must be a valid 10-character alphanumeric value.
\nUseful for corporate verification workflows where CIN mapping is required.
\nHelps detect fake or unregistered businesses quickly.
\n
\n","urlObject":{"path":["api","kyc","pan","pan-to-cin"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"52ba403e-bb4d-4232-8985-52340a569bc0","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\":\"AAXXX7XX1E\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/pan-to-cin"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 20 Aug 2025 05:45:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"212"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"d4-JIkKHQGxhjLKedL3SmU8aPdYJkE\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-20T05:45:51.658Z\",\n \"transaction_id\": \"TXN-2e5e9451-9753-4203-bf94-53d801e7abbc\",\n \"status\": \"success\",\n \"data\": {\n \"company_name\": \"YOGESH INTEGRATIONS\",\n \"identity_number\": \"U6XXX0DL2025PTCXXX581\"\n }\n}"},{"id":"f6b41207-1caa-4492-a0c3-f22b8c0a21cb","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\":\"AAXX7XX1E\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/pan-to-cin"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 20 Aug 2025 05:47:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"4c-+1oKK8/CbL2jjBXu7u+shUd2RUs\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input id_number\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"10235ebf-6c9b-446b-82f8-73f6fbb8a701"},{"name":"Mobile to Pan","id":"d05f6492-aeb3-4986-a20e-0e54693dcf70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"XXXXXXXX21\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/mobile-to-pan","description":"Introduction
\nThe Mobile to PAN API allows users to retrieve the Permanent Account Number (PAN) linked to a given mobile number.
\nThis API is useful for KYC completion, fraud prevention, onboarding processes, and financial identity verification.
\n
\nUse Cases
\n\nRetrieve the PAN number registered with a specific mobile number.
\nSimplify customer onboarding by pre-filling PAN details.
\nVerify identity in financial and compliance workflows.
\nReduce manual errors in PAN collection.
\nDetect potential mismatches or fraudulent submissions.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/pan/mobile-to-pan | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\nFormat: JSON
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| mobile_no | \nString | \nMobile number linked to the PAN (10 digits). | \n\"XXXXXXXX21\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.pan_number | \nstring | \nPAN number linked to the given mobile number. | \n
\n\n
\n
Latency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to PAN | \n400–1100 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 200 | \nNo Data Found | \nNo matching record found | \nYES | \n
\n\n| 400 | \nBad Request | \n\"mobile_no\" is missing from the request. | \nNO | \n
\n\n| 422 | \nInvalid Mobile Number | \nThe mobile number is invalid or not found in PAN records. | \nPartial (0.09r) | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error; check logs | \nNO | \n
\n\n
\n
\nAdditional Notes
\n\nAlways ensure the Bearer Token is active and valid.
\nMobile number must be a valid 10-digit number linked to a PAN.
\nIdeal for quick KYC verification where mobile number is the primary input.
\nHelps reduce user friction in form-filling by auto-fetching PAN.
\n
\n","urlObject":{"path":["api","kyc","pan","mobile-to-pan"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"c9d298db-c3a4-434b-9546-71d307ab42ec","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"9876543210\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/mobile-to-pan"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:42:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"9a-fs3aVfrkvSU7TRROGjxNZCkW50s\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T15:42:30.058Z\",\n \"transaction_id\": \"TXN-082d20ac-78b3-4ca9-a886-e810df66a68f\",\n \"status\": \"success\",\n \"data\": {\n \"pan_number\": \"HE00D0087M\"\n }\n}"},{"id":"18e1b1d2-8acb-4b6c-919f-87773f3b02a1","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"98765421\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/mobile-to-pan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:43:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"4c-oG45uMTe+k5xg16pKRj4nQzH9z8\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input mobile_no\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"d05f6492-aeb3-4986-a20e-0e54693dcf70"}],"id":"af80687b-d903-4512-b475-deb3e157dab2","_postman_id":"af80687b-d903-4512-b475-deb3e157dab2","description":""},{"name":"Driving License","item":[{"name":"Driving License Basic","event":[{"listen":"test","script":{"exec":["var template = `","","",""," "," | Transaction ID | "," Status | "," DB Location | "," DL Number | "," Bio Full Name | "," DL Issue Date | ","
"," "," {{#each response.data}}"," "," | {{../transaction_id}} | "," {{../status}} | "," {{dbLoc}} | "," {{dlobj.dlLicno}} | "," {{bioObj.bioFullName}} | "," {{dlobj.dlIssuedt}} | ","
"," {{/each}}","
","`;","","function constructVisualizerPayload() {"," return { response: pm.response.json() };","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{},"id":"8c8b4b2b-7f67-4c95-a475-eab22f812884"}}],"id":"214a5051-013b-4ca6-bc06-f8a0632ba20d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"driving_licence\": \"RJXX2021000XXXX\",\n \"dob\": \"2001-02-13\",\n\"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/driving-license/basic","description":"Driving License Basic ( Masked Data)
\nIntroduction
\nThe Driving License Basic Verification API allows businesses to verify the authenticity of a Driving License (DL) and retrieve essential holder details directly from official transport authority sources.
\nIt provides identity, contact, and license-related information such as full name, date of birth, father’s name, blood group, address, and license endorsement details.
\nThis API supports KYC workflows, driver validation, background verification, and compliance checks.
\n
\nUse Cases
\n\nValidate authenticity and validity of a driving license number.
\nRetrieve personal and contact details of the license holder.
\nAccess permanent and temporary address information.
\nVerify endorsement and issuance details of a license.
\nSupport eKYC, background verification, mobility onboarding, and insurance workflows.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Live | \nhttps://live.finaxle.com/api/driving-license/basic | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n| Accept | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\nJSON Example
\n{\n \"driving_licence\": \"RJXXXX021000XXXX\",\n \"dob\": \"2025-01-23\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| driving_licence | \nString | \nDriving License Number | \nYes | \n
\n\n| dob | \nString | \nDate of Birth (YYYY-MM-DD format) | \nYes | \n
\n\n| remark | \nString | \nOptional client remark or tracking comment (logged only, not used in validation) | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.personalInfo.fullName | \nstring | \nFull name of the license holder | \n
\n\ndata.personalInfo.firstName | \nstring | \nFirst name of the license holder | \n
\n\ndata.personalInfo.middleName | \nstring | \nMiddle name of the license holder | \n
\n\ndata.personalInfo.lastName | \nstring | \nLast name of the license holder | \n
\n\ndata.personalInfo.dateOfBirth | \nstring | \nDate of birth (DD-MM-YYYY) | \n
\n\ndata.personalInfo.gender | \nstring | \nGender of the license holder | \n
\n\ndata.personalInfo.bloodGroup | \nstring | \nBlood group of the license holder | \n
\n\ndata.personalInfo.fatherName | \nstring | \nFather’s name | \n
\n\ndata.personalInfo.fatherRelation | \nstring | \nRelation type (e.g., Father, Guardian) | \n
\n\ndata.personalInfo.birthPlace | \nstring | \nPlace of birth (if available) | \n
\n\ndata.personalInfo.identityMark1 | \nstring | \nIdentity mark 1 (if available) | \n
\n\ndata.personalInfo.identityMark2 | \nstring | \nIdentity mark 2 (if available) | \n
\n\ndata.personalInfo.organDonor | \nstring | \nOrgan donor status (Y/N) | \n
\n\ndata.contactInfo.mobileNumber | \nstring | \nRegistered mobile number | \n
\n\ndata.contactInfo.alternateNumber | \nstring | \nAlternate mobile number | \n
\n\ndata.contactInfo.phoneNumber | \nstring | \nLandline or additional contact number | \n
\n\ndata.contactInfo.emailId | \nstring | \nRegistered email ID | \n
\n\ndata.licenseInfo.dlNumber | \nstring | \nDriving License number (formatted) | \n
\n\ndata.licenseInfo.endorsementNumber | \nstring | \nEndorsement reference number | \n
\n\ndata.licenseInfo.endorsementDate | \nstring | \nDate of endorsement (DD-MM-YYYY) | \n
\n\ndata.licenseInfo.endorsementTime | \nstring | \nTime of endorsement (HH:MM:SS) | \n
\n\ndata.licenseInfo.qualification | \nstring | \nLicense qualification or class | \n
\n\ndata.permanentAddress.addressLine1 | \nstring | \nPermanent address – line 1 | \n
\n\ndata.permanentAddress.addressLine2 | \nstring | \nPermanent address – line 2 | \n
\n\ndata.permanentAddress.addressLine3 | \nstring | \nPermanent address – line 3 | \n
\n\ndata.permanentAddress.district | \nstring | \nDistrict name of the permanent address | \n
\n\ndata.permanentAddress.subDistrict | \nstring | \nSub-district or tehsil (if available) | \n
\n\ndata.permanentAddress.villageOrTown | \nstring | \nVillage or town name | \n
\n\ndata.permanentAddress.pinCode | \nstring | \nPincode of permanent address | \n
\n\ndata.permanentAddress.locationType | \nstring | \nR (Rural) / U (Urban) | \n
\n\ndata.permanentAddress.locality | \nstring | \nLocality type (RURAL/URBAN) | \n
\n\ndata.permanentAddress.fullAddress | \nstring | \nComplete permanent address (if available) | \n
\n\ndata.temporaryAddress.addressLine1 | \nstring | \nTemporary address – line 1 | \n
\n\ndata.temporaryAddress.addressLine2 | \nstring | \nTemporary address – line 2 | \n
\n\ndata.temporaryAddress.addressLine3 | \nstring | \nTemporary address – line 3 | \n
\n\ndata.temporaryAddress.district | \nstring | \nDistrict name of the temporary address | \n
\n\ndata.temporaryAddress.subDistrict | \nstring | \nSub-district or tehsil (if available) | \n
\n\ndata.temporaryAddress.villageOrTown | \nstring | \nVillage or town name | \n
\n\ndata.temporaryAddress.pinCode | \nstring | \nPincode of temporary address | \n
\n\ndata.temporaryAddress.locationType | \nstring | \nR (Rural) / U (Urban) | \n
\n\ndata.temporaryAddress.locality | \nstring | \nLocality type (RURAL/URBAN) | \n
\n\ndata.temporaryAddress.fullAddress | \nstring | \nComplete temporary address (if available) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| DL Basic | \n400–700 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid DL or Wrong Input | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Introduction
\nThe Driving License Verification API enables real-time validation of driving license (DL) details using the license number and date of birth. It returns license holder information such as name, address, issue/expiry dates, permitted vehicle classes, and more.
\nUse Cases
\n1. Digital KYC & Customer Onboarding : Instantly verify user identity using driving license details during account creation or registration.
\n2. Employee Background Verification : Used by HR and staffing agencies to validate driving credentials, especially for transport-related roles.
\n3. Vehicle Rentals & Ride-Sharing Platforms : Ensure drivers or customers have valid and active licenses before allowing access to vehicles.
\n4. Insurance Issuance & Claims : Verify license status and authenticity during policy issuance or motor claim settlements.
\n5. Fintech & Lending (Auto Loans) : Use DL verification as part of identity validation and risk profiling for loan processing
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/driving-license/verify | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (required in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
Request Body (JSON)
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nDriving License number | \nYes | \n
\n\n| dob | \nString | \nDate of Birth (YYYY-MM-DD) | \nYes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Body Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.client_id | \nstring | \nUnique identifier for the client request | \n
\n\ndata.license_number | \nstring | \nDriving license number | \n
\n\ndata.state | \nstring | \nState of issuance | \n
\n\ndata.name | \nstring | \nName of the license holder | \n
\n\ndata.permanent_address | \nstring | \nPermanent address of the license holder | \n
\n\ndata.permanent_zip | \nstring | \nZIP code for permanent address (if available) | \n
\n\ndata.city_name | \nstring/null | \nCity name (if available) | \n
\n\ndata.temporary_address | \nstring | \nTemporary address of the license holder | \n
\n\ndata.temporary_zip | \nstring | \nZIP code for temporary address (if available) | \n
\n\ndata.citizenship | \nstring | \nCitizenship (if available) | \n
\n\ndata.ola_name | \nstring | \nName of the RTO/office of licensing authority (if available) | \n
\n\ndata.ola_code | \nstring | \nCode of the licensing authority (if available) | \n
\n\ndata.gender | \nstring | \nGender of the license holder (M, F, X) | \n
\n\ndata.father_or_husband_name | \nstring | \nFather or husband’s name | \n
\n\ndata.dob | \nstring | \nDate of birth of the license holder (YYYY-MM-DD) | \n
\n\ndata.doe | \nstring | \nDate of expiry of the license (YYYY-MM-DD) | \n
\n\ndata.transport_doe | \nstring | \nExpiry date of transport license category (if applicable) | \n
\n\ndata.doi | \nstring | \nDate of issue of the license (YYYY-MM-DD) | \n
\n\ndata.transport_doi | \nstring | \nIssue date of transport license category (if applicable) | \n
\n\ndata.profile_image | \nstring (base64) | \nBase64 encoded profile photo of the license holder | \n
\n\ndata.has_image | \nboolean | \nIndicates if the profile image is available | \n
\n\ndata.blood_group | \nstring | \nBlood group (if available) | \n
\n\ndata.vehicle_classes | \narray | \nList of authorized vehicle classes | \n
\n\ndata.less_info | \nboolean | \nIndicates if partial data was returned | \n
\n\ndata.additional_check | \narray | \nAny additional validation checks performed (if any) | \n
\n\ndata.initial_doi | \nstring | \nInitial date of issue | \n
\n\ndata.current_status | \nstring/null | \nCurrent status of the license (e.g., Active, Suspended, etc.) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| DL Verify | \n300–1100 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid DL or Wrong Input | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure that both id_number and dob are correct and follow the required formats.
\nDL numbers must be valid and registered in the issuing authority’s system.
\nFor production use, ensure you're using the Live URL and a valid API key.
\n
\n","urlObject":{"path":["api","kyc","driving-license","verify"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"8a81893e-4b92-4b29-bb84-5db9e506b76d","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"TS026201XX00XX57\",\r\n \"dob\": \"2001-09-20\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/driving-license/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:28:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5651"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1613-ks8FPstSaJlRyAfbzp6sefFIobw\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:28:56.870Z\",\n \"transaction_id\": \"6b09ef83-9685-4947-ac59-ecdfad224999\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"license_fDbRynVtiGinwwubVjbn\",\n \"license_number\": \"TS02620190003657\",\n \"state\": \"Telangana\",\n \"name\": \"GUGULOTHU VENKANNA\",\n \"permanent_address\": \"H-NO 4-62, MARRIKUNTA THANDA, MARRIKUNTA THANDA, CHINNA NAGARAM VILLAGE\",\n \"permanent_zip\": \"\",\n \"city_name\": null,\n \"temporary_address\": \"H-NO 4-62, MARRIKUNTA THANDA, MARRIKUNTA THANDA, CHINNA NAGARAM VILLAGE\",\n \"temporary_zip\": \"\",\n \"citizenship\": \"\",\n \"ola_name\": \"\",\n \"ola_code\": \"\",\n \"gender\": \"X\",\n \"father_or_husband_name\": \"GUGULOTHU KISHAN\",\n \"dob\": \"1998-06-15\",\n \"doe\": \"2039-07-23\",\n \"transport_doe\": \"1800-01-01\",\n \"doi\": \"2019-07-24\",\n \"transport_doi\": \"1800-01-01\",\n \"profile_image\": \"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACmAHQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDqWbB60wscgA0pHrSd67jhbFzmkJxSE0gVn4VSxPYCgkQtTSasNZTxjdJGQp71JbaZcXnEaFWzj5iuD9CCRUOpFdTRUpvZGeW4qNjzmtQ6Q48zFxAWRtrDd0P+cU0aDdSSKoaIA55LgUe1h3H7GfYy93HWk3HvVy50e8t5ChjDY7ociqTxunJUjtyKpSi9mQ4SW6Dd370b8ioiaM1RBJvpNxqPdmgtSHcfuoqIPRQI2yTmmk5OMGnE0znoBTGIEeZvLj+8fWpJNQs9JZz57vJtwNgHGR/T1qO8vBpNg0qkG4kBVR6L3rihJLeTM2SATjcegrmq1G3ZHXRpK3NI3i9xqsqifUiuTgbzjbnoSR/hUdxOmlzvBbX32m2HzhwcENxkYPNY95fJE5WNue7A1ky3JLbs5rBI6LnRS+IbkyebHMVk2hWx0fHc+9Wh4ia6iG5ykmeqnFcY8x6g01bkq2c03FMadjsT4luGQxO5WRTw/v60yLxNO7mOcBiBjnoa5eSdpAHzlgOfcVFJM2FcHkdaSiNs7v7RDOFZDjcOlNJwa5fTr4yKUJwRyproYphKgf1Fb0pu/Kzkr01bmRPuppbmmM/oKaTzXQcZJn3oqLNFAHQM3HFPtgr3CBjgdSagY8URy7FlOeDGQR60paIuOskZWvSfb7kszEIik47L6ACucSTy0dUByf4s4FaF/cZjYISu4c98isKWU7CNxOK4U7np20K80i7iBk1XLe5pMMzcZqVbeRuApqrpByt7EWTSbc1ejsHPWrKWAB5rN1UjRUmzLQSA8dakaGQoTjrWutsgIOBV+GyWWPOBUOqX7GxyMMz28ox1zXV6XerNAF6YrndVtvs91gjg0/TVlWddjHZnmtYT+0YThvFnXk980mabJ91QQOnamE13Rd1c8uceV2JN1FQ7qKZB0LtxVa6uRb2cjFsM4wvr16ipGbiszUrVbyDYWZHXlWB6VM03HQ2ptKSuZM1wptiw5fng1nJE158qZznoBjmoUhmjucBznOMk4ru9N0SKwsxuXdKQSWPeuCbUUerCPMzm4dHWIZk61KYY04AFa9xEcnisufIPAxXJKTb1OuMUkQkimk0AZPNPZQKRRHmtCwY7sdqoO6IvJFPtdUtIJAsjgZPWnG7JloQ+JbFiVnVSQOuKydMZ1ukUdS1d6Y7e/syFZZI2GMjmuFELWmrmA8FJMCtqbs7HPUSaudGzZ4JNRk0hamlq9WOx4U37zHbj3oqMtRVE6HQu3B4qq5OKmkcAc1UeQYyORTRUjCvLcw6rbBQdk0ygfUkAivSvEN5aaNawrMw8xl4UdcVx80VvJ9gIuA119pjk8sD7g34GT3zjt7VX8eSGTXLmVnYBW2jJ4444/KvMrqPPY9fC8/s1dDLjxDbs33sVRk1aCU4DDNc7PaXX2ZLnymWJyQrvwGx1qGGCVVWY42n3rN042udCqSvY6jzxgN2qveX5jjLDrT7W3MloZHOAKoX0WEJBOK59Oax07q5lz6nPKSMkCmRHfhjKOtXLbyY4pElhDFxw/XH4GrOn5iilgwCs2BIdo+6Ow9D7108yS0OZxk2bvhe7SEmNWDK/XmofEERtfETSBNwlRZFH6f0plhaBbkGJdoJyBWj4tbZb6bc8bwzRn6Fc/wBKx5/e0NPZq1iH7fb3haOO28iaIfMFYlXHQnkkg5phNZtoS9+soPBhLN+PFXiQa9HCzlKL5jy8wpQhJcg8tRTN1FdR5xtPJmq7vTWfIqFn71SQmxrOv9u6aW4jEkJJ9cTAn9DXV+ItLiN89w4DZYkA1x80fnxOoBLgEpg85rprjWPt9pBOQMSxhiPQ9x+ea8nFwcZXPewNVTppdjndSheRXRD+6Y5KE/Ln1xVCx0SS6mAwAo/StRwXckjAJ4q/YyCNwij5jwAO9cimzu5ELNp8VtpJx2bFYrwxyREFRXTaspTS0UjDE8g9q5mPLZUEZ7UnuUtjOe0RW+XpUsMap1xUtyhglVXIyy5qEsOoodwSRoW0yrKm31qPxVcG4j0+1X7zOzfkAP61FbH5wSOlUtYmM2u2aKcbU4/H/wDVV01qZ1XZD9PGy2LEcHCqT3A/+uasbulI7/KiZB2LjioyTxzXr4eHLA8LG1VOrp0Ji1FRZorexyXNQv71ETmmlsUwvVGZIrlHDDqDmpLG6Bmu7QnlSZo/o3Ufn/Oqhes6+uHs7mO7ToF2N+tYYmkpwOvB1XCdu5ubzv5OAKfHdLCTKZArKcgk1n/b0l097mM5I7ehrkZb2V5GAZssc15MaTb1PedbTQ6mfxAk88xkusgnABB4rHu9ZSNhtkbrztxzWE6TyMVRDz1NR/YbhR82PzrT2UF1Eq07aI2f7b80mRslsYGTU9pqYmmVW4zXPi3Zerr9KakjQS88VXJB7EOc1ud3JMttHuLbRjrWAbo3esxuDnHSqN1qMtzAqu27aOKfowZrzcBnauTRSpWkRVqXidHupQ1Rb6N9eutjwJbk26iotwooEaTNUZamM9Rl/SmSSFveq91EtzbvE2ee49aUtTS3OKbV0NOzuYMlw9tA8OSW7j0FRabELuViWKntirerWZjja5jAwzbTz3rCiuJLZ96MQa8ypCzaPboTvFSZ1T6daIoKyvuxzziqbRWvIZiSPVqxrjU55l27jn2rMbzC2cnnvmsVTfVnX7aKWiOlP2cZworL1CaNnAXBIPNUBM6oRuP51FktgnPNVGnZ3uROqmtEXEfj0rUnSW00GG/gYrIk/JB52kY/mB+dZMKb3UdRW5dyq2iyWx6ED9Kc5WFTi27mlp14uqWRnQASx/61B/Me1S7q5jw3emy1OPJ+V/lYV09w0SXbQhwrHlVbjI9q66Ve2kjHE4B1Ye0pLXqh2aKZ8w42miui6PIdGonZxZcZs00tTWaiOOWd9sSM7egFWZqLbsg3U+KF5iDnahONx/zzUk0Men27T3RDOB8kangn3NZdldtcXwmnfJBwo6BfoK56mIS0iezg8nnUalW0X4lXxRdeRLFZwtlEXcxPdj/9YCucO94mlC5RTzjtWjr7mXVJWbuR+HFUtPm8m5ZTghuo9a4pTb1Z6eIoQhaEFZIqeZ82e2Oaa04NdBJpVncYZFKZ6hTxVaTR7dM7Q34mo9tHqc31eS2MLzMnmnwo8rgKCcVofYFD48vj61bjiWNQFAFDrJLQI0JN6jYoRGPem3Ux8sjPFPlY9KqXJxEaxvd3Z08qirIr2zFZFf0Oa6PWm8y3inGDgLyDyOK52FOB7V1KIt1aRwsMl4sZx37Vt0OvCxdmjMh1i4WMAoHx3JoqqiYGD60UXZqoy7noAsIYYmmvZ1VF4IU5GfTI6n2H50xtTRYiqL5FnGMkgct6DHqaxJ9Ze/nyqiQjhOoSMegqnNNsnl3yM5UYXPAHHYVc6sp7kYbCUMOv3a17jNT1me/dwihIxwAeuKpwSSRKJZmPP3E6Z96qxP8AvSCeDUm7zrjEjhT054qUVKXM7tk2tNv1GZgf4jWWTtlVx2PNampmN5wUbcNoyw9cVmkDpSZlWjdm3E5ChlPFSO5IzVGznUxKmcOvGD0NXcqByCPrXPOLRzp9CNskZFMCE1KSOxGKchB96jUuxVaIk5NU7khn8te3WtO5nit4/m5Y9FFZEZ3OzmtIRfUUUpOw9I8Cuis23QwSIwG0FfyrAUlhwMVBFPcKxxNIFB6BiBW17HWpqnayJmkO9vqaKYDuyT1NFK4ua5qJJsiAUY5zVS+lO/PqKKKo3npApLwwNSzcOrjvRRSOWOzJh8y4PcVVIwcDvRRQy5/ChoJVsjqK0YLh3jByeO1FFJHBiFoPaZgPup/3zTWllZfvbR3CjFFFOyOTmZQmBL49KlhXA2j8aKKT3PSwqVkK0ggQ4GT2JqqpwCaKKTNqvxJD1bAooopEpn//2Q==\",\n \"has_image\": true,\n \"blood_group\": \"\",\n \"vehicle_classes\": [\n \"Tractor\",\n \"MCWG\",\n \"LMV-NT\"\n ],\n \"less_info\": false,\n \"additional_check\": [],\n \"initial_doi\": \"2019-07-24\",\n \"current_status\": null\n }\n}"},{"id":"197c4f81-bc51-4245-ada8-1feab15a05ea","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"TS026201XX00XX54\",\r\n \"dob\": \"2001-07-20\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/driving-license/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:29:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"86-8mn9TAq/TesZreBCfsv3GOX0Tqs\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:29:24.904Z\",\n \"transaction_id\": \"48cbfedd-a3b9-4816-bdd3-77b342c2d56f\",\n \"status\": \"error\",\n \"error_message\": null\n}"}],"_postman_id":"be39b0b6-7a54-4893-b86e-f811c18d3960"}],"id":"cd0d8755-d95f-443b-ae03-7f825f3c7548","_postman_id":"cd0d8755-d95f-443b-ae03-7f825f3c7548","description":""},{"name":"Vehicle Registration - RC","item":[{"name":"RC Basic","id":"2a487043-5388-4e9e-8b7b-5b4192bf3641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"vehicle_number\": \"KAX9MX10XX\",\n \"remark\": \"Optional client note or reference\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/vehicle-registration/basic","description":"Vehicle Registration Basic ( Masked Data)
\nIntroduction
\nThe Vehicle Registration Basic Verification API enables businesses to validate vehicle registration details and access essential RC (Registration Certificate) information directly from official transport authority records.
\nThis API provides verified registration, ownership, insurance, and vehicle-related data sourced from the Ministry of Road Transport and Highways (MoRTH) database.
\nIt supports verification workflows across automobile finance, insurance, mobility, logistics, and KYC processes by confirming the authenticity and status of any Indian-registered vehicle.
\n
\nUse Cases
\n\nValidate authenticity and active status of a vehicle registration number.
\nRetrieve RC details such as owner name, registration date, and vehicle type.
\nVerify insurance, financer, and tax validity details.
\nAccess vehicle specifications including chassis number, engine number, and fuel type.
\nEnable onboarding, asset verification, and compliance use cases in lending, insurance, and fleet operations.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Live | \nhttps://live.finaxle.com/api/vehicle-registration/basic | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n| Accept | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\nJSON Example
\n{\n \"vehicle_number\": \"KA1XMXX0XX\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| vehicle_number | \nString | \nRegistered Vehicle Number | \nYes | \n
\n\n| remark | \nString | \nOptional client remark or tracking comment (logged only, not used in validation) | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.rc_regn_no | \nstring | \nVehicle registration number | \n
\n\n| data.rc_regn_dt | \nstring | \nRegistration date (DD-MMM-YYYY) | \n
\n\n| data.rc_regn_upto | \nstring | \nRegistration valid up to date | \n
\n\n| data.rc_purchase_dt | \nstring | \nPurchase date | \n
\n\n| data.rc_owner_name | \nstring | \nOwner name (masked from source) | \n
\n\n| data.rc_owner_sr | \nstring | \nOwner serial number (1 for primary owner) | \n
\n\n| data.rc_present_address | \nstring | \nRegistered present address (district and pincode) | \n
\n\n| data.rc_permanent_address | \nstring | \nRegistered permanent address (district and pincode) | \n
\n\n| data.rc_vch_catg | \nstring | \nVehicle category (e.g., LMV) | \n
\n\n| data.rc_vh_class_desc | \nstring | \nVehicle class description (e.g., Motor Car) | \n
\n\n| data.rc_chasi_no | \nstring | \nMasked chassis number | \n
\n\n| data.rc_eng_no | \nstring | \nMasked engine number | \n
\n\n| data.rc_maker_desc | \nstring | \nVehicle manufacturer name | \n
\n\n| data.rc_maker_model | \nstring | \nVehicle model name | \n
\n\n| data.rc_body_type_desc | \nstring | \nBody type description | \n
\n\n| data.rc_fuel_desc | \nstring | \nFuel type (e.g., PETROL, DIESEL, EV) | \n
\n\n| data.rc_color | \nstring | \nVehicle color | \n
\n\n| data.rc_norms_desc | \nstring | \nEmission norms (e.g., BS-VI) | \n
\n\n| data.rc_fit_upto | \nstring | \nFitness certificate valid up to date | \n
\n\n| data.rc_tax_upto | \nstring | \nRoad tax valid up to date | \n
\n\n| data.rc_financer | \nstring | \nFinancier/loan provider name | \n
\n\n| data.rc_insurance_comp | \nstring | \nInsurance company name | \n
\n\n| data.rc_insurance_policy_no | \nstring | \nInsurance policy number | \n
\n\n| data.rc_insurance_upto | \nstring | \nInsurance validity date | \n
\n\n| data.rc_manu_month_yr | \nstring | \nManufacturing month and year | \n
\n\n| data.rc_unld_wt | \nstring | \nUnladen weight (in kg) | \n
\n\n| data.rc_gvw | \nstring | \nGross Vehicle Weight (in kg) | \n
\n\n| data.rc_no_cyl | \nstring | \nNumber of cylinders | \n
\n\n| data.rc_cubic_cap | \nstring | \nEngine cubic capacity | \n
\n\n| data.rc_seat_cap | \nstring | \nSeating capacity | \n
\n\n| data.rc_stand_cap | \nstring | \nStanding capacity (for public transport vehicles) | \n
\n\n| data.rc_registered_at | \nstring | \nRTO name and state | \n
\n\n| data.rc_status_as_on | \nstring | \nStatus checked as on date | \n
\n\n| data.rc_status | \nstring | \nCurrent RC status (e.g., ACTIVE, CANCELLED) | \n
\n\n| data.rc_pucc_upto | \nstring | \nPollution Under Control (PUC) valid up to date | \n
\n\n| data.rc_pucc_no | \nstring | \nPUC certificate number | \n
\n\n| data.rc_own_catg_desc | \nstring | \nOwnership category (e.g., GENERAL) | \n
\n\n| data.rc_vch_catg_desc | \nstring | \nVehicle category description | \n
\n\n| data.rc_owner_cd_desc | \nstring | \nOwner type (e.g., INDIVIDUAL, COMPANY) | \n
\n\n| data.rc_sale_amt | \nstring | \nSale amount (if available) | \n
\n\n| data.state_cd | \nstring | \nState code of registration | \n
\n\n| data.rto_cd | \nstring | \nRTO code | \n
\n\n| data.api_response_message | \nstring | \nResponse message from the data source | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| RC Basic | \n300–600 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid RC | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Introduction
\nThe Vehicle Registration Verification API enables real-time validation of a vehicle’s registration details using the registration number. It returns comprehensive vehicle-related data including owner information, registration dates, insurance details, engine and chassis numbers, and technical specifications.
\nUse Cases
\n\nVehicle Loan Processing: Instantly validate vehicle details to streamline loan approvals.
\nInsurance Validation: Verify registration and insurance data during policy issuance and renewals.
\nFraud Prevention: Authenticate vehicle ownership to prevent fraudulent registrations or misuse.
\nVehicle Resale & Auctions: Access verified data before facilitating secondary sales or auctions.
\nFleet & Asset Management: Manage and track asset validity and compliance in real-time.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Live: https://uat.finaxle.com/api/kyc/vehicle-registration/verify | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (required in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body (JSON)
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| vehicle_number | \nString | \nVehicle registration number (e.g., UP65AV2XXX) | \nYes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Body Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\ndata.regNo | \nstring | \nVehicle registration number | \n
\n\ndata.chassis | \nstring | \nChassis number | \n
\n\ndata.engine | \nstring | \nEngine number | \n
\n\ndata.vehicleManufacturerName | \nstring | \nVehicle manufacturer name | \n
\n\ndata.model | \nstring | \nVehicle model | \n
\n\ndata.vehicleColour | \nstring | \nVehicle color | \n
\n\ndata.type | \nstring | \nFuel type | \n
\n\ndata.normsType | \nstring | \nEmission norms | \n
\n\ndata.bodyType | \nstring | \nVehicle body type | \n
\n\ndata.ownerCount | \nstring | \nNumber of owners till date | \n
\n\ndata.owner | \nstring | \nRegistered owner name | \n
\n\ndata.ownerFatherName | \nstring | \nOwner’s father’s name (if available) | \n
\n\ndata.mobileNumber | \nstring | \nRegistered mobile number (if available) | \n
\n\ndata.status | \nstring | \nFitness status | \n
\n\ndata.statusAsOn | \nstring | \nStatus valid as on date | \n
\n\ndata.regAuthority | \nstring | \nRegistration authority | \n
\n\ndata.regDate | \nstring | \nVehicle registration date | \n
\n\ndata.vehicleManufacturingMonthYear | \nstring | \nMonth & year of manufacturing | \n
\n\ndata.rcExpiryDate | \nstring | \nRC expiry date | \n
\n\ndata.vehicleTaxUpto | \nstring | \nVehicle tax paid up to | \n
\n\ndata.vehicleInsuranceCompanyName | \nstring | \nInsurance company name | \n
\n\ndata.vehicleInsuranceUpto | \nstring | \nInsurance validity up to | \n
\n\ndata.vehicleInsurancePolicyNumber | \nstring | \nInsurance policy number | \n
\n\ndata.rcFinancer | \nstring | \nFinancier/bank name | \n
\n\ndata.presentAddress | \nstring | \nPresent registered address | \n
\n\ndata.permanentAddress | \nstring | \nPermanent registered address | \n
\n\ndata.vehicleCubicCapacity | \nstring | \nCubic capacity (CC) | \n
\n\ndata.grossVehicleWeight | \nstring | \nGross vehicle weight | \n
\n\ndata.unladenWeight | \nstring | \nVehicle unladen weight | \n
\n\ndata.vehicleCategory | \nstring | \nVehicle category code | \n
\n\ndata.rcStandardCap | \nstring | \nStandard capacity (if available) | \n
\n\ndata.vehicleCylindersNo | \nstring | \nNumber of cylinders | \n
\n\ndata.vehicleSeatCapacity | \nstring | \nSeating capacity | \n
\n\ndata.vehicleSleeperCapacity | \nstring | \nSleeper capacity | \n
\n\ndata.vehicleStandingCapacity | \nstring | \nStanding capacity | \n
\n\ndata.wheelbase | \nstring | \nWheelbase in mm | \n
\n\ndata.vehicleNumber | \nstring | \nVehicle registration number (duplicate field) | \n
\n\ndata.puccNumber | \nstring | \nPollution certificate number | \n
\n\ndata.puccUpto | \nstring | \nValidity of pollution certificate | \n
\n\ndata.blacklistStatus | \nboolean | \nWhether vehicle is blacklisted | \n
\n\ndata.blacklistDetails | \narray | \nBlacklist details (if any) | \n
\n\ndata.permitIssueDate | \nstring | \nPermit issue date (if available) | \n
\n\ndata.permitNumber | \nstring | \nVehicle permit number | \n
\n\ndata.permitType | \nstring | \nPermit type | \n
\n\ndata.permitValidFrom | \nstring | \nPermit validity start date | \n
\n\ndata.permitValidUpto | \nstring | \nPermit validity end date | \n
\n\ndata.nonUseStatus | \nstring | \nNon-use status | \n
\n\ndata.nonUseFrom | \nstring | \nNon-use from date | \n
\n\ndata.nonUseTo | \nstring | \nNon-use to date | \n
\n\ndata.nationalPermitNumber | \nstring | \nNational permit number | \n
\n\ndata.nationalPermitUpto | \nstring | \nNational permit validity up to | \n
\n\ndata.nationalPermitIssuedBy | \nstring | \nNational permit issuing authority | \n
\n\ndata.isCommercial | \nboolean | \nWhether vehicle is commercial | \n
\n\ndata.nocDetails | \nstring | \nNOC details (if issued) | \n
\n\ndata.dbResult | \nboolean | \nDatabase result flag | \n
\n\ndata.partialData | \nboolean | \nWhether response contains partial data | \n
\n\ndata.mmvResponse | \nstring | \nMMV (Make-Model-Variant) response (if available) | \n
\n\ndata.financed | \nboolean | \nWhether vehicle is financed | \n
\n\ndata.class | \nstring | \nVehicle class | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| RC Verify | \n300–700 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid RC | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Vehicle Registration Comprehensive Verification API
\nIntroduction
\nThe Vehicle Registration Comprehensive Verification API enables businesses to verify a vehicle’s registration details using its registration number. It retrieves official transport authority data, including vehicle specifications, ownership history, registration validity, insurance details, and status.
\nThis API helps in vehicle ownership validation, loan underwriting, insurance processing, and fraud prevention workflows.
\n
\nUse Cases
\n\nVerify authenticity and validity of vehicle registration numbers.
\nRetrieve current and previous ownership details.
\nAccess registration, insurance, and PUCC validity dates.
\nConfirm vehicle make, model, class, and fuel type.
\nSupport KYC/KYV for lending, insurance, and mobility businesses.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| - Live | \nhttps://live.finaxle.com/api/kyc/vehicle-registration/comprehensive | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\nJSON Example
\n{\n \"vehicle_number\": \"RJ31CAXXXX\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\nvehicle_number | \nString | \nRegistered vehicle number (e.g., RJ31CAXXXX | \nYes | \n
\n\nremark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.rc_regn_no | \nstring | \nVehicle registration number | \n
\n\ndata.rc_regn_dt | \nstring | \nRegistration date | \n
\n\ndata.rc_regn_upto | \nstring | \nRegistration validity date | \n
\n\ndata.rc_purchase_dt | \nstring | \nVehicle purchase date | \n
\n\ndata.rc_owner_sr | \nstring | \nCurrent owner serial number | \n
\n\ndata.rc_owner_name | \nstring | \nName of the current vehicle owner | \n
\n\ndata.state_cd | \nstring | \nState code of registration | \n
\n\ndata.rto_cd | \nstring | \nRTO/DTO code of registration | \n
\n\ndata.rc_present_address | \nstring | \nOwner’s present address | \n
\n\ndata.rc_permanent_address | \nstring | \nOwner’s permanent address | \n
\n\ndata.rc_vch_catg | \nstring | \nVehicle category (e.g., LMV) | \n
\n\ndata.rc_vh_class_desc | \nstring | \nVehicle class description | \n
\n\ndata.rc_maker_desc | \nstring | \nManufacturer name | \n
\n\ndata.rc_maker_model | \nstring | \nVehicle model name | \n
\n\ndata.rc_body_type_desc | \nstring | \nBody type (e.g., Saloon) | \n
\n\ndata.rc_fuel_desc | \nstring | \nFuel type (e.g., Diesel, Petrol) | \n
\n\ndata.rc_color | \nstring | \nVehicle color | \n
\n\ndata.rc_fit_upto | \nstring | \nFitness certificate validity date | \n
\n\ndata.rc_insurance_comp | \nstring | \nInsurance company name | \n
\n\ndata.rc_insurance_policy_no | \nstring | \nInsurance policy number | \n
\n\ndata.rc_insurance_upto | \nstring | \nInsurance validity date | \n
\n\ndata.rc_manu_month_yr | \nstring | \nMonth and year of manufacture | \n
\n\ndata.rc_unld_wt | \nstring | \nUnladen weight (in kg) | \n
\n\ndata.rc_gvw | \nstring | \nGross vehicle weight (in kg) | \n
\n\ndata.rc_no_cyl | \nstring | \nNumber of engine cylinders | \n
\n\ndata.rc_cubic_cap | \nstring | \nEngine cubic capacity (CC) | \n
\n\ndata.rc_seat_cap | \nstring | \nSeating capacity | \n
\n\ndata.rc_registered_at | \nstring | \nRegistered RTO/DTO name | \n
\n\ndata.rc_status | \nstring | \nVehicle registration status (e.g., ACTIVE) | \n
\n\ndata.rc_status_as_on | \nstring | \nDate as of which the status is reported | \n
\n\ndata.rc_pucc_no | \nstring | \nPollution certificate number | \n
\n\ndata.rc_pucc_upto | \nstring | \nPUCC validity date | \n
\n\ndata.rc_owner_history | \narray | \nList of previous owners with names and RTO codes | \n
\n\ndata.rc_blacklist_status | \nstring | \nBlacklist status (if any) | \n
\n\ndata.rc_ncrb_status | \nstring | \nNCRB (crime/theft) status | \n
\n\ndata.rc_noc_details | \nstring | \nNOC (No Objection Certificate) details, if applicable | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| RC Comprehensive | \n300–900 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid RC | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Introduction
\nThe Vehicle Registration Advance Verification API enables businesses to fetch and verify detailed vehicle registration information using the vehicle’s registration number.
\nIt retrieves official transport authority data, including ownership details, vehicle specifications, insurance information, registration validity, and emission (PUCC) status.
\nThis API supports diverse use cases across lending, insurance, fleet management, and fraud detection, enabling instant validation of vehicle ownership and registration authenticity.
\n
\nUse Cases
\n\nValidate authenticity and validity of vehicle registration numbers.
\nRetrieve complete vehicle specifications and ownership information.
\nVerify insurance and PUCC validity for compliance or underwriting.
\nSupport KYC/KYV for lending, insurance, and mobility businesses.
\nDetect potential fraud using blacklist and NOC status indicators.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Environment (LIVE) | \nhttps://live.finaxle.com/api/kyc/vehicle-registration/advance | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\nAuthorization | \nBearer YOUR_BEARER_TOKEN | \nYes | \n
\n\nContent-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\nJSON Example
\n{\n \"vehicle_number\": \"DLXXXF57XX\",\n \"remark\": \"Optional client note or reference\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\nvehicle_number | \nString | \nRegistered vehicle number (e.g., DL8SBF57XX) | \nYes | \n
\n\nremark | \nString | \nOptional field for client remarks or references. Logged but not used in verification logic. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.regNo | \nString | \nVehicle registration number | \n
\n\ndata.chassis | \nString | \nVehicle chassis number | \n
\n\ndata.engine | \nString | \nVehicle engine number | \n
\n\ndata.vehicleManufacturerName | \nString | \nVehicle manufacturer’s name | \n
\n\ndata.model | \nString | \nModel name of the vehicle | \n
\n\ndata.vehicleColour | \nString | \nRegistered color of the vehicle | \n
\n\ndata.type | \nString | \nFuel type (e.g., Petrol, Diesel, Electric) | \n
\n\ndata.normsType | \nString | \nEmission standard (e.g., BS-IV, BS-VI) | \n
\n\ndata.bodyType | \nString | \nVehicle body type | \n
\n\ndata.ownerCount | \nString | \nNumber of previous owners | \n
\n\ndata.owner | \nString | \nCurrent owner’s name | \n
\n\ndata.status | \nString | \nVehicle registration status (e.g., ACTIVE) | \n
\n\ndata.statusAsOn | \nString | \nDate as of which the registration status is valid | \n
\n\ndata.regAuthority | \nString | \nRTO or registration authority name | \n
\n\ndata.regDate | \nString | \nRegistration date | \n
\n\ndata.vehicleManufacturingMonthYear | \nString | \nVehicle manufacturing month and year | \n
\n\ndata.rcExpiryDate | \nString | \nRC validity date | \n
\n\ndata.vehicleTaxUpto | \nString | \nVehicle tax validity date | \n
\n\ndata.vehicleInsuranceCompanyName | \nString | \nName of the insurance company | \n
\n\ndata.vehicleInsuranceUpto | \nString | \nInsurance policy validity date | \n
\n\ndata.vehicleInsurancePolicyNumber | \nString | \nInsurance policy number | \n
\n\ndata.presentAddress | \nString | \nOwner’s present address | \n
\n\ndata.permanentAddress | \nString | \nOwner’s permanent address | \n
\n\ndata.vehicleCubicCapacity | \nString | \nEngine capacity (in CC) | \n
\n\ndata.grossVehicleWeight | \nString | \nGross vehicle weight (in kg) | \n
\n\ndata.unladenWeight | \nString | \nUnladen vehicle weight (in kg) | \n
\n\ndata.vehicleCategory | \nString | \nVehicle category (e.g., 2WN, LMV) | \n
\n\ndata.vehicleCylindersNo | \nString | \nNumber of cylinders | \n
\n\ndata.vehicleSeatCapacity | \nString | \nSeating capacity | \n
\n\ndata.wheelbase | \nString | \nWheelbase length (in mm) | \n
\n\ndata.puccNumber | \nString | \nPollution Under Control Certificate (PUCC) number | \n
\n\ndata.puccUpto | \nString | \nPUCC validity date | \n
\n\ndata.blacklistStatus | \nBoolean | \nIndicates if the vehicle is blacklisted | \n
\n\ndata.blacklistDetails | \nArray | \nDetails of blacklist status, if applicable | \n
\n\ndata.isCommercial | \nBoolean | \nWhether vehicle is commercial | \n
\n\ndata.financed | \nBoolean | \nWhether the vehicle is under finance/loan | \n
\n\ndata.class | \nString | \nVehicle class/type | \n
\n\ndata.ownerHistory | \nObject | \nHistorical ownership details (name, RTO, state) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Vehicle Registration Advance | \n300–900 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid RC | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Introduction
\nThe RC Reverse KYC API allows you to fetch vehicle registration and owner details by providing the chassis number. It is useful in vehicle verification workflows for KYC, insurance, loan processing, and fraud detection.
\n
\nUse Cases
\n\nVehicle Verification: Validate vehicle and owner details using chassis number.
\nLoan Processing: Prefill accurate RC data during vehicle loan onboarding.
\nFraud Prevention: Detect mismatches between declared and registered vehicle data.
\nOwnership Tracing: Retrieve historical and current RC holder details.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/rc/reverse | \n
\n\n| Method | \nPOST | \n
\n\n| Auth | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| engine_number | \nString | \nEngine Number | \n
\n\n| chassis_number | \nString | \nVehicle Chassis Number | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.reg_no | \nString | \nVehicle registration number | \n
\n\ndata.vehicle_class | \nString | \nVehicle class | \n
\n\ndata.chassis | \nString | \nChassis number | \n
\n\ndata.engine | \nString | \nEngine number | \n
\n\ndata.vehicle_manufacturer_name | \nString | \nManufacturer name | \n
\n\ndata.model | \nString | \nVehicle model | \n
\n\ndata.vehicle_colour | \nString | \nVehicle color | \n
\n\ndata.type | \nString | \nFuel type | \n
\n\ndata.norms_type | \nString | \nEmission norms | \n
\n\ndata.body_type | \nString | \nBody type | \n
\n\ndata.owner_count | \nString | \nNumber of owners | \n
\n\ndata.owner | \nString | \nRegistered owner name | \n
\n\ndata.owner_father_name | \nString | \nFather's name (if available) | \n
\n\ndata.mobile_number | \nString / null | \nRegistered mobile number | \n
\n\ndata.status | \nString | \nVehicle registration status | \n
\n\ndata.status_as_on | \nString | \nStatus date | \n
\n\ndata.reg_authority | \nString | \nRegistering authority | \n
\n\ndata.reg_date | \nString | \nRegistration date | \n
\n\ndata.vehicle_manufacturing_month_year | \nString | \nManufacturing month/year | \n
\n\ndata.rc_expiry_date | \nString | \nRC valid until | \n
\n\ndata.vehicle_tax_upto | \nString | \nTax validity | \n
\n\ndata.vehicle_insurance_company_name | \nString | \nInsurance company name | \n
\n\ndata.vehicle_insurance_upto | \nString | \nInsurance validity | \n
\n\ndata.vehicle_insurance_policy_number | \nString | \nPolicy number | \n
\n\ndata.rc_financer | \nString | \nFinancer info | \n
\n\ndata.present_address | \nString | \nPresent address | \n
\n\ndata.permanent_address | \nString | \nPermanent address | \n
\n\ndata.vehicle_cubic_capacity | \nString | \nCubic capacity | \n
\n\ndata.gross_vehicle_weight | \nString | \nGross weight | \n
\n\ndata.unladen_weight | \nString | \nUnladen weight | \n
\n\ndata.vehicle_category | \nString | \nVehicle category | \n
\n\ndata.rc_standard_cap | \nString | \nStandard capacity | \n
\n\ndata.vehicle_cylinders_no | \nString | \nNumber of cylinders | \n
\n\ndata.vehicle_seat_capacity | \nString | \nSeat capacity | \n
\n\ndata.vehicle_sleeper_capacity | \nString | \nSleeper capacity | \n
\n\ndata.vehicle_standing_capacity | \nString | \nStanding capacity | \n
\n\ndata.wheelbase | \nString | \nWheelbase | \n
\n\ndata.vehicle_number | \nString | \nVehicle number | \n
\n\ndata.pucc_number | \nString | \nPollution certificate number | \n
\n\ndata.pucc_upto | \nString | \nPUCC validity date | \n
\n\ndata.blacklist_status | \nString | \nBlacklisting status | \n
\n\ndata.blacklist_details | \nArray | \nBlacklist details | \n
\n\ndata.permit_issue_date | \nString / null | \nPermit issue date | \n
\n\ndata.permit_number | \nString / null | \nPermit number | \n
\n\ndata.permit_type | \nString / null | \nType of permit | \n
\n\ndata.permit_valid_from | \nString / null | \nPermit valid from | \n
\n\ndata.permit_valid_upto | \nString / null | \nPermit valid upto | \n
\n\ndata.non_use_status | \nString | \nNon-use status | \n
\n\ndata.non_use_from | \nString / null | \nNon-use from date | \n
\n\ndata.non_use_to | \nString / null | \nNon-use to date | \n
\n\ndata.national_permit_number | \nString / null | \nNational permit number | \n
\n\ndata.national_permit_upto | \nString / null | \nNational permit validity | \n
\n\ndata.national_permit_issued_by | \nString / null | \nIssuing authority | \n
\n\ndata.is_commercial | \nBoolean | \nCommercial vehicle status | \n
\n\ndata.noc_details | \nString | \nNOC status/details | \n
\n\ndata.db_result | \nBoolean | \nIs data DB sourced | \n
\n\ndata.partial_data | \nBoolean | \nIndicates if data is partial | \n
\n\ndata.mmv_response | \nObject / null | \nRaw MMV response if applicable | \n
\n\ndata.financed | \nBoolean | \nIndicates if vehicle is financed | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| RC Reverse KYC | \n600–1200 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nInvalid RC | \nUnprocessable Entity | \nNO | \n
\n\n| 400 | \nBad Request | \nInvalid or missing Input | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on server. Check logs or retry later | \nNO | \n
\n\n
\n
Description
\nThis API is used to initialize the Digilocker KYC flow. It generates a secure session with a unique transaction token and returns a url that redirects the user to the Digilocker consent and document retrieval page.
\nThe session will expire after the specified expiry_minutes.
\n
\nRequest
\n\n\n\n\n| Key | \nValue | \nRequired | \nDescription | \n
\n\n\n\n| Content-Type | \napplication/json | \nYes | \nRequest body must be in JSON format | \n
\n\n
\n
Body (JSON)
\n\n\n\n| Field | \nType | \nRequired | \nDescription | \n
\n\n\n\n| signup_flow | \nboolean | \nYes | \nIndicates if the flow is for Digilocker sign-up (true) or fetching existing documents (false). | \n
\n\n| redirect_url | \nstring | \nYes | \nURL where the user will be redirected after completing the Digilocker flow. | \n
\n\n| expiry_minutes | \nnumber | \nYes | \nDuration (in minutes) after which the session will expire. | \n
\n\n| remark | \nstring | \nNo | \nOptional field for client-side tracking or remarks. | \n
\n\n
\n
Example Request
\n{\n \"signup_flow\": false,\n \"redirect_url\": \"https://Finaxle.tech\",\n \"expiry_minutes\": 20,\n \"remark\": \"Optional Field\"\n}\n\n
\n
\nResponse
\nSuccess Response (200 OK)
\n{\n \"timestamp\": \"2025-09-10T08:35:01.629Z\",\n \"transaction_id\": \"TXN-4770b978-d8f2-432b-be5b-558ae5fbabed\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"digilocker_fOolddpdihfeCQvyLpUq\",\n \"token\": \".eJyrVkrOyUzNK4nPTFGyUkrJTM_MyU_OTi2KT_PPz0lJKUjJzEhLdQ4sq_QpCC1U0lFKTyxJLU-sBKotKMpPKU0uyczPAwqXVBakouhXqgUA3HEgow.aME4Ng.wwbeJD7qAbydb3aD_W9ocuSZyB8\",\n \"url\": \"https://digilocker-sdk.notbot.in/?gateway=production&type=digilocker&token=.eJyrVkrOyUzNK4nPTFGyUkrJTM_MyU_OTi2KT_PPz0lJKUjJzEhLdQ4sq_QpCC1U0lFKTyxJLU-sBKotKMpPKU0uyczPAwqXVBakouhXqgUA3HEgow.aME4Ng.wwbeJD7qAbydb3aD_W9ocuSZyB8&auth_type=web\",\n \"expiry_seconds\": 1200\n }\n}\n\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data.client_id | \nstring | \nUnique client session ID for Digilocker flow. | \n
\n\n| data.token | \nstring | \nSecure session token used for Digilocker authentication. | \n
\n\n| data.url | \nstring | \nURL to redirect the user to complete Digilocker authentication and document access. | \n
\n\n| data.expiry_seconds | \nnumber | \nSession validity in seconds (derived from expiry_minutes). | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Digilocker Initialize | \n300–800 ms | \n
\n\n
\n
\nError Handling
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n| 200 | \nSuccessful | \n
\n\n| 400 | \nBad Request or Missing Inputs | \n
\n\n| 422 | \nValidation error | \n
\n\n| 500 | \nInternal server error | \n
\n\n
\n
\n⚡ Usage Tip:
\n\nUse the returned url to redirect the user to Digilocker.
\nTrack transaction_id for debugging and reconciliation.
\nEnsure expiry_minutes is sufficient for the user journey (recommended: 15–30 minutes).
\n
\n","urlObject":{"path":["api","kyc","digilocker","initialize"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"8b546bb5-a7d0-4656-8f01-70a5ecaef47d","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"signup_flow\":false,\n \"redirect_url\":\"https://Finaxle.tech\",\n \"expiry_minutes\":20,\n \"remark\" :\"Optional Field\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/digilocker/initialize"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 10 Sep 2025 08:35:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"605"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"25d-6E0nWZbsyNwrHJf2bk1f/+Y+gkM\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-10T08:35:01.629Z\",\n \"transaction_id\": \"TXN-4770b978-d8f2-432b-be5b-558ae5fbabed\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"digilocker_fOolddpdihfeCQvyLpUq\",\n \"token\": \".eJyrVkrOyUzNK4nPTFGyUkrJTM_MyU_OTi2KT_PPz0lJKUjJzEhLdQ4sq_QpCC1U0lFKTyxJLU-sBKotKMpPKU0uyczPAwqXVBakouhXqgUA3HEgow.aME4Ng.wwbeJD7qAbydb3aD_W9ocuSZyB8\",\n \"url\": \"https://digilocker-sdk.notbot.in/?gateway=production&type=digilocker&token=.eJyrVkrOyUzNK4nPTFGyUkrJTM_MyU_OTi2KT_PPz0lJKUjJzEhLdQ4sq_QpCC1U0lFKTyxJLU-sBKotKMpPKU0uyczPAwqXVBakouhXqgUA3HEgow.aME4Ng.wwbeJD7qAbydb3aD_W9ocuSZyB8&auth_type=web\",\n \"expiry_seconds\": 1200\n }\n}"},{"id":"e9404cc3-27d6-4dc4-8b36-7f569c4260ee","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"signup_flow\":,\n \"redirect_url\":\"https://Finaxle.tech\",\n \"expiry_minutes\":20,\n \"remark\" :\"Optional Field\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/digilocker/initialize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unexpected token , in JSON at position 20\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"213f0cb1-18ca-4de0-8b5b-f3822ea812c8"},{"name":"Check Status","id":"53cb34e0-f011-4cdb-8a4d-bd86b0195524","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://live.finaxle.com/api/kyc/digilocker/status?client_id={{client_id}}&remark=Optional client note or reference","description":"Description
\nThis API is used to check the current status of a Digilocker session initialized using the initialize API.
\nIt returns whether the flow is completed, failed, or still in progress, along with additional flags such as Aadhaar linkage and error information.
\n
\nRequest
\nQuery Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nstring | \nYes | \nThe unique client session ID received from the initialize API. | \n
\n\n| remark | \nstring | \nNo | \nOptional field for client-side notes or references. | \n
\n\n
\n
Example Request
\nGET https://uat.finaxle.com/api/kyc/digilocker/status?client_id={{client_id}}&remark=Optional client note or reference\n\n
\n
\nResponse
\nSuccess Response (200 OK)
\n{\n \"timestamp\": \"2025-09-10T08:44:56.690Z\",\n \"transaction_id\": \"TXN-690f6932-c41d-4b53-ab35-421abcdcf37b\",\n \"status\": \"success\",\n \"data\": {\n \"error_description\": null,\n \"status\": \"completed\",\n \"completed\": true,\n \"failed\": false,\n \"error_count\": 0,\n \"aadhaar_linked\": true\n }\n}\n\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data.error_description | \nstring | \nDetails of the error if the request failed, otherwise null. | \n
\n\n| data.status | \nstring | \nCurrent Digilocker flow status: client_initiated, completed, or oauth_failed. | \n
\n\n| data.completed | \nboolean | \ntrue if the flow was successfully completed. | \n
\n\n| data.failed | \nboolean | \ntrue if the flow failed. | \n
\n\n| data.error_count | \nnumber | \nNumber of errors encountered during the flow. | \n
\n\n| data.aadhaar_linked | \nboolean | \nIndicates if Aadhaar was linked successfully in the Digilocker flow. | \n
\n\n
\n
\nStatus Handling Tips
\n\nTypical status flow: client_initiated → completed or oauth_failed.
\nAlways check completed and oauth_failed booleans for final state.
\nIf aadhaar_linked = true, you can safely call the Aadhaar XML retrieval endpoint.
\nIf failed = true, log the error_description and report to support.
\nUse exponential backoff polling when checking status (avoid aggressive polling).
\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Digilocker Check Status | \n300–700 ms | \n
\n\n
\n
\nError Handling
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n| 200 | \nSuccessful | \n
\n\n| 400 | \nInvalid or missing client_id | \n
\n\n| 422 | \nValidation error | \n
\n\n| 500 | \nInternal server error | \n
\n\n
\n
\n⚡ Usage Tip:
\nUse this API in a loop (with backoff) until the status changes to either completed or failed.
\n","urlObject":{"path":["api","kyc","digilocker","status"],"host":["https://live.finaxle.com"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"remark","value":"Optional client note or reference"}],"variable":[]}},"response":[{"id":"404a6a80-5b3e-4cba-bef9-29a4cba77a59","name":"Access Granted (200)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://live.finaxle.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.finaxle.com"],"path":["api","kyc","digilocker","status"],"query":[{"key":"client_id","value":"{{client_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 10 Sep 2025 08:44:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"244"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"f4-lLdmZcn208tbp/8wPd5KR9W5u/k\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-10T08:44:56.690Z\",\n \"transaction_id\": \"TXN-690f6932-c41d-4b53-ab35-421abcdcf37b\",\n \"status\": \"success\",\n \"data\": {\n \"error_description\": null,\n \"status\": \"completed\",\n \"completed\": true,\n \"failed\": false,\n \"error_count\": 0,\n \"aadhaar_linked\": true\n }\n}"},{"id":"bce288e4-980c-4da1-a9e7-b389869ac532","name":"Access Denied (200)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://live.finaxle.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.finaxle.com"],"path":["api","kyc","digilocker","status"],"query":[{"key":"client_id","value":"{{client_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 10 Sep 2025 08:04:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"120-Mk3RunD2Adkjqt69y3cYOk+GgnE\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-10T08:04:44.851Z\",\n \"transaction_id\": \"TXN-fc9a8a7e-7769-415b-b873-3a9617d6d13b\",\n \"status\": \"success\",\n \"data\": {\n \"error_description\": \"The user denied access to your application\",\n \"status\": \"oauth_failed\",\n \"completed\": false,\n \"failed\": true,\n \"error_count\": 0,\n \"aadhaar_linked\": false\n }\n}"},{"id":"95a11b68-8588-43b8-aa1b-a79cbf7b59e1","name":"Client Initiated (200)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://live.finaxle.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.finaxle.com"],"path":["api","kyc","digilocker","status"],"query":[{"key":"client_id","value":"{{client_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 10 Sep 2025 08:06:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"253"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"fd-Tv7YL3QqNckTfPq59Go7q9vyywM\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-10T08:06:23.990Z\",\n \"transaction_id\": \"TXN-d97ba809-5380-4e61-b430-b0bdd3d3544f\",\n \"status\": \"success\",\n \"data\": {\n \"error_description\": null,\n \"status\": \"client_initiated\",\n \"completed\": false,\n \"failed\": false,\n \"error_count\": 0,\n \"aadhaar_linked\": false\n }\n}"}],"_postman_id":"53cb34e0-f011-4cdb-8a4d-bd86b0195524"},{"name":"Check Aadhar XML","id":"d54afe6c-9409-40fb-a320-4ba5ad619db3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"YOUR_BEARER_TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://live.finaxle.com/api/kyc/digilocker/aadhar-xml?client_id={{client_id}}&remark=Optional client note or reference","description":"Description
\nThis API retrieves the Aadhaar XML data and metadata after successful Digilocker consent.
\nIt provides parsed Aadhaar information such as name, DOB, gender, address, masked Aadhaar, and profile image along with a signed xml_url for downloading the official XML file.
\n
\nRequest
\nQuery Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nstring | \nYes | \nThe unique client session ID received from the initialize API. | \n
\n\n| remark | \nstring | \nNo | \nOptional field for client-side notes or references. | \n
\n\n
\n
Example Request
\nGET https://uat.finaxle.com/api/kyc/digilocker/aadhar-xml?client_id={{client_id}}&remark=Optional client note or reference\n\n
\nResponse
\nSuccess Response (200 OK)
\n{\n \"timestamp\": \"2025-09-10T08:45:24.554Z\",\n \"transaction_id\": \"TXN-9c31bdfb-9fc8-4629-b62f-f4ad18e320ee\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"digilocker_tRLuRageoutAscrbKXlN\",\n \"digilocker_metadata\": {\n \"name\": \"AMAN SHARMA\",\n \"gender\": \"M\",\n \"dob\": \"1990-11-20\"\n },\n \"aadhaar_xml_data\": {\n \"full_name\": \"Aman Sharma\",\n \"care_of\": \"S/O Rohin Singh\",\n \"dob\": \"1990-11-20\",\n \"yob\": \"1990\",\n \"zip\": \"149164\",\n \"profile_image\": \"<Base64 string>\",\n \"gender\": \"M\",\n \"masked_aadhaar\": \"XXXXXXXX1627\",\n \"full_address\": \"123, Green Park, Near Metro Station, New Delhi South Delhi Delhi India\",\n \"father_name\": \"S/O Rohin Singh\",\n \"address\": {\n \"country\": \"India\",\n \"dist\": \"Delhi\",\n \"state\": \"Delhi\",\n \"po\": \"South Delhi\",\n \"house\": \"12\",\n \"loc\": \"123, Green Park, Near Metro Station,\",\n \"vtc\": \"South Delhi\",\n \"subdist\": \"South Delhi\",\n \"street\": \".\",\n \"landmark\": \".\"\n }\n },\n \"xml_url\": \"https://aadhaar-kyc-docs.s3.amazonaws.com/Finaxleapp/digilocker/digilocker_tR-...&X-Amz-Signature=...\"\n \"auid\": \"6fa8e2f3ed067c11\"\n }\n}\n\n
\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data.client_id | \nstring | \nClient session ID linked with the Digilocker request. | \n
\n\n| data.digilocker_metadata.name | \nstring | \nName as returned by Digilocker metadata. | \n
\n\n| data.digilocker_metadata.gender | \nstring | \nGender (M/F/O). | \n
\n\n| data.digilocker_metadata.dob | \nstring | \nDate of birth (YYYY-MM-DD). | \n
\n\n| data.aadhaar_xml_data.full_name | \nstring | \nFull name as per Aadhaar. | \n
\n\n| data.aadhaar_xml_data.care_of | \nstring | \nCare-of (Father/Guardian/Spouse) details. | \n
\n\n| data.aadhaar_xml_data.dob | \nstring | \nDate of birth (YYYY-MM-DD). | \n
\n\n| data.aadhaar_xml_data.yob | \nstring | \nYear of birth. | \n
\n\n| data.aadhaar_xml_data.zip | \nstring | \nPincode/ZIP code. | \n
\n\n| data.aadhaar_xml_data.profile_image | \nstring | \nBase64-encoded Aadhaar profile photo. | \n
\n\n| data.aadhaar_xml_data.gender | \nstring | \nGender (M/F/O). | \n
\n\n| data.aadhaar_xml_data.masked_aadhaar | \nstring | \nMasked Aadhaar number (last 4 digits visible). | \n
\n\n| data.aadhaar_xml_data.full_address | \nstring | \nComplete concatenated Aadhaar address. | \n
\n\n| data.aadhaar_xml_data.father_name | \nstring | \nFather’s name (if available). | \n
\n\n| data.aadhaar_xml_data.address | \nobject | \nStructured Aadhaar address object (country, state, district, sub-district, locality, etc.). | \n
\n\n| data.xml_url | \nstring | \nPre-signed AWS S3 URL to download the official Aadhaar XML file (expires after defined TTL). | \n
\n\n| auid | \nstring | \nUnique Aadhaar Identifier | \n
\n\n
\n
\nStatus Handling Tips
\n\nEnsure you call this API only after status API shows completed and aadhaar_linked = true.
\nUse xml_url if you require the raw signed XML for compliance or archival.
\nUse aadhaar_xml_data object for parsed Aadhaar data in structured JSON format.
\nHandle profile_image as a Base64 string → Convert to image file when needed.
\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Digilocker Check Aadhaar XML | \n300–1100 ms | \n
\n\n
\n
Status Code
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n| 200 | \nSuccessful | \n
\n\n| 422 | \nAccess Denied Or Access Pending | \n
\n\n| 500 | \nInternal server error | \n
\n\n
\n
Description
\nThis API retrieves a list of all documents available in the user’s Digilocker account after successful consent.
\nEach entry includes the file ID, document type, issuer, and download status, which can be used to fetch or validate documents individually.
\n
\nRequest
\nQuery Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nstring | \nYes | \nUnique client session ID generated from the initialize API. | \n
\n\n| remark | \nstring | \nNo | \nOptional field for client-side notes or references. | \n
\n\n
\n
Example Request
\nGET https://uat.finaxle.com/api/kyc/digilocker/list-documents?client_id={{client_id}}&remark=Optional client note or reference\n\n
\n
\nResponse
\nSuccess Response (200 OK)
\n{\n \"timestamp\": \"2025-09-10T05:05:32.983Z\",\n \"transaction_id\": \"TXN-034c3873-b9f8-4323-abc5-d9773571bd6f\",\n \"status\": \"success\",\n \"data\": [\n {\n \"file_id\": \"digilocker_file_fhoSjiqttsyQepcQq\",\n \"name\": \"Aadhaar Card\",\n \"doc_type\": \"ADHAR\",\n \"downloaded\": true,\n \"issuer\": \"Unique Identification Authority of India (UIDAI)\",\n \"description\": \"Aadhaar Card\"\n },\n {\n \"file_id\": \"digilocker_file_EmhXxbbfctisaOkiyrgp\",\n \"name\": \"Class XII Passing Certificate\",\n \"doc_type\": \"HPCER\",\n \"downloaded\": true,\n \"issuer\": \"Central Board of Secondary Education\",\n \"description\": \"Class XII Passing Certificate\"\n },\n {\n \"file_id\": \"aadhaar\",\n \"name\": \"Aadhaar Card\",\n \"doc_type\": \"ADHAR\",\n \"downloaded\": true,\n \"issuer\": \"Unique Identification Authority of India (UIDAI)\",\n \"description\": \"Aadhaar Card\"\n }\n ]\n}\n\n
\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data | \narray | \nArray of available Digilocker documents. | \n
\n\n| data[].file_id | \nstring | \nUnique identifier for the document file (used for download). | \n
\n\n| data[].name | \nstring | \nName of the document (e.g., Aadhaar Card, Passing Certificate). | \n
\n\n| data[].doc_type | \nstring | \nDocument type code as defined by Digilocker (e.g., ADHAR, HPCER). | \n
\n\n| data[].downloaded | \nboolean | \nWhether the document has been successfully fetched/downloaded. | \n
\n\n| data[].issuer | \nstring | \nIssuing authority of the document. | \n
\n\n| data[].description | \nstring | \nShort description of the document. | \n
\n\n
\n
\nUsage Notes
\n\nUse the file_id to fetch/download the actual document via the download-document API.
\ndownloaded = true indicates the document is already fetched once; however, it can still be re-downloaded.
\nSome documents may appear multiple times (e.g., Aadhaar card in different categories).
\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Digilocker List Documents | \n400–900 ms | \n
\n\n
\n
Error Handling
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n| 200 | \nSuccessful | \n
\n\n| 422 | \nAccess Denied or Access Pending | \n
\n\n| 500 | \nInternal server error. | \n
\n\n
\n
Description
\nThis API downloads a specific document from the user’s Digilocker account using the provided file_id.
\nIt returns a pre-signed S3 download URL along with the document MIME type (e.g., application/pdf).
\n
\nRequest
\nQuery Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nstring | \nYes | \nUnique client session ID generated from the initialize API. | \n
\n\n| file_id | \nstring | \nYes | \nThe document identifier received from the list-documents API. | \n
\n\n| remark | \nstring | \nNo | \nOptional field for client-side notes or references. | \n
\n\n
\n
Example Request
\nGET https://uat.finaxle.com/api/kyc/digilocker/document?client_id={{client_id}}&file_id={{file_id}}&remark=Optional client note or reference\n\n
\nResponse
\nSuccess Response (200 OK)
\n{\n \"timestamp\": \"2025-09-10T08:46:35.339Z\",\n \"transaction_id\": \"TXN-181d3e1e-b414-4f62-a48a-be9540200541\",\n \"status\": \"success\",\n \"data\": {\n \"download_url\": \"https://aadhaar-kyc-docs.s3.amazonaws.com/Finaxleapp/digilocker/digilocker_tRLuRageoutAscrbKXlN/aadhaar_1757493995065253.pdf?response-content-type=ap600&X-Amz-SignedHeaders=host&X-Amz-Signature=6f4acfc9e2ac4510d01b9ce37d8369c59250d94f66b4b09ed48236b8dfd59610\",\n \"mime_type\": \"application/pdf\"\n }\n}\n\n
\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data.download_url | \nstring | \nPre-signed AWS S3 URL to download the requested document. | \n
\n\n| data.mime_type | \nstring | \nMIME type of the document (e.g., application/pdf, image/jpeg). | \n
\n\n
\n
\nUsage Notes
\n\nUse the file_id obtained from the List Documents API to fetch the desired document.
\nThe download_url is a time-limited pre-signed URL; download the file before expiry.
\nRespect the MIME type to handle file rendering (e.g., open PDFs with a PDF viewer, display images inline).
\nDocuments are generally returned in PDF format, but other MIME types may appear depending on the issuer.
\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Digilocker Download Documents | \n300–500 ms | \n
\n\n
\n
Status Code
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n| 200 | \nSuccessful | \n
\n\n| 422 | \nAccess Denied Or Access Pending | \n
\n\n| 500 | \nInternal server error | \n
\n\n
\n
Introduction
\nThe Mobile to PAN API allows users to retrieve the Permanent Account Number (PAN) linked to a given mobile number.
\nThis API is useful for KYC completion, fraud prevention, onboarding processes, and financial identity verification.
\n
\nUse Cases
\n\nRetrieve the PAN number registered with a specific mobile number.
\nSimplify customer onboarding by pre-filling PAN details.
\nVerify identity in financial and compliance workflows.
\nReduce manual errors in PAN collection.
\nDetect potential mismatches or fraudulent submissions.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/pan/mobile-to-pan | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\nFormat: JSON
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| mobile_no | \nString | \nMobile number linked to the PAN (10 digits). | \n\"XXXXXXXX21\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.pan_number | \nstring | \nPAN number linked to the given mobile number. | \n
\n\n
\n
Latency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to PAN | \n300–1100 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 200 | \nNo Data Found | \nNo matching record found | \nYES | \n
\n\n| 400 | \nBad Request | \n\"mobile_no\" is missing from the request. | \nNO | \n
\n\n| 422 | \nInvalid Mobile Number | \nThe mobile number is invalid or not found in PAN records. | \nPartial (0.9p) | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error; check logs | \nNO | \n
\n\n
\n
\nAdditional Notes
\n\nAlways ensure the Bearer Token is active and valid.
\nMobile number must be a valid 10-digit number linked to a PAN.
\nIdeal for quick KYC verification where mobile number is the primary input.
\nHelps reduce user friction in form-filling by auto-fetching PAN.
\n
\n","urlObject":{"path":["api","kyc","pan","mobile-to-pan"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"86da5233-cf8c-477a-9c47-695b87204579","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"9876543210\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/mobile-to-pan"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:42:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"9a-fs3aVfrkvSU7TRROGjxNZCkW50s\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T15:42:30.058Z\",\n \"transaction_id\": \"TXN-082d20ac-78b3-4ca9-a886-e810df66a68f\",\n \"status\": \"success\",\n \"data\": {\n \"pan_number\": \"HE00D0087M\"\n }\n}"},{"id":"0d392836-aee1-4820-bf48-4ac9dddf1288","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"98765421\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/pan/mobile-to-pan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:43:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"4c-oG45uMTe+k5xg16pKRj4nQzH9z8\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input mobile_no\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"4aa9ac02-0a82-4966-b33f-ca1b7b85d926"},{"name":"Mobile to Name","id":"e5506f14-d247-4d1c-a6b5-315724befa67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\r\n\"mobile_no\":\"XXXXXXXX21\",\r\n\"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/mobile-to-name","description":"Introduction
\nThe Mobile to Name API retrieves the name of an individual based on a given mobile number. This is particularly useful for quick identity resolution, verification during onboarding, and fraud detection.
\n
\nUse Cases
\n\nIdentity Verification: Cross-check the provided name with the registered name against a mobile number.
\nOnboarding Autofill: Auto-populate user name during form filling using mobile number.
\nFraud Detection: Detect mismatches between submitted names and actual owner records.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/mobile-to-name | \n
\n\n| Method | \nPOST | \n
\n\n| Auth | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| mobile_no | \nString | \nMobile number to be resolved | \n\"XXXXXXXX21\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.full_name | \nString | \nName associated with the mobile number | \n
\n\ndata.mobile_no | \nString | \nThe mobile number queried | \n
\n\n
\n
\nSample Response
\n{\n \"timestamp\": \"2025-12-02T13:04:37.879Z\",\n \"transaction_id\": \"TXN-77f69f85-31c2-488b-a599-f165f4505386\",\n \"status\": \"success\",\n \"data\": {\n \"full_name\": \"JOHN SNOW\",\n \"mobile_no\": \"96843634XX\"\n }\n}\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to Name | \n300–800 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 200 | \nNo Data Found | \nNo matching record found | \nYES | \n
\n\n| 400 | \nBad Request | \n\"mobile_no\" is missing from the request. | \nNO | \n
\n\n| 422 | \nInvalid Mobile Number | \nThe mobile number is invalid or not found in PAN records. | \nPartial (0.05p) | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error; check logs | \nNO | \n
\n\n
\n
\n","urlObject":{"path":["api","kyc","mobile-to-name"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"27178592-bfb6-4066-b540-5f722048994b","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\r\n\"mobile_no\":\"XXXXXXXX21\",\r\n\"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/mobile-to-name"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Thu, 17 Jul 2025 11:23:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"b0-tvWPniUn8ZHjmc5ah7cUTd1wsdQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-12-02T13:04:37.879Z\",\n \"transaction_id\": \"TXN-77f69f85-31c2-488b-a599-f165f4505386\",\n \"status\": \"success\",\n \"data\": {\n \"full_name\": \"ASHERDEEP KAPOOR\",\n \"mobile_no\": \"98843634XX\"\n }\n}"},{"id":"9f289954-9d38-48d9-84e0-b80e2e9b14a5","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\r\n \"mobile_no\":\"XXXXXXX21\",\r\n \"remark\": \"Optional client note or reference\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/mobile-to-name"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Thu, 17 Jul 2025 11:24:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"4c-oG45uMTe+k5xg16pKRj4nQzH9z8\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input mobile_no\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"13beafd6-9932-42f6-9dc3-9e26bcf55ddd","name":"Invalid Input (422)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\r\n \"mobile_no\":\"98XX46XX18\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/mobile-to-name"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"timestamp\": \"2025-12-02T13:06:37.357Z\",\n \"transaction_id\": \"TXN-e68c068a-1420-4b27-acfd-7369e914da44\",\n \"error_message\": \"Not Found\"\n}"}],"_postman_id":"e5506f14-d247-4d1c-a6b5-315724befa67"},{"name":"Mobile to UAN","id":"07720dea-38c0-431c-a67b-4696abf14eb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"XXXXXXXX23\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan","description":"Introduction
\nThe Mobile to UAN API allows users to retrieve one or more Universal Account Numbers (UAN) associated with a given mobile number registered in EPFO records.
\nThis API is useful for employee verification, PF account tracking, KYC completion, and onboarding processes that require EPF details.
\n
\nUse Cases
\n\nFind all UANs linked to a registered mobile number.
\nAssist employees in identifying their EPFO accounts.
\nValidate mobile number ownership against EPFO records.
\nSpeed up onboarding by pre-filling PF details.
\nReduce errors in PF account mapping.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/epfo/mobile-to-uan | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| multiple | \nInteger | \nSet to 1 to retrieve all UANs linked to the mobile number; 0 to retrieve only one. | \n1 | \n
\n\n| mobile_number | \nString | \nMobile number registered with EPFO (10 digits). | \n\"63XXX3XX23\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| timestamp | \nstring | \nTime when the request was processed (ISO format). | \n
\n\n| transaction_id | \nstring | \nUnique identifier for the API transaction. | \n
\n\n| status | \nstring | \nStatus of the request (e.g., \"success\"). | \n
\n\n| data.uan | \narray | \nList of UAN(s) linked to the provided mobile number. | \n
\n\n
\n
Latency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to UAN | \n300–800 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 200 | \nNo Data Found | \nNo matching record found | \nYES | \n
\n\n| 400 | \nBad Request | \n\"mobile_no\" is missing from the request. | \nNO | \n
\n\n| 422 | \nInvalid Mobile Number | \nThe mobile number is invalid or not found in PAN records. | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error; check logs | \nNO | \n
\n\n
\n
\nAdditional Notes
\n\nAlways ensure the Bearer Token is active and valid.
\nMobile number must be a valid 10-digit number registered with EPFO.
\nUse multiple: 1 to get all linked UANs; use 0 to retrieve only one.
\nUseful for both KYC verification and employee PF account tracking.
\nHelps avoid duplicate PF account entries during onboarding.
\n
\n","urlObject":{"path":["api","kyc","epfo","mobile-to-uan"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"060aaeac-20d4-4a4c-b095-f9a924e79ca5","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"XXXXXXXX23\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:11:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"a6-QmZZe4MQ5oYVsjzi+Pj4BKpPb14\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T15:11:11.904Z\",\n \"transaction_id\": \"TXN-4d8d0206-9c79-42d6-b223-07abdca35a80\",\n \"status\": \"success\",\n \"data\": {\n \"uan\": [\n \"1005XX13XX13\",\n \"1009XX43XX23\"\n ]\n }\n}"},{"id":"25bfbeb2-cff5-4934-988a-0d3fd5e24d24","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"123456789\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:12:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"50-aRxlm4d4femInT/VScXvDPqJ1zg\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input mobile_number\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"07720dea-38c0-431c-a67b-4696abf14eb4"}],"id":"c97f16f4-efb5-418a-b229-4b36f52f7594","_postman_id":"c97f16f4-efb5-418a-b229-4b36f52f7594","description":""},{"name":"Bank Verification","item":[{"name":"Bank Verification Penny Drop","id":"e05041fe-15f0-4db6-88bb-4989ecd241b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"account_number\": \"182XX13XX19881\",\r\n \"ifsc\": \"BXXBXXANKXX\",\r\n \"ifsc_details\": true ,\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/bank/verification/pennydrop","description":"Introduction
\nThe Bank Verification – Penny Drop API enables real-time validation of a bank account by initiating a micro-transaction and verifying the account holder’s name. This process ensures the legitimacy of a bank account and is commonly used in scenarios such as:
\nUse Cases
\n\nDigital KYC & Onboarding: Ensure the bank account belongs to the user being onboarded during registration or KYC workflows.
\nBeneficiary Verification: Confirm the account details of payout recipients before initiating financial transfers.
\nFraud Prevention: Avoid disbursing funds to incorrect or fake accounts.
\nLending & Insurance: Validate bank account ownership prior to disbursing loans or insurance claims.
\n
\n
\nAPI Details
\nBase URL
\n\n- Production:
https://live.finaxle.com/api/kyc/bank/verification/pennydrop \n
\nHTTP Method
\n\nAuthentication
\n\n- Type: Bearer Token (required in headers)
\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body (JSON)
\nParameters
\n\n\n\n| Key | \nFormat | \nDescription | \n
\n\n\n\naccount_number | \nString | \nBank account number to verify | \n
\n\nifsc | \nString | \nIFSC code of the bank | \n
\n\nifsc_details | \nBoolean | \nOptional flag to return IFSC details | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\ndata.status | \nboolean | \nStatus of account verification | \n
\n\ndata.upi_id | \nstring | \nUPI ID linked to the account (if available) | \n
\n\ndata.remarks | \nstring | \nRemarks/response message | \n
\n\ndata.client_id | \nstring | \nClient reference identifier | \n
\n\ndata.full_name | \nstring | \nAccount holder’s full name | \n
\n\ndata.imps_ref_no | \nstring | \nIMPS reference number | \n
\n\ndata.account_exists | \nboolean | \nIndicates if the account exists | \n
\n\ndata.ifsc_details.id | \ninteger | \nInternal identifier for IFSC record | \n
\n\ndata.ifsc_details.upi | \nboolean | \nWhether UPI is supported | \n
\n\ndata.ifsc_details.bank | \nstring | \nBank name | \n
\n\ndata.ifsc_details.city | \nstring | \nBank branch city | \n
\n\ndata.ifsc_details.ifsc | \nstring | \nIFSC code | \n
\n\ndata.ifsc_details.imps | \nboolean | \nWhether IMPS is supported | \n
\n\ndata.ifsc_details.micr | \nstring | \nMICR code | \n
\n\ndata.ifsc_details.neft | \nboolean | \nWhether NEFT is supported | \n
\n\ndata.ifsc_details.rtgs | \nboolean | \nWhether RTGS is supported | \n
\n\ndata.ifsc_details.state | \nstring | \nBank branch state | \n
\n\ndata.ifsc_details.swift | \nstring | \nSWIFT code | \n
\n\ndata.ifsc_details.branch | \nstring | \nBranch name | \n
\n\ndata.ifsc_details.centre | \nstring | \nBank centre name | \n
\n\ndata.ifsc_details.address | \nstring | \nBank branch address | \n
\n\ndata.ifsc_details.contact | \nstring | \nBranch contact number | \n
\n\ndata.ifsc_details.iso3166 | \nstring | \nISO3166 state code | \n
\n\ndata.ifsc_details.district | \nstring | \nDistrict of the branch | \n
\n\ndata.ifsc_details.bank_code | \nstring | \nBank code abbreviation | \n
\n\ndata.transaction_info.reqid | \nstring | \nRequest ID | \n
\n\ndata.transaction_info.chanref | \nstring | \nChannel reference ID | \n
\n\ndata.transaction_info.txn_type | \nstring | \nTransaction type | \n
\n\ndata.transaction_info.nw_txn_refid | \nstring | \nNetwork transaction reference ID | \n
\n\ndata.transaction_info.reference_id | \ninteger | \nInternal transaction reference ID | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Penny Drop | \n300–1200 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \n
\n\n\n\n200 | \nSuccess | \nRequest processed successfully | \n
\n\n422 | \nUnprocessable Entity | \nWrong Account Number | \n
\n\n400 | \nBad Request | \nInvalid IFSC Code | \n
\n\n403 | \nUnauthorized | \nAPI key is missing or invalid | \n
\n\n500 | \nInternal Server Error | \nUnexpected error on server | \n
\n\n
\n
Additional Notes
\n\nEnsure that both id_number and ifsc are accurate and properly formatted.
\nA valid Bearer token must be provided in the Authorization header.
\nUse ifsc_details: true if IFSC-related metadata is needed in the response.
\n
\n","urlObject":{"path":["api","kyc","bank","verification","pennydrop"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"2a519c2b-125f-4637-b528-7af39f665b60","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"account_number\": \"1257XX5XX13XX1\",\r\n \"ifsc\": \"BAXX0XXNKXX\",\r\n \"ifsc_details\": true,\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/bank/verification/pennydrop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 06 May 2025 05:10:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"678"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2a6-EIMgFkjmnCgOZLP9Yx7prENiM7c\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-05T11:34:18.198Z\",\n \"transaction_id\": \"TXN-ab12cd34-ef56-7890-gh12-ijklmn345678\",\n \"status\": \"success\",\n \"data\": {\n \"status\": true,\n \"upi_id\": \"dummyuser123@bank\",\n \"remarks\": \"Dummy transaction processed\",\n \"client_id\": \"CLI-000111222333\",\n \"full_name\": \"JOHN DOE\",\n \"imps_ref_no\": \"998877665544\",\n \"account_exists\": true,\n \"ifsc_details\": {\n \"id\": 999,\n \"upi\": true,\n \"bank\": \"DUMMY BANK LTD\",\n \"city\": \"DUMMYCITY\",\n \"ifsc\": \"DUMM0123456\",\n \"imps\": true,\n \"micr\": \"123456789\",\n \"neft\": true,\n \"rtgs\": true,\n \"state\": \"DUMMYSTATE\",\n \"swift\": \"DUMMYINBBXXX\",\n \"branch\": \"DUMMY BRANCH\",\n \"centre\": \"DUMMY CENTRE\",\n \"address\": \"123, Dummy Street, Dummy Area\",\n \"contact\": \"+91-9999999999\",\n \"iso3166\": \"IN-XX\",\n \"district\": \"DUMMYDISTRICT\",\n \"bank_code\": \"DUMY\"\n },\n \"transaction_info\": {\n \"reqid\": \"REQ-1234567890\",\n \"chanref\": \"CHAN-1234567890\",\n \"txn_type\": \"DUMMYTXN\",\n \"nw_txn_refid\": \"REF-0987654321\",\n \"reference_id\": 11223344\n }\n }\n}\n"},{"id":"5621f82b-1403-4526-949a-877390a1140d","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"account_number\": \"182XX13XX19881\",\r\n \"ifsc\": \"BXXB000341\",\r\n \"ifsc_details\": true,\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/bank/verification/pennydrop"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Invalid Input ifsc\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"1f9b6980-b2fd-40c4-ab03-58ae0e9cbf9e","name":"Invalid Account(422)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"account_number\": \"182XX13XX1981\",\r\n \"ifsc\": \"BXXBXXANKXX\",\r\n \"ifsc_details\": true,\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/bank/verification/pennydrop"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"timestamp\": \"2025-09-05T11:38:36.951Z\",\n \"transaction_id\": \"TXN-41cd2daf-15d1-4810-b575-6c076e0ffe1a\",\n \"error_message\": \"INVALID ACCOUNT\"\n}"}],"_postman_id":"e05041fe-15f0-4db6-88bb-4989ecd241b8"},{"name":"Bank Verification Pennyless","id":"c01b08e8-a1af-478d-904b-ecc0b5705f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"account_number\": \"192XX1XXX1XX81\",\r\n \"ifsc\": \"BXXB0XXXKXX\",\r\n \"ifsc_details\": true,\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/bank/verification/pennyless","description":"Introduction
\nThe Bank Verification - Pennyless API verifies a bank account without initiating any transaction. It provides a fast and cost-effective method for checking account validity and retrieving account holder information.
\nUse Cases
\n\nKYC Verification: Instantly validate the account holder’s name against a bank account number.
\nFraud Prevention: Check for fake or incorrect bank account entries without transferring funds.
\nCustomer Onboarding: Seamless and low-cost method to validate bank details during signup.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/bank/verification/pennyless | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (required in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\nAuthorization | \nBearer | \nYes | \n
\n\nContent-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Key | \nFormat | \nDescription | \n
\n\n\n\nid_number | \nString | \nBank account number to verify | \n
\n\nifsc | \nString | \nIFSC code of the bank | \n
\n\nifsc_details | \nBoolean | \nOptional flag to include IFSC metadata in response | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\ndata.client_id | \nstring | \nUnique client-provided transaction or request identifier. | \n
\n\ndata.account_exists | \nboolean | \nIndicates whether the account exists (true or false). | \n
\n\ndata.upi_id | \nstring/null | \nUPI ID linked to the account, if available. | \n
\n\ndata.full_name | \nstring | \nAccount holder’s full name. | \n
\n\ndata.imps_ref_no | \nstring/null | \nIMPS reference number if applicable. | \n
\n\ndata.remarks | \nstring | \nAdditional remarks or comments regarding the transaction. | \n
\n\ndata.status | \nstring/null | \nStatus of the account verification (if available). | \n
\n\ndata.ifsc_details.id | \ninteger | \nIdentifier for the IFSC record. | \n
\n\ndata.ifsc_details.ifsc | \nstring | \nIFSC code of the bank branch. | \n
\n\ndata.ifsc_details.micr | \nstring | \nMICR code of the branch. | \n
\n\ndata.ifsc_details.iso3166 | \nstring | \nISO 3166 region code for the state. | \n
\n\ndata.ifsc_details.swift | \nstring/null | \nSWIFT code of the branch, if available. | \n
\n\ndata.ifsc_details.bank | \nstring | \nName of the bank. | \n
\n\ndata.ifsc_details.bank_code | \nstring | \nBank code abbreviation. | \n
\n\ndata.ifsc_details.bank_name | \nstring | \nFull name of the bank. | \n
\n\ndata.ifsc_details.branch | \nstring | \nBranch name. | \n
\n\ndata.ifsc_details.centre | \nstring | \nCentre location of the branch. | \n
\n\ndata.ifsc_details.district | \nstring | \nDistrict where the branch is located. | \n
\n\ndata.ifsc_details.state | \nstring | \nState where the branch is located. | \n
\n\ndata.ifsc_details.city | \nstring | \nCity where the branch is located. | \n
\n\ndata.ifsc_details.address | \nstring | \nFull address of the bank branch. | \n
\n\ndata.ifsc_details.contact | \nstring | \nContact number of the branch. | \n
\n\ndata.ifsc_details.imps | \nboolean | \nIndicates if IMPS transactions are supported. | \n
\n\ndata.ifsc_details.rtgs | \nboolean | \nIndicates if RTGS transactions are supported. | \n
\n\ndata.ifsc_details.neft | \nboolean | \nIndicates if NEFT transactions are supported. | \n
\n\ndata.ifsc_details.upi | \nboolean | \nIndicates if UPI transactions are supported. | \n
\n\ndata.ifsc_details.micr_check | \nboolean | \nIndicates if MICR check is valid. | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Penny Less | \n300–800 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \n
\n\n\n\n200 | \nSuccess | \nRequest processed successfully | \n
\n\n422 | \nUnprocessable Entity | \nWrong Account Number | \n
\n\n400 | \nBad Request | \nInvalid IFSC Code | \n
\n\n403 | \nUnauthorized | \nAPI key is missing or invalid | \n
\n\n500 | \nInternal Server Error | \nUnexpected error on server | \n
\n\n
\n
Introduction
\nThe Mobile to UPI API retrieves the UPI ID linked to a given mobile number. It enables seamless financial identity verification and payment account validation by mapping a mobile number to its registered UPI handle.
\nThis API is particularly useful for KYC processes, fraud detection, and financial onboarding where UPI-linked identity confirmation is required.
\n
\nUse Cases
\n\nBank Account Verification: Validate UPI-linked accounts associated with a given mobile number.
\nPayment Readiness Check: Confirm if a user is UPI-enabled before initiating a payment or onboarding.
\nFraud Detection: Identify suspicious cases by validating genuine UPI handle ownership.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/bank/mobile-to-upi | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| mobile_no | \nString | \nUser’s mobile number for which UPI details are to be fetched. | \n\"987646XXXX\" | \n
\n\n| remark | \nString | \n(Optional) Additional notes or tracking info passed by the client. Does not affect processing. | \n\"Verification for onboarding\" | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.upi_id | \nString | \nUPI ID linked to the provided mobile number. | \n
\n\n| data.mobile_number | \nString | \nThe mobile number used in the request. | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to UPI | \n200–500ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully. | \n
\n\n| 200 | \nNo Content | \nNo UPI record found for the given mobile number. | \n
\n\n| 400 | \nBad Request | \nInvalid or missing parameters. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue occurred; check logs. | \n
\n\n
\n
Introduction
\nThe UPI Verification API validates a provided UPI ID and returns:
\n\nThis API is useful for onboarding, payment verification, fraud prevention, and beneficiary validation.
\n
\nUse Cases
\n✅ KYC & User Onboarding
\nVerify if the UPI ID belongs to the user during onboarding.
\n✅ Payment Beneficiary Verification
\nPrevent payment fraud by verifying the receiver’s UPI name.
\n✅ Loan Disbursement Checks
\nConfirm that the borrower’s UPI handle is active and valid.
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL (Prod) | \nhttps://live.finaxle.com/api/kyc/bank/upi/verify | \n
\n\n| Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Field | \nType | \nDescription | \nRequired | \n
\n\n\n\n| upi_id | \nString | \nThe UPI/VPA to validate | \n✅ Yes | \n
\n\n| remark | \nString | \nOptional client note/reference | \n❌ Optional | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| upi_id | \nThe normalised UPI ID validated by the system | \n
\n\n| full_name | \nUPI account holder’s registered name | \n
\n\n| upi_valid | \nBoolean flag indicating if UPI is valid and active | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMeaning | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nUPI verification completed | \n
\n\n| 400 | \nBad Request | \nMalformed UPI ID or missing parameters | \n
\n\n| 422 | \nUnprocessable Entity | \nInvalid UPI | \n
\n\n| 404 | \nNot Found | \nUPI handle does not exist | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected system failure | \n
\n\n
\n
This folder contains the Bank Verification API for Penny Drop and PennyLess.
\n\nPenny-less verification: A method to verify bank account details without transferring any money. It uses APIs to validate account holder name and account number via the bank without a monetary transaction.
\nPenny drop verification: A method that transfers a small amount (usually ₹1) to the bank account to verify its validity and fetch the account holder’s name from the bank’s response.
\n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"9cb76461-3e4e-4614-8669-5aa25bc0ef69"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"19219c9a-1750-466b-a4b4-461c5fee8a47"}}],"_postman_id":"226a70ab-0673-4c8e-bd10-3e9b5bb5c62f"},{"name":"Corporate","item":[{"name":"GST","item":[{"name":"GST Turnover","id":"2bf51d20-c12f-4a69-8c74-1c3734eb1a4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"gst_no\": \"09AAACXX853XXZ5\",\r\n \"year\": \"2022-2023\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/turnover","description":"Introduction
\nThe GSTIN Turnover Verification API allows businesses to verify turnover figures associated with a Goods and Services Tax Identification Number (GSTIN), along with key business information such as legal/trade names, taxpayer type, and authorized signatories.
\nThis API is essential for credit underwriting, financial due diligence, and compliance risk assessment.
\n
\nUse Cases
\n\nCredit Risk Assessment : NBFCs, banks, and fintechs can verify declared turnover vs. filed figures to evaluate loan repayment capacity.
\nVendor Due Diligence : Ensures suppliers have filed turnover data that aligns with expected scale and declared business nature.
\nBusiness Underwriting : Insurance and financial services can assess business stability through historical turnover trends.
\nCompliance Verification : Confirms GSTIN is active and linked to PAN-level turnover for better compliance auditing.
\nOnboarding Evaluation : Helps platforms and aggregators assess the business viability of sellers or vendors during registration.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/corporate/gstin/turnover | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| gst_no | \nString | \n15-character alphanumeric GSTIN | \n✅ Yes | \n
\n\n| year | \nString | \nFinancial year in format YYYY-YYYY | \n✅ Yes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.financial_year | \nstring | \nFinancial year of the data | \n
\n\ndata.business_details.gst_status | \nstring | \nGST registration status | \n
\n\ndata.business_details.legal_name | \nstring | \nRegistered legal name | \n
\n\ndata.business_details.trade_name | \nstring | \nBusiness trade name | \n
\n\ndata.business_details.register_date | \nstring | \nDate of GST registration (DD/MM/YYYY) | \n
\n\ndata.business_details.business_nature | \narray | \nList of nature of business activities | \n
\n\ndata.business_details.authorized_signatory | \narray | \nList of authorized signatories | \n
\n\ndata.turnover_details.filing_date | \nstring | \nDate of turnover filing | \n
\n\ndata.turnover_details.pan_turnover_filed | \nnumber | \nTurnover filed against PAN | \n
\n\ndata.turnover_details.gstin_turnover_filed | \nnumber | \nTurnover filed against GSTIN | \n
\n\ndata.turnover_details.pan_turnover_estimated | \nnumber | \nEstimated turnover against PAN | \n
\n\ndata.turnover_details.gstin_turnover_estimated | \nnumber | \nEstimated turnover against GSTIN | \n
\n\ndata.tax_payer_type.tax_payer_type | \nstring | \nType of taxpayer (e.g., Regular, Composition) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| GSTIN Turnover | \n500–1200ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 422 | \nInvalid GSTIN | \nThe provided GSTIN is incorrect or does not exist | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue on the server | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the Bearer Token is active and valid.
\nGSTIN should be valid (15 alphanumeric characters).
\nThis API is ideal for credit underwriting, turnover validation, and risk management.
\nDifferences in estimated vs. filed turnover may indicate reporting anomalies.
\n
\n","urlObject":{"path":["api","corporate","gstin","turnover"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"a4c2c6fb-8026-4c84-97af-efa8dc81a988","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"gst_no\": \"09AAACXX853LXX5\",\r\n \"year\": \"2022-2023\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/turnover"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:50:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"695"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2b7-ssDhmEQrTrl6aWJ1ALuy8r29a0s\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:50:18.767Z\",\n \"transaction_id\": \"11111111-2222-3333-4444-555555555555\",\n \"status\": \"success\",\n \"data\": {\n \"financial_year\": \"2024-25\",\n \"business_details\": {\n \"gst_status\": \"Active\",\n \"legal_name\": \"ABC TRADERS PRIVATE LIMITED\",\n \"trade_name\": \"ABC TRADERS PVT LTD.\",\n \"register_date\": \"15/05/2018\",\n \"business_nature\": [\n \"Retail Business\",\n \"Supplier of Goods\"\n ],\n \"authorized_signatory\": [\n \"RAHUL SHARMA\",\n \"PRIYA VERMA\"\n ]\n },\n \"turnover_details\": {\n \"filing_date\": \"20/01/2025\",\n \"pan_turnover_filed\": 9876543210.50,\n \"gstin_turnover_filed\": 7654321098.25,\n \"pan_turnover_estimated\": 9876543210.50,\n \"gstin_turnover_estimated\": 8765432109.75\n },\n \"tax_payer_type\": {\n \"tax_payer_type\": \"Regular\"\n }\n }\n}\n"},{"id":"11677f2e-027b-49ea-bdfa-1560a3e83440","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"gst_no\": \"09AAXXI5853XXZ6\",\r\n \"year\": \"2024-2025\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/turnover"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:51:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"ae-UbssUFD/xKLnrm6BIOs1P7WebNw\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:51:15.226Z\",\n \"transaction_id\": \"c8f6e935-70c9-49bf-9dde-20d91066fd98\",\n \"status\": \"error\",\n \"error_message\": \"Invalid ID Number or Combination of Inputs\"\n}"}],"_postman_id":"2bf51d20-c12f-4a69-8c74-1c3734eb1a4f"},{"name":"GSTIN Verify","id":"8dfc75a0-8315-47e3-9c70-271723306223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"08AAFCXXX03XXXX\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/verify","description":"Introduction
\nThe GST Verification API enables businesses to validate a Goods and Services Tax Identification Number (GSTIN) and retrieve detailed taxpayer information including registration data, business structure, jurisdiction, Aadhaar validation status, and more.
\n
\nUse Case
\n1. Business Onboarding & KYC Compliance
\nBefore onboarding a new vendor, partner, or customer, businesses must ensure the legitimacy of the organization. The GST Verification API validates the GSTIN and fetches official registration details such as legal name, PAN linkage, registration date, and business type.
\n\n✅ Prevents onboarding of fraudulent or inactive entities
\n✅ Ensures compliance with AML and KYC regulations
\n✅ Verifies Aadhaar validation and registration status
\n
\n2. Credit Risk Assessment for Loan Underwriting
\nLenders and NBFCs can use the API to assess the legitimacy and stability of a borrowing business entity by confirming their GST registration status, core business activity, and active/inactive status.
\n\n✅ Validates business existence
\n✅ Confirms taxpayer type (e.g., Regular, Composition)
\n✅ Provides insights into business longevity via registration date
\n
\n3. Supplier and Vendor Due Diligence
\nProcurement and supply chain teams can verify vendor GSTINs to ensure the supplier is legally registered, has an active GST profile, and matches declared business activities.
\n\n✅ Prevents tax input credit issues
\n✅ Confirms jurisdiction and address authenticity
\n✅ Ensures suppliers are not flagged for compliance issues
\n
\n4. Regulatory and Tax Compliance Audits
\nCompliance teams can use the GST Verification API to audit and validate the GST information of associated businesses as part of internal or statutory audits.
\n\n✅ Automates verification for audit readiness
\n✅ Validates consistency of PAN and GSTIN linkages
\n✅ Assists in detecting misreporting or tax evasion risks
\n
\n5. e-Commerce & Marketplace Onboarding
\nMarketplaces onboarding third-party sellers can use this API to validate if the seller is a registered and active GST entity before listing.
\n\n✅ Reduces fraud and improves platform trust
\n✅ Ensures sellers are authorized to collect GST
\n✅ Verifies Aadhaar linkage, supporting identity validation
\n
\n
\nAPI Details
\n\n\n\n| Environment | \nURL | \n
\n\n\n\n| Live | \nhttps://uat.finaxle.com/api/corporate/gstin/verify | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \n15-character GSTIN number | \n✅ Yes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.address_details | \nObject | \nAdditional details related to the registered address. | \n
\n\ndata.einvoice_status | \nBoolean | \nIndicates if e-invoicing is enabled for the entity. | \n
\n\ndata.client_id | \nString | \nUnique client identifier. | \n
\n\ndata.gstin | \nString | \nGST Identification Number. | \n
\n\ndata.pan_number | \nString | \nPermanent Account Number (PAN) of the business entity. | \n
\n\ndata.fy | \nNull / String | \nFinancial year information, if available. | \n
\n\ndata.business_name | \nString | \nRegistered business name. | \n
\n\ndata.legal_name | \nString | \nLegal name of the entity. | \n
\n\ndata.center_jurisdiction | \nString | \nJurisdiction details under the central GST authority. | \n
\n\ndata.state_jurisdiction | \nString | \nJurisdiction details under the state GST authority. | \n
\n\ndata.date_of_registration | \nString (YYYY-MM-DD) | \nDate when GST registration was granted. | \n
\n\ndata.constitution_of_business | \nString | \nType of business constitution (e.g., Private Limited Company). | \n
\n\ndata.taxpayer_type | \nString | \nTaxpayer category (e.g., Regular). | \n
\n\ndata.gstin_status | \nString | \nCurrent status of the GSTIN (e.g., Active). | \n
\n\ndata.date_of_cancellation | \nString (YYYY-MM-DD) | \nDate of GSTIN cancellation, if any. (Default placeholder if not cancelled) | \n
\n\ndata.field_visit_conducted | \nString | \nWhether a field visit was conducted (\"Yes\"/\"No\"). | \n
\n\ndata.nature_bus_activities | \nArray of Strings | \nList of nature of business activities. | \n
\n\ndata.nature_of_core_business_activity_code | \nString | \nCode representing the core business activity. | \n
\n\ndata.nature_of_core_business_activity_description | \nString | \nDescription of the core business activity. | \n
\n\ndata.aadhaar_validation | \nString | \nIndicates whether Aadhaar validation was successful (\"Yes\"/\"No\"). | \n
\n\ndata.aadhaar_validation_date | \nString (YYYY-MM-DD) | \nDate of Aadhaar validation. | \n
\n\ndata.filing_status | \nArray | \nFiling status history (empty if not applicable). | \n
\n\ndata.address | \nString | \nFull registered address of the business entity. | \n
\n\ndata.hsn_info | \nObject | \nHarmonized System of Nomenclature info (if available). | \n
\n\ndata.filing_frequency | \nArray | \nFrequency of GST filings (empty if not applicable). | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| GST Verification | \n800–1200 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 400 | \nInvalid GSTIN | \nThe provided GSTIN is incorrect or does not exist | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \n
\n\n| 422 | \nMissing Required Parameters | \nOne or more required fields are missing in the request body | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error on the server | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the Bearer Token is active and valid for all requests.
\nThe GSTIN should be a valid 15-character alphanumeric identifier.
\nThis API is ideal for validating businesses during onboarding, KYC checks, and regulatory compliance.
\nAadhaar validation results (if conducted) are also returned.
\n
\n","urlObject":{"path":["api","corporate","gstin","verify"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"78116a78-31a3-40c9-8699-081feaf78415","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"08AAFCXXXXX3XXXXX\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:52:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1222"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"4c6-cbgV+BP6dtni7fH7bLA2FVsffKE\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:52:07.124Z\",\n \"transaction_id\": \"b0aec5b9-94c6-4ac0-9305-f6ccbc7be69e\",\n \"status\": \"success\",\n \"data\": {\n \"address_details\": {},\n \"einvoice_status\": false,\n \"client_id\": \"corporate_gstin_lhoFmbrfvhKKzwHxnoEs\",\n \"gstin\": \"08AAFCFXXX3XXXXX\",\n \"pan_number\": \"AAFCFXXXX\",\n \"fy\": null,\n \"business_name\": \"STAR TECH PRIVATE LIMITED\",\n \"legal_name\": \"STAR TECH PRIVATE LIMITED\",\n \"center_jurisdiction\": \"State - CBIC,Zone - JAIPUR,Commissionerate - JAIPUR,Division - GST DIVISION-B JAIPUR,Range - GST RANGE-VI\",\n \"state_jurisdiction\": \"State - PUNE ,Zone - Jaipur-IV,Circle - Circle-C, Jaipur IV,Ward - Circle-C, GANGANAGAR IV, - Ward-II (Jurisdictional Office)\",\n \"date_of_registration\": \"2024-05-30\",\n \"constitution_of_business\": \"Private Limited Company\",\n \"taxpayer_type\": \"Regular\",\n \"gstin_status\": \"Active\",\n \"date_of_cancellation\": \"1890-01-01\",\n \"field_visit_conducted\": \"No\",\n \"nature_bus_activities\": [\n \"Supplier of Services\"\n ],\n \"nature_of_core_business_activity_code\": \"SPO\",\n \"nature_of_core_business_activity_description\": \"Service Provider and Others\",\n \"aadhaar_validation\": \"Yes\",\n \"aadhaar_validation_date\": \"2024-06-17\",\n \"filing_status\": [],\n \"address\": \"1ST, 66, TERA BAZAR, JOTI NAGAR, PILLIBANGA, Jaipur, CHANDIGARH, 3020112\",\n \"hsn_info\": {},\n \"filing_frequency\": []\n }\n}"},{"id":"4a52b690-380a-4f3b-a67f-4a500c19aee0","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"08AAFCFXXXXL1ZR\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:52:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"86-Ixa9hlamFHMumPo90jl/xfxSmdg\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:52:44.638Z\",\n \"transaction_id\": \"ccda95bd-86d9-4637-b163-c7ab53f17c88\",\n \"status\": \"error\",\n \"error_message\": null\n}"}],"_postman_id":"8dfc75a0-8315-47e3-9c70-271723306223"},{"name":"GSTIN to Mobile & Email","id":"c3337fa6-f503-4d07-9ac4-afe1491da7f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_number\": \"08AAXXF9XX3LXXE\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/gstin/mobile-email","description":"Introduction
\nThe GSTIN Mobile & Email API retrieves registered email and mobile details associated with a given GSTIN (Goods and Services Tax Identification Number).
\nThis helps streamline business verification, onboarding workflows, and compliance checks by fetching contact information directly linked to GST registration records.
\n
\nUse Cases
\n\nBusiness KYC Verification: Retrieve registered contact details of a company for compliance checks.
\nOnboarding & Due Diligence: Validate GSTIN ownership by matching registered contact details with business information.
\nFraud Prevention: Prevent impersonation by ensuring GSTIN contact details are consistent with the business entity.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| - Production | \nhttps://live.finaxle.com/api/corporate/gstin/mobile-email | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| id_number | \nString | \nGSTIN of the business entity | \n\"08AAFCF9203L1ZE\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\nSample Response
\n{\n \"timestamp\": \"2025-08-18T09:59:06.138Z\",\n \"transaction_id\": \"TXN-58e191fd-5f09-44ff-8020-13ba68f0aa98\",\n \"status\": \"success\",\n \"data\": {\n \"email\": \"cXXX@fXXX.tXXh\",\n \"mobile\": \"843XXXX738\"\n }\n}\n\n
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.email | \nString | \nRegistered email linked to the GSTIN | \n
\n\n| data.mobile | \nString | \nRegistered mobile number linked to the GSTIN | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| GSTIN Mobile & Email API | \n500–1200ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo contact details found for given GSTIN | \n
\n\n| 422 | \nBad Request | \nInvalid or missing GSTIN | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue; check logs | \n
\n\n
\n
API to verify GSTIN and GST Turnover.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"7fd25b63-f33e-4575-829c-9e582a9628dd"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"3d2739da-066c-4fdd-adcd-ff087e6fb3ff"}}],"_postman_id":"7649bbf9-944a-4101-ae8c-7207a569cfcc"},{"name":"MCA Company Details","item":[{"name":"MCA Company Details","id":"706f53aa-178f-49c1-ae2f-3962c2481f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"U63999HR2024PTCXXXXXX\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/mca/company-details","description":"Introduction
\nThe MCA Company Details API provides detailed company-level information by using the Corporate Identification Number (CIN) issued by the Ministry of Corporate Affairs (MCA).
\nIt returns comprehensive data including registration details, directors, capital structure, and compliance status, aiding in informed decision-making across industries.
\n
\nUse Cases
\n\nBusiness onboarding and verification processes to confirm the legitimacy and registration status of Indian companies.
\nKYC compliance checks during vendor/supplier or partner registration.
\nCredit and risk profiling of companies before extending financial products or services.
\nLegal and compliance teams conducting due diligence and background checks.
\nFraud prevention teams validating director identity and CIN status to avoid shell or non-compliant entities.
\nFintech and lending institutions checking active compliance and authorized capital before loan approvals.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/corporate/mca/company-details | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nValid CIN (Corporate Identification Number) | \n✅ Yes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.client_id | \nString | \nUnique identifier for the client. | \n
\n\ndata.company_id | \nString | \nCompany identification number (CIN). | \n
\n\ndata.company_type | \nString | \nType of the entity (e.g., Company). | \n
\n\ndata.company_name | \nString | \nFull registered name of the company. | \n
\n\ndata.details.company_info.cin | \nString | \nCorporate Identification Number (CIN). | \n
\n\ndata.details.company_info.roc_code | \nString | \nRegistrar of Companies (RoC) code. | \n
\n\ndata.details.company_info.registration_number | \nString | \nRegistration number of the company. | \n
\n\ndata.details.company_info.company_category | \nString | \nCategory of the company (e.g., Company limited by Shares). | \n
\n\ndata.details.company_info.class_of_company | \nString | \nClass of company (e.g., Private). | \n
\n\ndata.details.company_info.company_sub_category | \nString | \nSub-category of the company (e.g., Non-govt company). | \n
\n\ndata.details.company_info.authorized_capital | \nString | \nAuthorized capital of the company (in INR). | \n
\n\ndata.details.company_info.paid_up_capital | \nString | \nPaid-up capital of the company (in INR). | \n
\n\ndata.details.company_info.number_of_members | \nString | \nNumber of members in the company. | \n
\n\ndata.details.company_info.date_of_incorporation | \nString (YYYY-MM-DD) | \nDate of incorporation of the company. | \n
\n\ndata.details.company_info.registered_address | \nString | \nOfficial registered address of the company. | \n
\n\ndata.details.company_info.address_other_than_ro | \nString | \nAddress other than registered office (if any). | \n
\n\ndata.details.company_info.email_id | \nString | \nRegistered email ID of the company. | \n
\n\ndata.details.company_info.listed_status | \nString | \nListed or unlisted company status. | \n
\n\ndata.details.company_info.active_compliance | \nNull / String | \nWhether the company is in active compliance (if applicable). | \n
\n\ndata.details.company_info.suspended_at_stock_exchange | \nString | \nWhether the company is suspended from stock exchange. | \n
\n\ndata.details.company_info.last_agm_date | \nString (YYYY-MM-DD) | \nDate of the last Annual General Meeting. | \n
\n\ndata.details.company_info.last_bs_date | \nString (YYYY-MM-DD) | \nDate of the last balance sheet filed. | \n
\n\ndata.details.company_info.company_status | \nString | \nCurrent status of the company (e.g., Active). | \n
\n\ndata.details.company_info.status_under_cirp | \nNull / String | \nIndicates if the company is under Corporate Insolvency Resolution Process. | \n
\n\ndata.details.directors[] | \nArray of Objects | \nList of directors associated with the company. | \n
\n\ndata.details.directors[].din_number | \nString | \nDirector Identification Number (DIN). | \n
\n\ndata.details.directors[].director_name | \nString | \nFull name of the director. | \n
\n\ndata.details.directors[].start_date | \nString (YYYY-MM-DD) | \nDate when the director’s term started. | \n
\n\ndata.details.directors[].end_date | \nString (YYYY-MM-DD) | \nDate when the director’s term ended (if applicable). | \n
\n\ndata.details.directors[].surrendered_din | \nNull / String | \nDIN surrendered details (if any). | \n
\n\ndata.details.charges | \nArray | \nList of registered charges (empty if none exist). | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| MCA Company Details | \n800–1200ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully. | \n
\n\n| 400 | \nInvalid CIN | \nThe provided CIN is incorrect or does not exist. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 422 | \nMissing Required Parameters | \nRequired fields are missing in the request body. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the Bearer Token is active and valid when making API calls.
\nThe CIN must be valid and in correct 21-character format (e.g., U65999MH1995PLC123456).
\nThis API is intended for regulatory checks, financial onboarding, and organizational verification workflows.
\n
\n","urlObject":{"path":["api","corporate","mca","company-details"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"0d7a77a0-d9b0-4d85-87a4-4c5449369627","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_number\": \"U63999HR2024PTCXXXXXX\",\r\n \"remark\": \"Optional client note or reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/mca/company-details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 10:53:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1311"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"51f-b93Pcci+xr2mGVd46HfFvhM1nAE\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T10:53:17.630Z\",\n \"transaction_id\": \"36de97c5-2ea5-4696-9b3d-82551a5c57fb\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"company_jmzgOScrUWlvchjSiaRh\",\n \"company_id\": \"U63999HR2024PTC122347\",\n \"company_type\": \"Company\",\n \"company_name\": \"PROTOP CONSULTANCY SERVICES PRIVATE LIMITED\",\n \"details\": {\n \"company_info\": {\n \"cin\": \"U63999HR2024PTC122347\",\n \"roc_code\": \"RoC-Delhi\",\n \"registration_number\": \"122347\",\n \"company_category\": \"Company limited by Shares\",\n \"class_of_company\": \"Private\",\n \"company_sub_category\": \"Non-govt company\",\n \"authorized_capital\": \"100000\",\n \"paid_up_capital\": \"100000\",\n \"number_of_members\": \"0\",\n \"date_of_incorporation\": \"2024-06-07\",\n \"registered_address\": \"PLOT NO.-4 2ND FLOOR MINARCH TOWER Sector 44 Gurgaon Sector 45 Sector -45 Gurgaon HR 122003 IN\",\n \"address_other_than_ro\": \"-\",\n \"email_id\": \"protopconsultancy2025@outlook.com\",\n \"listed_status\": \"Unlisted\",\n \"active_compliance\": null,\n \"suspended_at_stock_exchange\": \"-\",\n \"last_agm_date\": \"1800-01-01\",\n \"last_bs_date\": \"1800-01-01\",\n \"company_status\": \"Active\",\n \"status_under_cirp\": null\n },\n \"directors\": [\n {\n \"din_number\": \"10660837\",\n \"director_name\": \"MANOJ JOSHI\",\n \"start_date\": \"2024-06-07\",\n \"end_date\": \"1800-01-01\",\n \"surrendered_din\": null\n },\n {\n \"din_number\": \"10660838\",\n \"director_name\": \"KEVAL KUMAR\",\n \"start_date\": \"2024-06-07\",\n \"end_date\": \"1800-01-01\",\n \"surrendered_din\": null\n }\n ],\n \"charges\": []\n }\n }\n}"}],"_postman_id":"706f53aa-178f-49c1-ae2f-3962c2481f14"}],"id":"fdac1265-b215-4028-bf8b-8310e8cc23ea","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2e04b8cd-e24b-4648-8927-2adc1c844c6d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"fa2b20a5-427b-4e2b-a2ee-616b7b13e6a9"}}],"_postman_id":"fdac1265-b215-4028-bf8b-8310e8cc23ea","description":""},{"name":"DIN to Contact","id":"bdb55beb-f73e-498e-80f6-e3522f45505d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\" : \"072351XX\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.totalekyc.com/api/kyc/din/contact","description":"Introduction
\nThe DIN to Contact API enables real-time retrieval of contact details (mobile number and email address) associated with a company director's Director Identification Number (DIN). It is useful for communication, identity verification, compliance, and background checks.
\nUse Cases
\n\nDigital KYC & Onboarding: Fetch director contact details to complete business onboarding or regulatory verification.
\nDue Diligence & Compliance: Used by financial institutions and legal firms to verify and maintain communication with company directors.
\nDebt Recovery & Legal Notices: Identify and reach out to directors for resolution of dues or issuance of legal notices.
\nBackground Checks: Valuable for HR, NBFCs, and fintechs conducting comprehensive background verification.
\nPartner/Stakeholder Vetting: Verify directorships and contact details when evaluating new vendors or business partners.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/prefill/din-to-contact | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (required in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| din | \nString | \nDirector Identification Number | \nYes | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Body Parameters
\n{\n \"timestamp\": \"2025-07-16T06:03:23.015Z\",\n \"transaction_id\": \"TXN-ddc0b634-1555-4376-8f00-00d85335f454\",\n \"status\": \"success\",\n \"data\": {\n \"email\": \"dktinfraanddeveloperspvtltd@gmail.com\",\n \"mobile\": \"+919416853895\"\n }\n}\n\n
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.email | \nstring | \nEmail address of the director | \n
\n\n| data.mobile | \nstring | \nMobile number of the director | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| DIN to Contact | \n300–700 ms | \n
\n\n
\n
Status Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 422 | \nInvalid DIN | \nDIN is invalid or unregistered | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \n
\n\n| 500 | \nInternal Server Error | \nServer-side processing error | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the DIN is valid and correctly formatted (generally a numeric 8-digit string).
\nThe contact information is sourced from publicly available or government-compliant datasets.
\nFor production access, use the Live URL with a valid Bearer token.
\nResponse format is consistent across environments.
\n
\n","urlObject":{"protocol":"https","path":["api","kyc","din","contact"],"host":["uat","totalekyc","com"],"query":[],"variable":[]}},"response":[{"id":"04a46e35-8ca5-4fc8-a774-886ac19f0c75","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\" : \"098196XX\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.totalekyc.com/api/kyc/din/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 16 Jul 2025 07:42:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"201"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"c9-GN3+C9zQiuTFCx/lzyx+hzbLbOA\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-16T07:42:52.747Z\",\n \"transaction_id\": \"TXN-966353a1-2fc3-4108-8822-37bc6ad232bd\",\n \"status\": \"success\",\n \"data\": {\n \"email\": \"dktinfraanddeveloperspvtltd@gmail.com\",\n \"mobile\": \"+919416853895\"\n }\n}"},{"id":"a97d766a-d987-4ad1-85f2-913b094f96ba","name":"Bad Request (422)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"id_number\" : \"09816XX\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.totalekyc.com/api/kyc/din/contact"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 16 Jul 2025 09:14:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"b5-vVq8p7N3Ee6WI5jOgs4VJ8K8/sE\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"timestamp\": \"2025-07-16T09:14:40.093Z\",\n \"transaction_id\": \"TXN-412c7e95-bbf5-4056-a7b2-c2667f5a8878\",\n \"error_message\": \"din length must be at least 8 characters long\"\n}"}],"_postman_id":"bdb55beb-f73e-498e-80f6-e3522f45505d"},{"name":"Mobile to UAN","id":"1944482f-fbbf-4d59-914f-a78b589f1263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"XXXXXXXX23\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan","description":"Introduction
\nThe Mobile to UAN API allows users to retrieve one or more Universal Account Numbers (UAN) associated with a given mobile number registered in EPFO records.
\nThis API is useful for employee verification, PF account tracking, KYC completion, and onboarding processes that require EPF details.
\n
\nUse Cases
\n\nFind all UANs linked to a registered mobile number.
\nAssist employees in identifying their EPFO accounts.
\nValidate mobile number ownership against EPFO records.
\nSpeed up onboarding by pre-filling PF details.
\nReduce errors in PF account mapping.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/epfo/mobile-to-uan | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| multiple | \nInteger | \nSet to 1 to retrieve all UANs linked to the mobile number; 0 to retrieve only one. | \n1 | \n
\n\n| mobile_number | \nString | \nMobile number registered with EPFO (10 digits). | \n\"63XXX3XX23\" | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| timestamp | \nstring | \nTime when the request was processed (ISO format). | \n
\n\n| transaction_id | \nstring | \nUnique identifier for the API transaction. | \n
\n\n| status | \nstring | \nStatus of the request (e.g., \"success\"). | \n
\n\n| data.uan | \narray | \nList of UAN(s) linked to the provided mobile number. | \n
\n\n
\n
Latency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to UAN | \n300-800ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully. | \n
\n\n| 400 | \nMissing Required Parameters | \n\"mobile_number\" is missing from the request. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header. | \n
\n\n| 422 | \nInvalid Mobile Number | \nThe mobile number is invalid or not found in EPFO records. | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs. | \n
\n\n
\n
\nAdditional Notes
\n\nAlways ensure the Bearer Token is active and valid.
\nMobile number must be a valid 10-digit number registered with EPFO.
\nUse multiple: 1 to get all linked UANs; use 0 to retrieve only one.
\nUseful for both KYC verification and employee PF account tracking.
\nHelps avoid duplicate PF account entries during onboarding.
\n
\n","urlObject":{"path":["api","kyc","epfo","mobile-to-uan"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"1be0114c-c08b-41d9-b52a-c89f0ad52058","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"XXXXXXXX23\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:11:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"a6-QmZZe4MQ5oYVsjzi+Pj4BKpPb14\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T15:11:11.904Z\",\n \"transaction_id\": \"TXN-4d8d0206-9c79-42d6-b223-07abdca35a80\",\n \"status\": \"success\",\n \"data\": {\n \"uan\": [\n \"1005XX13XX13\",\n \"1009XX43XX23\"\n ]\n }\n}"},{"id":"df7e2198-77c7-444f-a1b4-ea29aa10da23","name":"Bad Request (400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"multiple\": 1,\n \"mobile_number\": \"123456789\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/epfo/mobile-to-uan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:12:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"50-aRxlm4d4femInT/VScXvDPqJ1zg\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input mobile_number\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"1944482f-fbbf-4d59-914f-a78b589f1263"},{"name":"TAN Verify","id":"90ce4ae6-f3c1-42d6-b8ba-5c7a12ccf803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"BearerYOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_number\": \"DEXAXX90XX\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/corporate/tan/verify","description":"Introduction
\nThe TAN Verification API allows businesses to validate and retrieve official information associated with a Tax Deduction and Collection Account Number (TAN).
\nIt provides authoritative details such as the deductor’s name, category, address, status, and assessing officer (AO) information.
\nThis API is useful for corporate KYC, tax compliance checks, and validating the authenticity of TAN details provided by entities.
\n
\nUse Cases
\n\nValidate authenticity and validity of a TAN number.
\nRetrieve deductor details, category, and registered address.
\nConfirm TAN activation status for KYB (Know Your Business) or onboarding processes.
\nSupport compliance workflows and document verification.
\nEnable fraud prevention by confirming tax identity details.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Environment (LIVE) | \nhttps://live.finaxle.com/api/corporate/tan/verify | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer YOUR_BEARER_TOKEN | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\nJSON Example
\n{\n \"id_number\": \"DEXAXX90XX\",\n \"remark\": \"Optional client note or reference\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \n10-character TAN | \nYes | \n
\n\n| remark | \nString | \nOptional client note or reference, logged but not used in verification logic | \nNo | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.tan_number | \nString | \nVerified TAN number | \n
\n\n| data.deductor_name | \nString | \nRegistered name of the deductor | \n
\n\n| data.deductor_category_code | \nString | \nCode representing the deductor category | \n
\n\n| data.deductor_category_description | \nString | \nDescription of the deductor’s category | \n
\n\n| data.address | \nString | \nRegistered address of the deductor | \n
\n\n| data.tan_status | \nString | \nTAN status (e.g., Active, Inactive) | \n
\n\n| data.pan_number | \nString | \nLinked PAN number if available | \n
\n\n| data.ao_area_code | \nString | \nAssessing Officer area code | \n
\n\n| data.ao_type | \nString | \nAssessing Officer type | \n
\n\n| data.ao_range_code | \nInteger | \nAssessing Officer range code | \n
\n\n| data.ao_number | \nInteger | \nAssessing Officer number | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| TAN Verification | \n300–800 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 400 | \nBad Request | \nMissing or invalid input values | \n
\n\n| 422 | \nInvalid TAN | \nProvided TAN number is invalid or not found | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected server error. Retry or check logs | \n
\n\n
\n
Introduction
\nThe Telecom KYC API allows verification of a mobile number using an OTP-based consent workflow. This helps retrieve the subscriber’s name, address, DOB, and mobile operator details for telecom-based identity verification.
\n
\nUse Cases
\n\nTelecom-based KYC: Authenticate the identity linked to a mobile number using OTP consent.
\nDigital Onboarding: Prefill verified name, address, and DOB during sign-up or onboarding flows.
\nFraud Detection: Identify ownership mismatches or unauthorized usage of mobile numbers.
\nContact Enrichment: Obtain alternate number and network provider for better customer outreach.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/telecom/verify | \n
\n\n| Method | \nPOST | \n
\n\n| Auth | \nBearer Token (passed in headers) | \n
\n\n
\n
\nInitiate OTP Request
\nEndpoint
\nhttps://uat.finaxle.com/api/kyc/telecom/verify/initiate\nhttps://live.finaxle.com/api/kyc/telecom/verify/initiate\n\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
Request Body
\n{\n \"country_code\": \"91\",\n \"mobile_number\": \"9XX6X6XX16\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| country_code | \nString | \nCountry dialing code | \n
\n\n| mobile_number | \nString | \nMobile number to be verified | \n
\n\n
\n
Sample Response
\n{\n \"timestamp\": \"2025-07-18T09:47:35.968Z\",\n \"transaction_id\": \"TXN-66913aa5-6124-4095-848a-0b01b834a0b5\",\n \"status\": \"success\",\n \"data\": {\n \"reference_id\": \"telecom_dgda5d327e\"\n }\n}\n\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.reference_id | \nString | \nUnique session ID for OTP verify | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching record found | \n
\n\n| 400 | \nBad Request | \nInvalid or missing parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nServer Error | \nInternal error; check logs | \n
\n\n
\n
\nIntroduction
\nThe Telecom KYC API allows verification of a mobile number using an OTP-based consent workflow. This helps retrieve the subscriber’s name, address, DOB, and mobile operator details for telecom-based identity verification.
\n
\nUse Cases
\n\nTelecom-based KYC: Authenticate the identity linked to a mobile number using OTP consent.
\nDigital Onboarding: Prefill verified name, address, and DOB during sign-up or onboarding flows.
\nFraud Detection: Identify ownership mismatches or unauthorized usage of mobile numbers.
\nContact Enrichment: Obtain alternate number and network provider for better customer outreach.
\n
\n
\nAPI Details
\n| |
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/telecom/verify | \n
\n\n| Method | \nPOST | \n
\n\n| Auth | \nBearer Token (passed in headers) | \n
\n\n
\n
\n
\nSubmit OTP for Verification
\nEndpoint
\nhttps://uat.finaxle.com/api/kyc/telecom/verify/submit-otp\nhttps://live.finaxle.com/api/kyc/telecom/verify/submit-otp\n\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
Request Body
\n{\n \"country_code\": \"91\",\n \"mobile_number\": \"XXXXXXXX32\",\n \"otp\": \"9731\",\n \"reference_id\": \"telecom_dgda5d327e\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| country_code | \nString | \nCountry dialing code | \n
\n\n| mobile_number | \nString | \nMobile number entered in /initiate | \n
\n\n| otp | \nString | \nOTP received on the number | \n
\n\n| reference_id | \nString | \nReference ID from OTP initiation | \n
\n\n
\n
\nSample Response
\n{\n \"timestamp\": \"2025-07-18T09:48:53.926Z\",\n \"transaction_id\": \"TXN-739b0fb7-30c8-4d0c-8fc1-955103ef29a8\",\n \"status\": \"success\",\n \"data\": {\n \"dob\": \"1975-08-12\",\n \"name\": \"SUNITA SHARMA\",\n \"email\": \"sunita.sharma@example.com\",\n \"address\": \"102, Goyal Residency, Sector 5, Vikas Nagar, Lucknow, Uttar Pradesh, 226022\",\n \"billing_type\": \"prepaid\",\n \"country_code\": \"91\",\n \"extra_fields\": {},\n \"mobile_number\": \"9876543210\",\n \"alternate_phone\": \"9876501234\",\n \"mobile_network_operator\": \"Jio\"\n }\n}\n\n
\n
\nResponse Parameters (Submit OTP)
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.dob | \nString | \nDate of birth of the subscriber | \n
\n\n| data.name | \nString | \nName of the subscriber | \n
\n\n| data.email | \nString | \nEmail ID (if available) | \n
\n\n| data.address | \nString | \nRegistered address with telecom provider | \n
\n\n| data.billing_type | \nString | \nConnection type (e.g., prepaid, postpaid) | \n
\n\n| data.country_code | \nString | \nCountry code (e.g., 91) | \n
\n\n| data.extra_fields | \nObject | \nReserved for future use | \n
\n\n| data.mobile_number | \nString | \nMobile number verified | \n
\n\n| data.alternate_phone | \nString | \nAlternate mobile number (if available) | \n
\n\n| data.mobile_network_operator | \nString | \nMobile service provider (e.g., Jio, Airtel) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Telecom KYC (Initiate) | \n500–800 ms | \n
\n\n| Telecom KYC (Submit OTP) | \n600–1200 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching record found | \n
\n\n| 400 | \nBad Request | \nInvalid or missing parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nServer Error | \nInternal error; check logs | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Telecom KYC (Initiate) | \n500–800 ms | \n
\n\n| Telecom KYC (Submit OTP) | \n600–1200 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching record found | \n
\n\n| 400 | \nBad Request | \nInvalid or missing parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nServer Error | \nInternal error; check logs | \n
\n\n
\n
Introduction
\nThe Telecom KYC API allows verification of a mobile number using an OTP-based consent workflow. This helps retrieve the subscriber’s name, address, DOB, and mobile operator details for telecom-based identity verification.
\n
\nUse Cases
\n\nTelecom-based KYC: Authenticate the identity linked to a mobile number using OTP consent.
\nDigital Onboarding: Prefill verified name, address, and DOB during sign-up or onboarding flows.
\nFraud Detection: Identify ownership mismatches or unauthorized usage of mobile numbers.
\nContact Enrichment: Obtain alternate number and network provider for better customer outreach.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- UAT: https://uat.finaxle.com/api/kyc/telecom/verify
- Production: https://live.finaxle.com/api/kyc/telecom/verify | \n
\n\n| Method | \nPOST | \n
\n\n| Auth | \nBearer Token (passed in headers) | \n
\n\n
\n
\n1. Initiate OTP Request
\nEndpoint
\nhttps://uat.finaxle.com/api/kyc/telecom/verify/initiate\nhttps://live.finaxle.com/api/kyc/telecom/verify/initiate\n\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
Request Body
\n{\n \"country_code\": \"91\",\n \"mobile_number\": \"9XX6X6XX16\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| country_code | \nString | \nCountry dialing code | \n
\n\n| mobile_number | \nString | \nMobile number to be verified | \n
\n\n
\n
Sample Response
\n{\n \"timestamp\": \"2025-07-18T09:47:35.968Z\",\n \"transaction_id\": \"TXN-66913aa5-6124-4095-848a-0b01b834a0b5\",\n \"status\": \"success\",\n \"data\": {\n \"reference_id\": \"telecom_dgda5d327e\"\n }\n}\n\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.reference_id | \nString | \nUnique session ID for OTP verify | \n
\n\n
\n
\n2. Submit OTP for Verification
\nEndpoint
\nhttps://uat.finaxle.com/api/kyc/telecom/verify/submit-otp\nhttps://live.finaxle.com/api/kyc/telecom/verify/submit-otp\n\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
Request Body
\n{\n \"country_code\": \"91\",\n \"mobile_number\": \"XXXXXXXX32\",\n \"otp\": \"9731\",\n \"reference_id\": \"telecom_dgda5d327e\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| country_code | \nString | \nCountry dialing code | \n
\n\n| mobile_number | \nString | \nMobile number entered in /initiate | \n
\n\n| otp | \nString | \nOTP received on the number | \n
\n\n| reference_id | \nString | \nReference ID from OTP initiation | \n
\n\n
\n
\nSample Response
\n{\n \"timestamp\": \"2025-07-18T09:48:53.926Z\",\n \"transaction_id\": \"TXN-739b0fb7-30c8-4d0c-8fc1-955103ef29a8\",\n \"status\": \"success\",\n \"data\": {\n \"dob\": \"1975-08-12\",\n \"name\": \"SUNITA SHARMA\",\n \"email\": \"sunita.sharma@example.com\",\n \"address\": \"102, Goyal Residency, Sector 5, Vikas Nagar, Lucknow, Uttar Pradesh, 226022\",\n \"billing_type\": \"prepaid\",\n \"country_code\": \"91\",\n \"extra_fields\": {},\n \"mobile_number\": \"9876543210\",\n \"alternate_phone\": \"9876501234\",\n \"mobile_network_operator\": \"Jio\"\n }\n}\n\n
\n
\nResponse Parameters (Submit OTP)
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.dob | \nString | \nDate of birth of the subscriber | \n
\n\n| data.name | \nString | \nName of the subscriber | \n
\n\n| data.email | \nString | \nEmail ID (if available) | \n
\n\n| data.address | \nString | \nRegistered address with telecom provider | \n
\n\n| data.billing_type | \nString | \nConnection type (e.g., prepaid, postpaid) | \n
\n\n| data.country_code | \nString | \nCountry code (e.g., 91) | \n
\n\n| data.extra_fields | \nObject | \nReserved for future use | \n
\n\n| data.mobile_number | \nString | \nMobile number verified | \n
\n\n| data.alternate_phone | \nString | \nAlternate mobile number (if available) | \n
\n\n| data.mobile_network_operator | \nString | \nMobile service provider (e.g., Jio, Airtel) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Telecom KYC (Initiate) | \n500–800 ms | \n
\n\n| Telecom KYC (Submit OTP) | \n600–1200 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching record found | \n
\n\n| 400 | \nBad Request | \nInvalid or missing parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nServer Error | \nInternal error; check logs | \n
\n\n
\n
Introduction
\nThe Doctor API retrieves medical practitioner details using inputs like registration number, name, and/or state council. It helps validate professional credentials and enhances background verification and onboarding workflows for healthcare platforms and employers.
\n
\nUse Cases
\n\nDoctor Credential Verification: Validate medical registration status via official council data.
\nHealthcare Onboarding: Seamless registration of doctors on healthcare portals.
\nFraud Prevention: Detect impersonation or false qualifications in medical staff onboarding.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/doctor-verification | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n{\n \"id_number\" : \"XXXX32\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| registrationNumber | \nString | \nDoctor's registration/license number | \n\"123456\" | \n
\n\n| name | \nString | \nFull name of the doctor (optional) | \n\"Dr. Rakesh Kumar\" | \n
\n\n| stateCouncil | \nString | \nState medical council (optional) | \n\"Delhi Medical Council\" | \n
\n\n
\n
\nExample Request (cURL)
\nPOST https://uat.finaxle.com/api/doctor-verification \\\n -H \"Authorization: Bearer <your_token>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"id_number\": \"XXX23\"\n}'\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.name | \nString | \nDoctor’s full name | \n
\n\n| data.registrationNumber | \nString | \nRegistered license number | \n
\n\n| data.registrationDate | \nString (YYYY-MM-DD) | \nDate of registration | \n
\n\n| data.validity | \nString | \nStatus of registration (Active/Inactive) | \n
\n\n| data.qualifications | \nArray | \nList of qualifications (MBBS, MD, etc.) | \n
\n\n| data.stateCouncil | \nString | \nRegistered state medical council | \n
\n\n| data.councilAddress | \nString | \nCouncil's address | \n
\n\n| data.specialization | \nString | \nMedical specialization (if available) | \n
\n\n| data.contactInfo | \nObject | \nContact details if available | \n
\n\n| data.contactInfo.phone | \nString | \nPhone number | \n
\n\n| data.contactInfo.email | \nString | \nEmail address | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Doctor API | \n700–1500ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching doctor found | \n
\n\n| 422 | \nBad Request | \nInvalid or missing parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue; check logs | \n
\n\n
\n
Introduction
\nThe CA Occupation Verification API allows retrieval of verified occupational details of a Chartered Accountant using their membership number. This API helps in validating a CA’s credentials for background checks, onboarding, and KYC processes.
\n
\nUse Cases
\n\nBackground Verification: Validate if the individual is a certified Chartered Accountant.
\nKYC Enhancement: Enrich user profiles with professional information.
\nRisk Assessment: Evaluate professional credibility as part of financial profiling or credit underwriting.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URL | \n- Production: https://live.finaxle.com/api/kyc/occupation/ca | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body
\n{\n \"id_number\": \"566723\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| id_number | \nString | \nMembership number of the CA | \n\"566723\" | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.gender | \nString | \nGender of the CA (e.g., MALE/FEMALE) | \n
\n\ndata.membership_number | \nString | \nMembership number | \n
\n\ndata.member_name | \nString | \nFull name with designation | \n
\n\ndata.professional_address | \nString | \nRegistered professional address | \n
\n\ndata.professional_region | \nString | \nICAI regional zone (if available) | \n
\n\ndata.status | \nString | \nMembership status (e.g., FULL TIME, RETIRED) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| CA Occupation Check | \n300–800ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo record found for given ID | \n
\n\n| 422 | \nBad Request | \nMissing or invalid parameters | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing Bearer token | \n
\n\n| 500 | \nInternal Error | \nUnexpected issue occurred; check logs | \n
\n\n
\n
Introduction
\nThe Passport Verification API allows users to validate an Indian Passport file number and retrieve associated details such as passport number, full name, date of birth, application details, and dispatch status.
\nThis API is useful for KYC compliance, identity verification, travel documentation checks, and onboarding processes where passport information is required.
\n
\nUse Cases
\n\nVerify if a given passport file number is valid.
\nRetrieve full name, passport number, and date of birth from official records.
\nTrack the dispatch status of a passport application.
\nAutomate KYC checks for onboarding processes.
\nReduce fraud by validating genuine passport records.
\n
\n
\nAPI Details
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Base URL | \n- Live: https://live.finaxle.com/api/kyc/passport/verify | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ndob | \nString | \nDate of birth of the applicant (YYYY-MM-DD). | \n
\n\nid_number | \nString | \nPassport File Number provided at the time of application. | \n
\n\n
\n
\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| remark | \nString | \nOptional field for passing client notes, comments, or reference information. This field does not affect validation or processing but will be logged for tracking. | \nNo | \n
\n\n
\n
\nResponse Parameters
\n{\n \"timestamp\": \"2025-08-20T12:51:17.166Z\",\n \"transaction_id\": \"TXN-34c690b7-057a-41c5-ad3c-d885cb947981\",\n \"status\": \"success\",\n \"data\": {\n \"statuscode\": 200,\n \"status\": true,\n \"message\": \"Success\",\n \"reference_id\": 70261702,\n \"data\": {\n \"client_id\": \"passport_EjnAYpAmGAinfmpGyKnz\",\n \"file_number\": \"CHI067302542622\",\n \"passport_number\": \"WXX89XX1\",\n \"full_name\": \"SOMA SHARMA\",\n \"dob\": \"2002-1-22\",\n \"date_of_application\": \"2022-12-21\",\n \"application_type\": \"Normal\",\n \"status\": \"Passport W8989821 has been dispatched on 05/01/2023 via Speed Post Tracking Number PP8404XX5XXIN.\"\n }\n }\n}\n\n
\nField Descriptions
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.statuscode | \nInteger | \nAPI response status code. | \n
\n\ndata.status | \nBoolean | \nIndicates success (true) or failure (false). | \n
\n\ndata.message | \nString | \nMessage describing the response. | \n
\n\ndata.reference_id | \nInteger | \nInternal reference identifier. | \n
\n\ndata.data.client_id | \nString | \nUnique client identifier for the passport record. | \n
\n\ndata.data.file_number | \nString | \nPassport file number submitted in the request. | \n
\n\ndata.data.passport_number | \nString | \nOfficial Passport Number issued. | \n
\n\ndata.data.full_name | \nString | \nFull name of the passport holder. | \n
\n\ndata.data.dob | \nString | \nDate of birth of the applicant. | \n
\n\ndata.data.date_of_application | \nString | \nDate when the passport application was filed. | \n
\n\ndata.data.application_type | \nString | \nType of application (e.g., Normal, Tatkal). | \n
\n\ndata.data.status | \nString | \nDispatch/processing status of the passport. | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Passport | \n300–800 ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully. | \n
\n\n| 400 | \nMissing Required Parameters | \nRequired field such as dob or id_number is missing. | \n
\n\n| 401 | \nUnauthorized | \nInvalid or missing API key in the Authorization header. | \n
\n\n| 422 | \nInvalid File Number / DOB | \nFile number or DOB is invalid or not found in records. | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs. | \n
\n\n
\n
\nAdditional Notes
\n\nAlways ensure the Bearer Token is valid and active.
\nThe id_number must be a valid Passport File Number issued during application.
\nEnsure dob matches the date of birth in official records.
\nThe response includes both application details and dispatch status, making it useful for onboarding and verification workflows.
\n
\n","urlObject":{"path":["api","kyc","passport","verify"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"3a093fb6-dffc-48b5-8c0b-8ee350b30310","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dob\": \"2002-1-22\",\n \"id_number\": \"CHIXX3340254XX11\",\n \"remark\": \"Optional client note or reference\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/passport/verify"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 20 Aug 2025 12:51:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"537"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"219-CTXQc9sCPsLP7s3Su6n6kQK7t/I\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-20T12:51:17.166Z\",\n \"transaction_id\": \"TXN-34c690b7-057a-41c5-ad3c-d885cb947981\",\n \"status\": \"success\",\n \"data\": {\n \"statuscode\": 200,\n \"status\": true,\n \"message\": \"Success\",\n \"reference_id\": 70261702,\n \"data\": {\n \"client_id\": \"passport_EjnAYpAmGAinfmpGyKnz\",\n \"file_number\": \"CHI067302542622\",\n \"passport_number\": \"WXX89XX1\",\n \"full_name\": \"SOMA SHARMA\",\n \"dob\": \"2002-1-22\",\n \"date_of_application\": \"2022-12-21\",\n \"application_type\": \"Normal\",\n \"status\": \"Passport W8989821 has been dispatched on 05/01/2023 via Speed Post Tracking Number PP8404XX5XXIN.\"\n }\n }\n}"},{"id":"521aa600-335d-4542-a41a-3ee2c784ed69","name":"Bad Request(400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dob\": \"2002-1-22\",\n \"id_number\": \"CHIXX3340254X11\",\n \"remark\": \"Optional client note or reference\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/passport/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Mon, 11 Aug 2025 15:20:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"4c-+1oKK8/CbL2jjBXu7u+shUd2RUs\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Input id_number\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"c022bbf9-be26-4171-b158-bd33d4ff221f"}],"id":"fdac71d7-6f21-4af9-8341-f8ff0e2366f1","_postman_id":"fdac71d7-6f21-4af9-8341-f8ff0e2366f1","description":""},{"name":"Crime Check","item":[{"name":"CC-Initiate","id":"1d5de49d-e4a2-4ae5-97ad-7d4d582c5f5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"name\": \"HEMANT HASMUKHLAL CHEVLI\",\n \"father_name\": \"HASMUKHLAL CHEVLI\",\n \"address\": \"PLOT NO B-7B/H SHANKAR TRADING CO BHATAR CHAR RASTASURAT SURAT\",\n \"dob\": \"01-06-1968\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.finaxle.com/api/kyc/crime-check/initiate","description":"The Crime Check API performs a comprehensive background search for criminal cases associated with an individual based on their personal details. It works in two steps:
\n\nInitiate Search using personal information.
\nFetch Detailed Results using the request_id from step 1.
\n
\n
\nUse Cases
\n\nEmployment Screening: Check for any pending or historical criminal cases.
\nLending Risk Assessment: Evaluate legal exposure of loan applicants.
\nTenant or Vendor Vetting: Ensure background compliance before onboarding.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URLs | \n- Production: https://live.finaxle.com/api/kyc/crime-check | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nInitiate Crime Check
\nEndpoint
\nPOST /crime-check/initiate\n\n
Request Body
\n{\n \"name\": \"HEMANT HASMUKHLAL CHEVLI\",\n \"father_name\": \"HASMUKHLAL CHEVLI\",\n \"address\": \"PLOT NO B-7B/H SHANKAR TRADING CO BHATAR CHAR RASTASURAT SURAT\",\n \"dob\": \"01-06-1968\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| name | \nString | \nFull name of the individual | \n\"HEMANT HASMUKHLAL CHEVLI\" | \n
\n\n| father_name | \nString | \nFather’s name | \n\"HASMUKHLAL CHEVLI\" | \n
\n\n| address | \nString | \nResidential or known address | \n\"PLOT NO B-7B/H SHANKAR TRADING CO BHATAR CHAR RASTA...\" | \n
\n\n| dob | \nString | \nDate of birth in DD-MM-YYYY format | \n\"01-06-1968\" | \n
\n\n
\n
Sample Request (cURL)
\ncurl --location --globoff 'https://uat.finaxle.com/api/kyc/crime-check/initiate' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer <your_token>' \\\n--data '{\n \"name\": \"HEMANT HASMUKHLAL CHEVLI\",\n \"father_name\": \"HASMUKHLAL CHEVLI\",\n \"address\": \"PLOT NO B-7B/H SHANKAR TRADING CO BHATAR CHAR RASTASURAT SURAT\",\n \"dob\": \"01-06-1968\"\n}'\n\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| request_id | \nString | \nUnique reference ID for fetching case details | \n
\n\n
\n
Sample Response
\n{\n \"timestamp\": \"2025-07-29T07:21:52.368Z\",\n \"transaction_id\": \"TXN-3f0f09ba-8610-4762-b014-1cf23cced450\",\n \"status\": \"success\",\n \"data\": {\n \"request_id\": \"688867699341ae4b75308449__risk__possible\"\n }\n}\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Crime Check- Initiate | \n800–1500ms | \n
\n\n
\n
The Crime Check API performs a comprehensive background search for criminal cases associated with an individual based on their personal details. It works in two steps:
\n\nInitiate Search using personal information.
\nFetch Detailed Results using the request_id from step 1.
\n
\n
\nUse Cases
\n\nEmployment Screening: Check for any pending or historical criminal cases.
\nLending Risk Assessment: Evaluate legal exposure of loan applicants.
\nTenant or Vendor Vetting: Ensure background compliance before onboarding.
\n
\n
\nAPI Details
\n\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| Base URLs | \n- Production: https://live.finaxle.com/api/kyc/crime-check | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token (passed in headers) | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nFetch Crime Case Details
\nEndpoint
\nPOST /crime-check/get-details\n\n
\nRequest Body
\n{\n \"id_number\": \"688867699341ae4b75308449__risk__possible\"\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nExample Value | \n
\n\n\n\n| id_number | \nString | \nRequest ID received from initiate API | \n\"688867699341ae4b75308449__risk__possible\" | \n
\n\n
\n
Sample Request (cURL)
\ncurl --location --globoff 'https://uat.finaxle.com/api/kyc/crime-check/get-details' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer <your_token>' \\\n--data '{\n \"id_number\": \"688867699341ae4b75308449__risk__possible\"\n}'\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| total | \nInteger | \nNumber of cases found | \n
\n\n| cases[] | \nArray of Objects | \nList of matched criminal/civil cases | \n
\n\n| cases[].case_no | \nString | \nCourt case number | \n
\n\n| cases[].case_year | \nString | \nYear the case was filed | \n
\n\n| cases[].case_status | \nString | \nCurrent status (e.g., Disposed, Pending) | \n
\n\n| cases[].court_name | \nString | \nName of the court | \n
\n\n| cases[].police_station | \nString | \nPolice station involved | \n
\n\n| cases[].under_acts | \nString | \nLegal acts under which case was filed | \n
\n\n| cases[].under_sections | \nString | \nSections of law invoked | \n
\n\n| cases[].oparty | \nString | \nOpposing party (e.g., State or other) | \n
\n\n| cases[].link | \nURL | \nLink to detailed judgment or case document | \n
\n\n| cases[].algo_risk | \nString | \nAI-calculated risk level (e.g., low, high) | \n
\n\n| cases[].business_category | \nString | \nNature of crime (e.g., Serious, Cheque Bounce) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Crime Check Initiate | \n800–1500ms | \n
\n\n| Crime Check Get Details | \n700–1200ms | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Code | \nMessage | \nDescription | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \n
\n\n| 204 | \nNo Content | \nNo matching records found | \n
\n\n| 422 | \nBad Request | \nMissing or invalid request parameters | \n
\n\n| 403 | \nUnauthorized | \nBearer token missing or invalid | \n
\n\n| 500 | \nInternal Error | \nServer-side failure; check request/inputs | \n
\n\n
\n
Introduction
\nThe ITR Create Client API is used to onboard a new Income Tax Return (ITR) client into the system.
\nBy providing valid credentials (PAN and password), the API registers the client and returns a unique client_id. This client_id is essential for all future interactions with ITR-related APIs.
\n
\nUse Cases
\n\nInitialize client setup for accessing their income tax data from government portals.
\nAutomate onboarding process for tax filing, financial planning, or wealth management platforms.
\nEnable ITR-related services such as return fetching, filing history, or income analysis.
\nPre-requisite step for partners offering API-based ITR retrieval and verification.
\nCollect client authentication details securely and trigger further income tax-related workflows.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/itr/create-client | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| username | \nString | \n✅ | \nPAN of the user | \n
\n\n| password | \nString | \n✅ | \nLogin password of the PAN holder | \n
\n\n
\n
\nRequest Body (JSON)
\n{\n \"username\": \"APBPG7589H\",\n \"password\": \"Lakshay@1407\"\n}\n\n
\n
\nResponse
\n{\n \"timestamp\": \"2025-06-24T11:11:10.953Z\",\n \"transaction_id\": \"4d66756c-e77f-46a4-a03e-d50b71a127f2\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"itr_GmVxkHeGaCfpzgnwrqxp\"\n }\n}\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 400 | \nInvalid Credentials | \nIncorrect username or password. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nThis API must be called before making any other ITR-related API requests.
\nEnsure the PAN format is correct and password is valid.
\nclient_id returned in the response should be securely stored and reused for all subsequent ITR API calls.
\n
\n","urlObject":{"path":["api","itr","create-client"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"75ce02b0-4091-4858-979a-15fc1d20d31d","name":"Successful (200)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"username\": \"APBPG7589H\",\n \"password\": \"Lakshay@1407\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/create-client"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 24 Jun 2025 11:11:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"163"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"a3-8TKRY/8Cg1XTTZjmub4ohFscTYc\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-06-24T11:11:10.953Z\",\n \"transaction_id\": \"4d66756c-e77f-46a4-a03e-d50b71a127f2\",\n \"status\": \"success\",\n \"data\": {\n \"client_id\": \"itr_GmVxkHeGaCfpzgnwrqxp\"\n }\n}"}],"_postman_id":"9be79913-5c38-456b-b884-c14e3fb5f00e"},{"name":"Check Credentials","id":"9b92a196-fbac-4631-a606-c899673e9e9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_zhpcnkDknctcofJRaAmF\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/check-credentials","description":"Introduction
\nThe ITR Check Credentials API verifies whether a provided client_id exists and is valid in the system.
\nThis is a key validation step before initiating further ITR-related operations like fetching tax returns or reports.
\n
\nUse Cases
\n\nConfirm if a user has already been onboarded to the ITR system.
\nValidate the client_id before performing sensitive actions like ITR retrieval.
\nPrevent duplicate client creation by verifying existing client entries.
\nAutomate background validation for seamless user experience in tax platforms.
\nEnsure correct mapping of client_id for multi-user systems.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/itr/check-credentials | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nString | \n✅ | \nUnique identifier for the ITR client | \n
\n\n
\n
\nRequest Body (JSON)
\n{\n \"client_id\": \"itr_lEOfmmwKtjrvRaGgHhql\"\n}\n\n
\n
\nResponse Paramters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\ndata.success | \nBoolean | \nIndicates if the data operation was successful. | \n
\n\nstatus_code | \nInteger | \nHTTP status code of the response (e.g., 200). | \n
\n\nmessage_code | \nString | \nInternal message code (e.g., \"success\"). | \n
\n\nmessage | \nString | \nHuman-readable message (e.g., \"Success\"). | \n
\n\nsuccess | \nBoolean | \nOverall success status of the API call. | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 404 | \nClient Not Found | \nThe provided client ID does not exist in the system. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the client_id is valid and generated through the Create Client API.
\nThis API is especially useful for maintaining integrity in automated workflows.
\nRecommended as a preliminary check before initiating ITR data fetch or submission.
\n
\n","urlObject":{"path":["api","itr","check-credentials"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"b66476e6-1d65-4fe2-a0b2-b25a99223052","name":"Check Credentials","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_zhpcnkDknctcofJRaAmF\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/check-credentials"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 21 May 2025 11:31:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"67-05v6P2fTMUUAlrXOl5mz3P1j6QA\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"success\": true\n },\n \"status_code\": 200,\n \"message_code\": \"success\",\n \"message\": \"Success\",\n \"success\": true\n}"}],"_postman_id":"9b92a196-fbac-4631-a606-c899673e9e9e"},{"name":"Download ITR","id":"4cf8ca25-8b31-4917-8a8f-4679fbbe4efb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_lEOfmmwKtjrvRaGgHhql\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/download-itr","description":"Introduction
\nThe ITR Download API allows retrieval of ITR filing details, including the filing year, acknowledgment number, form type, filing status, and a downloadable link to the ITR document.
\nIt is essential for income verification, loan underwriting, tax compliance checks, and financial assessments.
\n
\nUse Cases
\n\nFetch official ITR records for credit underwriting or background checks.
\nValidate income claims during onboarding or loan processing.
\nDownload ITR PDFs for document verification or archiving.
\nPower user dashboards with historical tax return data.
\nAutomate compliance reporting and documentation for financial institutions.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/itr/download-itr | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nString | \n✅ | \nUnique identifier for the ITR client | \n
\n\n
\n
\nRequest Body (JSON)
\n{\n \"client_id\": \"itr_usrydGkBEqjfdsQMguMb\"\n}\n\n
\n
\nResponse Paramaters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\nstatus_code | \nInteger | \nHTTP response status code (e.g., 200 for success). | \n
\n\nsuccess | \nBoolean | \nIndicates if the API request was successful. | \n
\n\nmessage | \nString | \nMessage string describing the result of the API call. | \n
\n\nmessage_code | \nString | \nInternal message status code (e.g., \"success\"). | \n
\n\ndata.client_id | \nString | \nUnique identifier for the client. | \n
\n\ndata.pan_no | \nString | \nPAN number of the individual. | \n
\n\ndata.filed_itrs[] | \nArray of Objects | \nList of filed ITR records. | \n
\n\ndata.filed_itrs[].itr_id | \nString | \nUnique ID assigned to the ITR record. | \n
\n\ndata.filed_itrs[].pan_no | \nString | \nPAN number associated with the ITR. | \n
\n\ndata.filed_itrs[].filing_year | \nString | \nFinancial year for which the ITR was filed (e.g., \"2023-2024\"). | \n
\n\ndata.filed_itrs[].acknowledgement_no | \nString | \nAcknowledgement number received after filing. | \n
\n\ndata.filed_itrs[].itr_form | \nString | \nITR form type (e.g., \"ITR-1\", \"ITR-2\"). | \n
\n\ndata.filed_itrs[].filing_type | \nString | \nType of filing (e.g., \"Original\", \"Revised\"). | \n
\n\ndata.filed_itrs[].filing_section | \nString | \nApplicable section of Income Tax Act (e.g., \"139(1)\"). | \n
\n\ndata.filed_itrs[].filing_date | \nString (YYYY-MM-DD) | \nDate on which the ITR was filed. | \n
\n\ndata.filed_itrs[].itr_status[] | \nArray of Objects | \nStatus history for the respective ITR filing. | \n
\n\ndata.filed_itrs[].itr_status[].status | \nString | \nStatus description (e.g., \"ITR Filed\", \"Refund Paid\"). | \n
\n\ndata.filed_itrs[].itr_status[].date | \nString (YYYY-MM-DD) | \nDate associated with the status update. | \n
\n\ndata.filed_itrs[].download_link | \nString (URL) | \nLink to download the JSON version of the filed ITR. | \n
\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 404 | \nNo ITR Found | \nNo ITR records exist for the provided client_id. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected error occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nUse the client_id obtained via the Create Client API to request ITR data.
\nEnsure that the ITR filing has been completed before expecting a downloadable link.
\nThe returned download link is a direct PDF URL and can be embedded or saved as needed.
\nIf no ITRs are filed, the filed_itrs array will be empty.
\n
\n","urlObject":{"path":["api","itr","download-itr"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"f4e47662-d3e3-4e30-874d-8813b44b565e","name":"Download ITR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_lEOfmmwKtjrvRaGgHhql\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/download-itr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Tue, 06 May 2025 05:43:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1579"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"62b-TmSEr6ZlcsFWVXcN4ViRCXXTsSg\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"success\": true,\n \"message\": \"ITR downloaded successfully\",\n \"message_code\": \"success\",\n \"data\": {\n \"client_id\": \"itr_dummyclient_12345\",\n \"pan_no\": \"ABCDE1234X\",\n \"filed_itrs\": [\n {\n \"itr_id\": \"1001\",\n \"pan_no\": \"ABCDE1234X\",\n \"filing_year\": \"2023-2024\",\n \"acknowledgement_no\": \"352026160050000\",\n \"itr_form\": \"ITR-2\",\n \"filing_type\": \"Revised\",\n \"filing_section\": \"139(5)\",\n \"filing_date\": \"2024-08-05\",\n \"itr_status\": [\n {\n \"status\": \"ITR processed no demand no refund\",\n \"date\": \"2024-08-15\"\n },\n {\n \"status\": \"Successfully e-verified\",\n \"date\": \"2024-08-05\"\n },\n {\n \"status\": \"ITR Filed\",\n \"date\": \"2024-08-05\"\n }\n ],\n \"download_link\": \"https://dummy-bucket/itr/itr_dummyclient_12345/ABCDE1234X/352026160050000_json\"\n },\n {\n \"itr_id\": \"1002\",\n \"pan_no\": \"ABCDE1234X\",\n \"filing_year\": \"2022-2023\",\n \"acknowledgement_no\": \"827559950200000\",\n \"itr_form\": \"ITR-1\",\n \"filing_type\": \"Original\",\n \"filing_section\": \"139(1)\",\n \"filing_date\": \"2023-07-22\",\n \"itr_status\": [\n {\n \"status\": \"Refund Paid\",\n \"date\": \"2023-08-15\"\n },\n {\n \"status\": \"Successfully e-verified\",\n \"date\": \"2023-07-22\"\n },\n {\n \"status\": \"ITR Filed\",\n \"date\": \"2023-07-22\"\n }\n ],\n \"download_link\": \"https://dummy-bucket/itr/itr_dummyclient_12345/ABCDE1234X/827559950200000_json\"\n },\n {\n \"itr_id\": \"1003\",\n \"pan_no\": \"ABCDE1234X\",\n \"filing_year\": \"2021-2022\",\n \"acknowledgement_no\": \"675439870160000\",\n \"itr_form\": \"ITR-1\",\n \"filing_type\": \"Original\",\n \"filing_section\": \"139(1)\",\n \"filing_date\": \"2022-06-16\",\n \"itr_status\": [\n {\n \"status\": \"Refund Paid\",\n \"date\": \"2022-06-22\"\n },\n {\n \"status\": \"Successfully e-verified\",\n \"date\": \"2022-06-16\"\n },\n {\n \"status\": \"ITR Filed\",\n \"date\": \"2022-06-16\"\n }\n ],\n \"download_link\": \"https://dummy-bucket/itr/itr_dummyclient_12345/ABCDE1234X/675439870160000_json\"\n }\n ]\n }\n}"}],"_postman_id":"4cf8ca25-8b31-4917-8a8f-4679fbbe4efb"},{"name":"Reset Password","id":"4b5553fe-2127-404e-8323-9b49d325d087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"password\": \"rashal@2001\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/forget-password","description":"Introduction
\nThe ITR Reset Password API initiates a password reset request for an existing ITR client. On success, it sends an OTP to the registered contact for verification and password reset confirmation.
\n
\nUse Cases
\n\nTrigger password reset flow for users unable to log in.
\nEnable secure recovery of client credentials during onboarding.
\nAllow programmatic handling of credential updates in integrated platforms.
\nEnhance customer support automation for password recovery.
\nMaintain security and compliance by enforcing password updates via OTP.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/itr/forget-password | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nString | \n✅ | \nUnique identifier for the ITR client | \n
\n\n| password | \nString | \n✅ | \nNew password to be set | \n
\n\n
\n
\nRequest Body (JSON)
\n{\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"password\": \"Secure@123\"\n}\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 400 | \nWeak Password | \nPassword does not meet security requirements (e.g., length, special characters). | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the password meets minimum security standards (e.g., mixed case, digits, special characters).
\nThe OTP will be sent to the registered mobile/email associated with the ITR client.
\nThe actual password reset is completed upon successful OTP verification (handled separately).
\nclient_id must be valid and pre-created via the ITR Create Client API.
\n
\n","urlObject":{"path":["api","itr","forget-password"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"2b3714bc-3007-420b-854f-1e0888b4812e","name":"Reset Password( NOT FOUND)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"password\": \"rashal@2001\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/forget-password"},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 21 May 2025 11:32:03 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"163"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'none'"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n Error\n \n \n Cannot POST /api/itr/forget-password
\n \n"}],"_postman_id":"4b5553fe-2127-404e-8323-9b49d325d087"},{"name":"Submit OTP","id":"5b1552dd-e9fc-4f34-8b93-bf609943bfce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"otp\": \"232493\",\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/submit-otp","description":"Introduction
\nThe ITR Submit OTP API is used to verify the OTP sent during the password reset process. On successful OTP validation, the user's password is updated.
\n
\nUse Cases
\n\nComplete password reset after initiating it via the ITR Forgot Password API.
\nProgrammatically validate OTP for automated onboarding flows.
\nImprove user experience in integrated account recovery processes.
\nEnsure secure password changes with OTP-based verification.
\nEnforce MFA compliance during sensitive credential updates.
\n
\n
\nAPI Details
\n\n\n\n| Field | \nValue | \n
\n\n\n\n| Base URL (Live) | \nhttps://live.finaxle.com/api/itr/submit-otp | \n
\n\n| HTTP Method | \nPOST | \n
\n\n| Authentication | \nBearer Token | \n
\n\n
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer | \n✅ Yes | \n
\n\n| Content-Type | \napplication/json | \n✅ Yes | \n
\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\n| client_id | \nString | \n✅ | \nUnique identifier for the ITR client | \n
\n\n| otp | \nString | \n✅ | \nOne-time password sent to client for verification | \n
\n\n
\n
\nRequest Body (JSON)
\n{\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"otp\": \"232493\"\n}\n\n
\n
\nStatus Codes
\n\n\n\n| Status Code | \nError Message | \nDescription | \n
\n\n\n\n| 400 | \nInvalid OTP | \nThe OTP is incorrect or expired. | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key. | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected issue occurred on the server. | \n
\n\n
\n
\nAdditional Notes
\n\nThis API should be called only after a successful OTP is sent via the ITR Forgot Password API.
\nOTPs typically expire in a short time window (e.g., 5–10 minutes).
\nEnsure the client_id and OTP match the previous password reset request.
\nA successful response confirms the password has been updated and the client can now log in using the new password.
\n
\n","urlObject":{"path":["api","itr","submit-otp"],"host":["https://live.finaxle.com"],"query":[],"variable":[]}},"response":[{"id":"8b1ad038-4df5-4765-9c5f-779690f3e050","name":"Submit OTP","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"otp\": \"232493\",\n \"client_id\": \"itr_hIljWFhdruRxPAPTGzQs\",\n \"remark\": \"Optional client note or reference\"\n}"},"url":"https://live.finaxle.com/api/itr/submit-otp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.3"},{"key":"Date","value":"Wed, 21 May 2025 11:31:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"128"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"80-rsxlhoqpK7fxSO2jv9+jZcbaQCg\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"password_reset\": true\n },\n \"status_code\": 200,\n \"message_code\": \"success\",\n \"message\": \"Password reset successful\",\n \"success\": true\n}"}],"_postman_id":"5b1552dd-e9fc-4f34-8b93-bf609943bfce"}],"id":"0a27febe-661b-4d8f-a5e2-6a094379c794","description":"A set of APIs designed to automate and streamline interactions with the Income Tax Return (ITR) system. These APIs cover client creation, credential verification, OTP-based authentication, password reset, and downloading ITR documents, enabling seamless integration for tax filing and verification workflows.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"d32a2662-1f5b-4996-bf63-c0f6f1325aae"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e1cc4bdb-5e5a-4e04-bfcd-bbd3c4fb6f93"}}],"_postman_id":"0a27febe-661b-4d8f-a5e2-6a094379c794"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d7b3239c-77c2-4985-80cd-21840ec4ddc5"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"9eec2851-afe3-40fc-889d-c723a96fc477"}}],"variable":[{"id":"4c6a924d-fff5-4df5-b790-edcbf882f7b0","key":"base_url","value":"https://live.finaxle.com"},{"id":"bbd07741-469c-44af-acf3-b85c1b8bfca9","key":"token","value":"YOUR_BEARER_TOKEN"}]}