"},{"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.totalekyc.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":"87cc7d9f-b437-48eb-addd-5f8e72186059"},{"name":"PAN to CIN","id":"fa9d56b4-233b-430d-86fb-091ff7b5202b","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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"3d64b73f-7a27-4c3e-935f-5f2dad6f95f8","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.totalekyc.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":"54d38bf9-7d70-46bc-b86e-7188bb8bbee4","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.totalekyc.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":"fa9d56b4-233b-430d-86fb-091ff7b5202b"},{"name":"Mobile to Pan","id":"f9fa4d82-6d6d-4e56-8b9d-497b72e4e426","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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"ec21f3e1-e8e2-4302-b457-2c2fe5336263","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.totalekyc.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":"fadf7a64-1e22-4964-8b98-03ae309b771b","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.totalekyc.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":"f9fa4d82-6d6d-4e56-8b9d-497b72e4e426"},{"name":"PAN to Udyam Number","id":"e9ef6d6f-8c8b-40e0-aad2-7e5c7773935e","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\": \"HESPD8XXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/kyc/pan/pan-to-udyam/number","description":"Introduction
\nThe PAN to Udyam Number API allows businesses to fetch Udyam Registration Numbers linked to a given PAN (Permanent Account Number).
\nThis API helps in identifying MSME registrations associated with a PAN, enabling business verification and compliance checks.
\n
\nUse Cases
\n\nFetch Udyam Registration Number using PAN
\nIdentify MSME registrations linked to a business
\nSupport business verification and onboarding
\nEnable compliance checks for MSME classification
\nAssist in financial profiling and risk assessment
\n
\n
\nAPI Details
\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
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nPAN number (10-character alphanumeric) | \nYes | \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 | \nAPI response timestamp | \n
\n\n| transaction_id | \nstring | \nUnique transaction ID for the request | \n
\n\n| status | \nstring | \nStatus of the API response (success/failure) | \n
\n\n| data | \narray | \nList of Udyam registrations linked to the PAN | \n
\n\n| data[].udyam_number | \nstring | \nUdyam Registration Number | \n
\n\n| data[].enterprise_name | \nstring | \nName of the registered enterprise | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| PAN to Udyam Number | \n1000–3000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"id_number\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo Udyam records found for the given PAN | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe PAN to Udyam MSME Details API allows businesses to fetch MSME (Udyam) registration details linked to a given PAN number. It returns enterprise information such as MSME number, enterprise classification history, business details, location, and NIC classification.
\nThis API is useful for business verification, MSME validation, KYB processes, and lending risk assessment.
\n
\nUse Cases
\n\nVerify MSME (Udyam) registration using PAN
\nRetrieve enterprise classification (Micro/Small/Medium) history
\nFetch business details for KYB onboarding
\nValidate enterprise existence for lending/credit underwriting
\nExtract plant/location and NIC activity details
\n
\n
\nAPI Details
\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
\n{ \"id_number\": \"AAGFMXXXX\"}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nPAN number (10-character alphanumeric) | \nYes | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.msme_number | \nstring | \nUdyam registration number | \n
\n\n| data.name_of_enterprise | \nstring | \nName of the enterprise | \n
\n\n| data.major_activity | \nstring | \nPrimary business activity (e.g., Trading, Manufacturing) | \n
\n\n| data.social_category | \nstring | \nSocial category of the enterprise owner | \n
\n\n| data.date_of_commencement | \nstring | \nBusiness start date | \n
\n\n| data.state | \nstring | \nState of registration | \n
\n\n| data.date_of_udyam_registration | \nstring | \nDate of Udyam registration | \n
\n\n| data.organization_type | \nstring | \nType of organization (e.g., Partnership, Proprietorship) | \n
\n\n| data.mobile_number | \nstring | \nMasked mobile number | \n
\n\n| data.email | \nstring | \nEmail associated with enterprise | \n
\n\n| data.flat | \nstring | \nAddress flat/door number | \n
\n\n| data.name_of_building | \nstring | \nBuilding name | \n
\n\n| data.road | \nstring | \nRoad/street name | \n
\n\n| data.enterprise_type | \narray | \nList of enterprise classification history | \n
\n\n| data.enterprise_type[].classification_year | \nstring | \nFinancial year of classification | \n
\n\n| data.enterprise_type[].enterprise_type | \nstring | \nMSME category (Micro/Small/Medium) | \n
\n\n| data.enterprise_type[].classification_date | \nstring | \nDate of classification | \n
\n\n| data.location_of_plant_details | \narray | \nList of plant/unit location details | \n
\n\n| data.location_of_plant_details[].sn | \nstring | \nSerial number | \n
\n\n| data.location_of_plant_details[].unit_name | \nstring | \nUnit name | \n
\n\n| data.location_of_plant_details[].flat | \nstring | \nAddress flat | \n
\n\n| data.location_of_plant_details[].building | \nstring | \nBuilding name | \n
\n\n| data.location_of_plant_details[].village | \nstring | \nVillage/locality | \n
\n\n| data.location_of_plant_details[].block | \nstring | \nBlock | \n
\n\n| data.location_of_plant_details[].road | \nstring | \nRoad | \n
\n\n| data.location_of_plant_details[].city | \nstring | \nCity | \n
\n\n| data.location_of_plant_details[].pin | \nstring | \nPincode | \n
\n\n| data.location_of_plant_details[].state | \nstring | \nState | \n
\n\n| data.location_of_plant_details[].district | \nstring | \nDistrict | \n
\n\n| data.nic_code | \narray | \nList of NIC classification details | \n
\n\n| data.nic_code[].classification_year | \nstring | \nNIC category description | \n
\n\n| data.nic_code[].enterprise_type | \nstring | \nSpecific NIC code and activity | \n
\n\n| data.nic_code[].classification_date | \nstring | \nBusiness activity type | \n
\n\n
\n
Status Code
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeble | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nNo Data Found / Invalid PAN / Inactive PAN | \nThere is No information available on MSME Site | \nYES | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API token | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected server issue | \nNO | \n
\n\n
\n
Introduction
\nThe EPFO PAN to UAN History API allows businesses to fetch UAN (Universal Account Number) details and associated employment history using a PAN (Permanent Account Number).
\nThis API helps in linking PAN with EPFO records to enable employment verification, background checks, and financial profiling.
\n
\nUse Cases
\n\nFetch UAN linked to a PAN
\nRetrieve employment history using PAN
\nVerify employment records and tenure
\nSupport background verification and KYC processes
\nAssist in financial profiling and risk assessment
\n
\n
\nAPI Details
\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 | \nRequired | \n
\n\n\n\n| id_number | \nString | \nPAN number (10-character alphanumeric) | \nYes | \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.uan | \nstring | \nUniversal Account Number (UAN) | \n
\n\n| data.name | \nstring | \nName of the individual | \n
\n\n| data.guardian_name | \nstring | \nGuardian/Father's name | \n
\n\n| data.employment_history | \narray | \nList of employment records | \n
\n\n| data.employment_history[].establishment_name | \nstring | \nName of the organization | \n
\n\n| data.employment_history[].member_id | \nstring | \nEPFO member ID | \n
\n\n| data.employment_history[].date_of_joining | \nstring | \nEmployment start date (YYYY-MM-DD) | \n
\n\n| data.employment_history[].date_of_exit | \nstring | \nEmployment end date (YYYY-MM-DD, may be empty if currently employed) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| EPFO PAN to UAN History | \n2000–5000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"id_number\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo EPFO records found for the given PAN | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe PAN to Experian Credit Report API enables retrieval of an individual's credit report and credit score using only their PAN number. This API is optimized for quick credit profiling and is commonly used in financial services for risk assessment and underwriting.
\n
\nUse Cases
\n\nInstant Credit Profiling : Fetch credit score using PAN for quick eligibility checks.
\nLoan Underwriting : Used by NBFCs and lenders to evaluate borrower risk.
\nKYC & Risk Assessment : Enhance onboarding with credit insights.
\nPre-approved Loan Offers : Identify eligible users for instant loan approvals.
\nFraud Detection : Validate identity consistency across PAN and credit data.
\n
\n
\nAPI Details
\n
\n\n\n\n\n| Header Name | \nValue Format | \n
\n\n\n\n| Authorization | \nBearer YOUR_BEARER_TOKEN | \n
\n\n| Content-Type | \napplication/json | \n
\n\n
\n
\nRequest Body (JSON)
\n{ \"id_number\": \"MYPPS8XXXX\"}\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id_number | \nString | \nPAN card number of the user | \n
\n\n
\n
\nResponse Fields
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| data.pan | \nString | \nPAN card number | \n
\n\n| data.name | \nString | \nName of the user | \n
\n\n| data.mobile | \nString | \nUser's mobile number | \n
\n\n| data.credit_score | \nNumber | \nExperian credit score | \n
\n\n| data.client_id | \nString | \nInternal request ID | \n
\n\n| data.credit_report | \nObject | \nFull Experian credit report | \n
\n\n| credit_report.CreditProfileHeader | \nObject | \nMetadata of the report (date, version, report number) | \n
\n\n| credit_report.Current_Application | \nObject | \nDetails of current application and applicant | \n
\n\n| credit_report.CAIS_Account | \nObject | \nCredit account summary and details | \n
\n\n| credit_report.CAIS_Account.CAIS_Summary | \nObject | \nSummary of total accounts and balances | \n
\n\n| credit_report.CAIS_Account.CAIS_Account_DETAILS | \nArray | \nDetailed list of credit accounts | \n
\n\n| CAIS_Account_DETAILS[].Account_Number | \nString | \nMasked account number | \n
\n\n| CAIS_Account_DETAILS[].Account_Status | \nString | \nCurrent status of the account | \n
\n\n| CAIS_Account_DETAILS[].Current_Balance | \nString | \nOutstanding balance | \n
\n\n| CAIS_Account_DETAILS[].Credit_Limit_Amount | \nString | \nCredit limit assigned | \n
\n\n| credit_report.Match_result | \nObject | \nPAN match result indicator | \n
\n\n| credit_report.TotalCAPS_Summary | \nObject | \nEnquiry summary (last 7/30/90/180 days) | \n
\n\n| credit_report.CAPS | \nObject | \nCredit enquiry details | \n
\n\n| credit_report.NonCreditCAPS | \nObject | \nNon-credit enquiry details | \n
\n\n| credit_report.SCORE | \nObject | \nScore details | \n
\n\n| credit_report.SCORE.FCIREXScore | \nNumber | \nExperian credit score | \n
\n\n| credit_report.SCORE.FCIREXScoreConfidLevel | \nString/null | \nConfidence level of score | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| PAN to Experian Credit Report | \n800–2000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nCredit report retrieved successfully | \nYES | \n
\n\n| 200 | \nNo Record Found | \nNo Record Found at Bureau | \nYes | \n
\n\n| 400 | \nInvalid Request | \nMissing or incorrect input parameters | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \nNO | \n
\n\n| 422 | \nInvalid PAN | \nInput validation failed | \nYES (PARTIAL) | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected server error | \nNO | \n
\n\n
\n
"," "," | 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":"13019767-ebf2-460c-8849-dac675e31a8e","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.totalekyc.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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"bc8660dc-0904-4557-afa2-cc59c6ec00ee","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.totalekyc.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":"04ef39fd-f598-443c-b0e2-764971c9c87b","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.totalekyc.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":"d0e4cbc8-a280-4c5a-9a53-9b292886f2fb"}],"id":"aec54110-1646-44fb-8dc0-cab93775d301","_postman_id":"aec54110-1646-44fb-8dc0-cab93775d301","description":""},{"name":"Vehicle Registration - RC","item":[{"name":"RC Basic","id":"98435a77-4d8d-47b2-98b6-3638d15cf1a1","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.totalekyc.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.totalekyc.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
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://finb.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"698534ad-bb17-43d9-aec3-6c72104981cc","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://finb.tech\",\n \"expiry_minutes\":20,\n \"remark\" :\"Optional Field\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.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":"ccab6784-86be-4bcc-917d-01f97ab03265","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://finb.tech\",\n \"expiry_minutes\":20,\n \"remark\" :\"Optional Field\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/kyc/digilocker/initialize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unexpected token , in JSON at position 20\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"}],"_postman_id":"bc21a629-dac0-41e4-b6ed-33b71b13bc5a"},{"name":"Check Status","id":"75c75b6c-7cae-430d-a250-dc33ede3c88d","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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"remark","value":"Optional client note or reference"}],"variable":[]}},"response":[{"id":"1918dae0-0303-45da-83e0-5a763a7c3521","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.totalekyc.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.totalekyc.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":"8e0784b7-a1a4-4f0f-be83-6720397a8f38","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.totalekyc.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.totalekyc.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":"69d5f318-a08e-47f4-8e28-d6949c7e7786","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.totalekyc.com/api/kyc/digilocker/status?client_id={{client_id}}","host":["https://live.totalekyc.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":"75c75b6c-7cae-430d-a250-dc33ede3c88d"},{"name":"Check Aadhar XML","id":"20c83375-352e-409e-a3f5-b20b0d06d594","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.totalekyc.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.totalekyc.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/finbapp/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.totalekyc.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.totalekyc.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/finbapp/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 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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"1d55a8ea-f68c-47ce-a71b-f0efa6df40a0","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.totalekyc.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":"cdaac8fc-62e5-4a6d-a142-4bf9a4f88948","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.totalekyc.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":"c2846c94-be43-4f27-9cd0-bd0674447c7e","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.totalekyc.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":"a7a46de5-1518-41e4-99cd-de0c144586ab"},{"name":"Bank Verification Pennyless","id":"99e7d43c-ba65-4a85-ab2b-a51bc1d25071","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.totalekyc.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.totalekyc.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.totalekyc.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.totalekyc.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":{"id":"560e731b-3d71-435b-aaaf-38f0b6ad595c","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"47dd80d9-fe7b-4c85-bd99-0b44f3d672d6","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"510ac45d-1a8e-43ff-b844-aa3a0605cb75"},{"name":"Mobile Verification Suite","item":[{"name":"Mobile to Pan","id":"18cb0925-ccce-4455-972a-9b4b7c7b591e","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.totalekyc.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.totalekyc.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.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"7cc85639-d094-4f4b-8360-ba5e0f78a52e","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.totalekyc.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":"bc54df35-9827-4988-a539-dba315026e5f","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.totalekyc.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":"18cb0925-ccce-4455-972a-9b4b7c7b591e"},{"name":"Mobile to Name","id":"3cb93bd2-5d9d-4cfb-9c77-17b7b703e474","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.totalekyc.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.totalekyc.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.05r) | \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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"d38f74f9-26e6-4189-ad27-19ed8f609a8a","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.totalekyc.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":"b824e17b-cc20-4435-ad50-abf4f7d02390","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.totalekyc.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":"7aa41e1b-864b-4879-9195-793844569616","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.totalekyc.com/api/kyc/mobile-to-name"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"Text","header":null,"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":"3cb93bd2-5d9d-4cfb-9c77-17b7b703e474"},{"name":"Mobile to UAN","id":"f0ce4d3e-034b-40d5-8304-29c2424f5599","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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"74362eed-d04b-46b8-a7d5-4a47592afef9","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.totalekyc.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":"0f7a67bb-f71d-4dd1-b340-350da4057dca","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.totalekyc.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":"f0ce4d3e-034b-40d5-8304-29c2424f5599"},{"name":"Mobile to UAN History","id":"bb11f0c7-a0e6-4a00-82f5-1a78ebe67cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_BEARER_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile_no\": \"636153XXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/kyc/epfo/mobile-to-uan/history","description":"Introduction
\nThe EPFO Mobile to UAN History API allows businesses to fetch UAN (Universal Account Number) details linked to a mobile number, along with the user's employment history.
\nThis API helps in employment verification, background checks, and financial profiling.
\n
\nUse Cases
\n\nRetrieve UAN linked to a mobile number
\nFetch employment history of an individual
\nVerify past employers and job tenure
\nSupport background verification and KYC processes
\nEnable financial profiling and risk assessment
\n
\n
\nAPI Details
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer {{TOKEN}} | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| mobile_no | \nString | \nMobile number linked with EPFO records | \nYes | \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.uan | \nstring | \nUniversal Account Number (masked) | \n
\n\n| data.name | \nstring | \nName of the individual (masked) | \n
\n\n| data.guardian_name | \nstring | \nGuardian/Father's name (masked) | \n
\n\n| data.employment_history | \narray | \nList of employment records | \n
\n\n| data.employment_history[].establishment_name | \nstring | \nName of the organization | \n
\n\n| data.employment_history[].member_id | \nstring | \nEPFO member ID | \n
\n\n| data.employment_history[].date_of_joining | \nstring | \nEmployment start date (YYYY-MM-DD) | \n
\n\n| data.employment_history[].date_of_exit | \nstring | \nEmployment end date (YYYY-MM-DD) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| EPFO Mobile to UAN History | \n1100–3000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"mobile_no\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo EPFO records found for the given mobile number | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe EPFO Mobile to UAN History API allows businesses to fetch UAN (Universal Account Number) details linked to a mobile number, along with the user's employment history.
\nThis API helps in employment verification, background checks, and financial profiling.
\n
\nUse Cases
\n\nRetrieve UAN linked to a mobile number
\nFetch employment history of an individual
\nVerify past employers and job tenure
\nSupport background verification and KYC processes
\nEnable financial profiling and risk assessment
\n
\n
\nAPI Details
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer {{TOKEN}} | \nYes | \n
\n\n| Content-Type | \napplication/json | \nYes | \n
\n\n
\n
\nRequest Body Parameters
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| mobile_no | \nString | \nMobile number linked with EPFO records | \nYes | \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.uan | \nstring | \nUniversal Account Number (masked) | \n
\n\n| data.name | \nstring | \nName of the individual (masked) | \n
\n\n| data.guardian_name | \nstring | \nGuardian/Father's name (masked) | \n
\n\n| data.employment_history | \narray | \nList of employment records | \n
\n\n| data.employment_history[].establishment_name | \nstring | \nName of the organization | \n
\n\n| data.employment_history[].member_id | \nstring | \nEPFO member ID | \n
\n\n| data.employment_history[].date_of_joining | \nstring | \nEmployment start date (YYYY-MM-DD) | \n
\n\n| data.employment_history[].date_of_exit | \nstring | \nEmployment end date (YYYY-MM-DD) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| EPFO Mobile to UAN History | \n1100–3000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"mobile_no\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo EPFO records found for the given mobile number | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe EPFO UAN History API allows businesses to fetch employment history details associated with a given UAN (Universal Account Number).
\nThis API provides verified employment records including organization names, joining dates, and exit dates, helping in background verification and financial profiling.
\n
\nUse Cases
\n\nRetrieve employment history using UAN
\nVerify past employment records and tenure
\nSupport background verification processes
\nAssist in financial risk assessment
\nEnable KYC and compliance checks
\n
\n
\nAPI Details
\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 | \nRequired | \n
\n\n\n\n| uan | \nString | \nUniversal Account Number (UAN) of the individual | \nYes | \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.uan | \nstring | \nUniversal Account Number (UAN) | \n
\n\n| data.name | \nstring | \nName of the individual | \n
\n\n| data.guardian_name | \nstring | \nGuardian/Father's name | \n
\n\n| data.employment_history | \narray | \nList of employment records | \n
\n\n| data.employment_history[].establishment_name | \nstring | \nName of the organization | \n
\n\n| data.employment_history[].member_id | \nstring | \nEPFO member ID | \n
\n\n| data.employment_history[].date_of_joining | \nstring | \nEmployment start date (YYYY-MM-DD) | \n
\n\n| data.employment_history[].date_of_exit | \nstring | \nEmployment end date (YYYY-MM-DD) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| EPFO UAN History | \n1100–3000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"uan\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo EPFO records found for the given UAN | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe Voter ID Verification API allows businesses to verify the authenticity of a Voter ID (EPIC number) and retrieve associated electoral details.
\nThis API helps in identity verification, KYC compliance, and fraud prevention by validating voter records from official sources.
\n
\nUse Cases
\n\nValidate authenticity of a Voter ID (EPIC number)
\nRetrieve voter demographic and constituency details
\nSupport KYC and identity verification processes
\nPrevent identity fraud using verified electoral data
\nAssist in address and regional verification
\n
\n
\nAPI Details
\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 | \nRequired | \n
\n\n\n\n| id_number | \nString | \nVoter ID / EPIC number | \nYes | \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.epic_no | \nstring | \nVoter ID (EPIC number) | \n
\n\n| data.name | \nstring | \nName of the voter | \n
\n\n| data.gender | \nstring | \nGender of the voter | \n
\n\n| data.dob | \nstring | \nDate of birth (if available, else null) | \n
\n\n| data.age | \nstring | \nAge of the voter | \n
\n\n| data.rln_name | \nstring | \nRelative's name (Father/Husband etc.) | \n
\n\n| data.rln_type | \nstring | \nRelationship type (e.g., FTHR) | \n
\n\n| data.state | \nstring | \nState name | \n
\n\n| data.district | \nstring | \nDistrict name | \n
\n\n| data.area | \nstring | \nArea/locality details | \n
\n\n| data.house_no | \nstring | \nHouse number (if available) | \n
\n\n| data.ac_name | \nstring | \nAssembly constituency name | \n
\n\n| data.ac_no | \nstring | \nAssembly constituency number | \n
\n\n| data.pc_name | \nstring | \nParliamentary constituency name | \n
\n\n| data.parliamentary_name | \nstring | \nParliamentary constituency name | \n
\n\n| data.parliamentary_number | \nstring | \nParliamentary constituency number | \n
\n\n| data.ps_name | \nstring | \nPolling station name | \n
\n\n| data.ps_lat_long | \nstring | \nPolling station latitude & longitude | \n
\n\n| data.part_no | \nstring | \nPart number | \n
\n\n| data.part_name | \nstring | \nPart name | \n
\n\n| data.section_no | \nstring | \nSection number | \n
\n\n| data.slno_inpart | \nstring | \nSerial number in part | \n
\n\n| data.multiple | \nboolean | \nIndicates if multiple records exist | \n
\n\n| data.last_update | \nstring | \nLast updated date of record | \n
\n\n| data.id | \nstring | \nUnique voter record ID | \n
\n\n| data.st_code | \nstring | \nState code | \n
\n\n| data.name_v1 | \nstring | \nName in regional language | \n
\n\n| data.name_v2 | \nstring | \nAlternate name format | \n
\n\n| data.name_v3 | \nstring | \nName split/variation | \n
\n\n| data.rln_name_v1 | \nstring | \nRelative name in regional language | \n
\n\n| data.rln_name_v2 | \nstring | \nRelative name variation | \n
\n\n| data.rln_name_v3 | \nstring | \nRelative name variation | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Voter ID Verification | \n1000–5000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"id_number\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nInvalid Voter ID / No Records Found | \nNo data found for the given EPIC number | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"f7110b0d-cf79-46e1-b9d6-69ceecb6286a","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.totalekyc.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":"7be46f51-5943-4f85-a765-6f8c375b947b","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.totalekyc.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":"c13f11d9-4230-4e6b-bd1f-301c7680cafa"},{"name":"GSTIN to Mobile & Email","id":"28168dca-aee5-4f4b-9d6c-648127a90ef7","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.totalekyc.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.totalekyc.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
Introduction
\nThe GST Filing Details API enables businesses to retrieve detailed GST return filing information associated with a GSTIN. The API provides comprehensive taxpayer information including registration details, filing status, filing frequency, HSN/SAC details, Aadhaar validation status, jurisdiction data, and core business activity insights.
\nThis API is ideal for GST compliance verification, vendor due diligence, financial underwriting, and regulatory audits.
\n
\nUse Case
\n1. GST Return Filing Compliance Verification
\nBusinesses and financial institutions can verify whether a GST-registered entity is actively filing GST returns and maintaining tax compliance.
\n✅ Verifies latest GSTR filing activity
\n✅ Identifies filing frequency (Monthly/Quarterly)
\n✅ Assesses return filing regularity and compliance health
\n
\n2. Vendor & Supplier Due Diligence
\nProcurement teams can validate supplier GST profiles and ensure vendors are operational and compliant before onboarding.
\n✅ Confirms active GST registration
\n✅ Verifies registered business address and legal entity name
\n✅ Checks taxpayer category and business activity
\n
\n3. Loan Underwriting & Business Credit Assessment
\nLenders and NBFCs can analyze GST filing behavior to assess operational continuity and business authenticity.
\n✅ Evaluates business compliance history
\n✅ Confirms active taxpayer status
\n✅ Validates business existence and longevity
\n
\n4. Marketplace & Merchant Onboarding
\nE-commerce platforms and aggregators can validate seller GST details and filing activity before enabling transactions.
\n✅ Reduces fraudulent seller onboarding
\n✅ Verifies Aadhaar-authenticated GST registrations
\n✅ Ensures GST compliance for marketplace operations
\n
\n5. Internal Compliance & Tax Audits
\nCompliance and finance teams can automate GST return verification for audit readiness and regulatory checks.
\n✅ Validates GST filing records
\n✅ Confirms GSTIN-PAN linkage
\n✅ Assists in identifying inactive or non-compliant entities
\n
\nAPI Details
\n\n\n\n| Environment | \nURL | \n
\n\n\n\n| Live | \nhttps://live.totalekyc.com/api/corporate/gstin/filling-details | \n
\n\n
\n
HTTP Method
\nPOST
\nAuthentication
\nBearer Token
\n
\n\n\n\n\n| Header Name | \nValue Format | \nRequired | \n
\n\n\n\n| Authorization | \nBearer Token | \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
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| status | \nString | \nStatus of API response | \n
\n\n| data.address_details | \nObject | \nAdditional address details of the GST entity | \n
\n\n| data.address_details.adr | \nString | \nRegistered address of the GST entity | \n
\n\n| data.einvoice_status | \nBoolean | \nIndicates whether e-Invoicing is enabled | \n
\n\n| data.client_id | \nString | \nUnique client identifier | \n
\n\n| data.gstin | \nString | \nGST Identification Number | \n
\n\n| data.pan_number | \nString | \nPAN linked to the GSTIN | \n
\n\n| data.fy | \nString | \nFinancial year for filing details | \n
\n\n| data.business_name | \nString | \nTrade name/business name | \n
\n\n| data.legal_name | \nString | \nLegal registered name | \n
\n\n| data.center_jurisdiction | \nString | \nCentral GST jurisdiction details | \n
\n\n| data.state_jurisdiction | \nString | \nState GST jurisdiction details | \n
\n\n| data.date_of_registration | \nString (YYYY-MM-DD) | \nGST registration date | \n
\n\n| data.constitution_of_business | \nString | \nConstitution type of business | \n
\n\n| data.taxpayer_type | \nString | \nGST taxpayer category | \n
\n\n| data.gstin_status | \nString | \nCurrent GSTIN status | \n
\n\n| data.date_of_cancellation | \nString (YYYY-MM-DD) | \nGST cancellation date if applicable | \n
\n\n| data.field_visit_conducted | \nString | \nIndicates whether field verification was conducted | \n
\n\n| data.nature_bus_activities | \nArray of Strings | \nNature of business activities | \n
\n\n| data.nature_of_core_business_activity_code | \nString | \nCore business activity code | \n
\n\n| data.nature_of_core_business_activity_description | \nString | \nDescription of core business activity | \n
\n\n| data.aadhaar_validation | \nString | \nAadhaar validation status | \n
\n\n| data.aadhaar_validation_date | \nString (YYYY-MM-DD) | \nAadhaar validation date | \n
\n\n| data.filing_status | \nArray | \nGST return filing history | \n
\n\n| data.filing_status[].FINANCIAL_YEAR | \nString | \nFinancial year of filing | \n
\n\n| data.filing_status[].TAX_PERIOD | \nString | \nTax period/month | \n
\n\n| data.filing_status[].MODE_OF_FILING | \nString | \nFiling mode | \n
\n\n| data.filing_status[].DATE_OF_FILING | \nString | \nDate of return filing | \n
\n\n| data.filing_status[].RETURN_TYPE | \nString | \nGST return type | \n
\n\n| data.filing_status[].ARN | \nString | \nAcknowledgement Reference Number | \n
\n\n| data.filing_status[].STATUS | \nString | \nFiling status | \n
\n\n| data.address | \nString | \nComplete registered address | \n
\n\n| data.hsn_info | \nObject | \nHSN/SAC information | \n
\n\n| data.hsn_info.GOODS_DETAILS | \nArray | \nGoods HSN details | \n
\n\n| data.hsn_info.SERVICE_DETAILS | \nArray | \nService SAC details | \n
\n\n| data.hsn_info.SERVICE_DETAILS[].SERVICE_CODE | \nString | \nService accounting code | \n
\n\n| data.hsn_info.SERVICE_DETAILS[].DESCRIPTION | \nString | \nDescription of service | \n
\n\n| data.filing_frequency | \nArray | \nGST return filing frequency details | \n
\n\n| data.filing_frequency[].FINANCIAL_YEAR | \nString | \nFinancial year | \n
\n\n| data.filing_frequency[].RETURN_TYPE | \nString | \nGST return type | \n
\n\n| data.filing_frequency[].FREQUENCY | \nString | \nFiling frequency | \n
\n\n| data.filing_frequency[].TAX_PERIODS | \nArray of Strings | \nTax periods applicable | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| GST Filing Details | \n4000–19000 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 | \nBad Request | \nWrong Input | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API token | \n
\n\n| 422 | \nInvalid GST Number | \nProvided GSTIN is invalid or unavailable | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected server-side error | \n
\n\n
\n
\nAdditional Notes
\n\nEnsure the Bearer Token is active and valid for all requests.
\nGSTIN must be a valid 15-character alphanumeric identifier.
\nFiling history availability depends on GST portal reporting.
\nHSN/SAC details may vary depending on taxpayer disclosures.
\nAadhaar validation details are returned if available from GST records.
\nThe API is suitable for onboarding, underwriting, vendor verification, and GST compliance workflows.
\n
\n","urlObject":{"path":["api","corporate","gstin","filling-details"],"host":["https://live.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"58ce9f37-6ea9-4af0-8e7a-7ec2bd4bb00d","name":"Successfull (200)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_number\": \"36AAJCT2376FXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/corporate/gstin/filling-details"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Mon, 11 May 2026 11:37:09 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1932"},{"key":"content-security-policy","value":"default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'"},{"key":"x-frame-options","value":"DENY"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"referrer-policy","value":"no-referrer"},{"key":"permissions-policy","value":"geolocation=(), camera=(), microphone=(), payment=()"},{"key":"cache-control","value":"no-store"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-ratelimit-limit","value":"100"},{"key":"x-ratelimit-remaining","value":"99"},{"key":"x-ratelimit-reset","value":"1"},{"key":"etag","value":"W/\"78c-WG/L7zZGH8SHzKWD4cW6kkfaXWA\""}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-05-11T11:37:09.587Z\",\n \"transaction_id\": \"TXN-PROD-e4032913-054d-4b45-bd6c-1ad818dce42c\",\n \"status\": \"success\",\n \"data\": {\n \"address_details\": {\n \"adr\": \"PLOT NO.45, GREEN VALLEY TECH PARK, SECTOR 62, Noida, Gautam Buddha Nagar, Uttar Pradesh, 201309\"\n },\n \"einvoice_status\": true,\n \"client_id\": \"corporate_gstin_Elzuhf0FRaM1X7ZUI4VO\",\n \"gstin\": \"27AABCU9603R1ZX\",\n \"pan_number\": \"AABCU9603R\",\n \"fy\": \"2026-27\",\n \"business_name\": \"URBANEDGE TECHNOLOGIES PRIVATE LIMITED\",\n \"legal_name\": \"URBANEDGE TECHNOLOGIES PRIVATE LIMITED\",\n \"center_jurisdiction\": \"State - CBIC, Zone - NOIDA, Commissionerate - NOIDA, Division - SECTOR 62, Range - NOIDA RANGE III\",\n \"state_jurisdiction\": \"State - Uttar Pradesh, Division - Noida, Circle - SECTOR 62\",\n \"date_of_registration\": \"2022-08-15\",\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\": \"Yes\",\n \"nature_bus_activities\": [\n \"Supplier of Services\",\n \"Office / Sale Office\"\n ],\n \"nature_of_core_business_activity_code\": \"ITD\",\n \"nature_of_core_business_activity_description\": \"Information Technology Services\",\n \"aadhaar_validation\": \"Yes\",\n \"aadhaar_validation_date\": \"2023-01-18\",\n \"filing_status\": [\n {\n \"FINANCIAL_YEAR\": \"2026-2027\",\n \"TAX_PERIOD\": \"April\",\n \"MODE_OF_FILING\": \"ONLINE\",\n \"DATE_OF_FILING\": \"10/05/2026\",\n \"RETURN_TYPE\": \"GSTR1\",\n \"ARN\": \"AA270526009876A\",\n \"STATUS\": \"Filed\"\n },\n {\n \"FINANCIAL_YEAR\": \"2026-2027\",\n \"TAX_PERIOD\": \"March\",\n \"MODE_OF_FILING\": \"ONLINE\",\n \"DATE_OF_FILING\": \"11/04/2026\",\n \"RETURN_TYPE\": \"GSTR3B\",\n \"ARN\": \"AA270426007654B\",\n \"STATUS\": \"Filed\"\n }\n ],\n \"address\": \"PLOT NO.45, GREEN VALLEY TECH PARK, SECTOR 62, Noida, Gautam Buddha Nagar, Uttar Pradesh, 201309\",\n \"hsn_info\": {\n \"GOODS_DETAILS\": [\n {\n \"HSN_CODE\": \"84713010\",\n \"DESCRIPTION\": \"Personal Computers\"\n }\n ],\n \"SERVICE_DETAILS\": [\n {\n \"SERVICE_CODE\": \"998313\",\n \"DESCRIPTION\": \"Information technology consulting and support services\"\n },\n {\n \"SERVICE_CODE\": \"998314\",\n \"DESCRIPTION\": \"IT infrastructure and network management services\"\n }\n ]\n },\n \"filing_frequency\": [\n {\n \"FINANCIAL_YEAR\": \"2026-27\",\n \"RETURN_TYPE\": \"GSTR1\",\n \"FREQUENCY\": \"Monthly\",\n \"TAX_PERIODS\": [\n \"January\",\n \"February\",\n \"March\",\n \"April\"\n ]\n }\n ]\n }\n}"},{"id":"1361d168-2ac8-4d2b-ab83-1ea31d117dc4","name":"Invalid Details (422)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR_BEARER_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_number\": \"36AAJCT345FXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/corporate/gstin/filling-details"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":":status","value":422},{"key":"date","value":"Mon, 11 May 2026 11:54:13 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"158"},{"key":"content-security-policy","value":"default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'"},{"key":"x-frame-options","value":"DENY"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"referrer-policy","value":"no-referrer"},{"key":"permissions-policy","value":"geolocation=(), camera=(), microphone=(), payment=()"},{"key":"cache-control","value":"no-store"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-ratelimit-limit","value":"100"},{"key":"x-ratelimit-remaining","value":"99"},{"key":"x-ratelimit-reset","value":"1"},{"key":"etag","value":"W/\"9e-Ut32VSE0V00CwLRox8/geX98D8A\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"timestamp\": \"2026-05-11T11:54:13.538Z\",\n \"transaction_id\": \"TXN-PROD-7c0525de-ecc6-4b86-9892-ba2ee3fab8a4\",\n \"error_message\": \"Invalid GST Number\"\n}"}],"_postman_id":"0f298c4c-0c1a-4612-89eb-769a3dbcf943"},{"name":"TAN Verify","id":"9ca87e11-80de-47af-bf16-3b069caf6772","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.totalekyc.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.totalekyc.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 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.finb.io/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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"c1b07c6b-bd0b-40ef-9278-a50ce972f3ce","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.totalekyc.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":"11a177a9-dbf2-43d2-bbd2-690fdeb7f296"},{"name":"DIN to Contact","id":"f764a32d-6f60-4284-8796-852441d24c3f","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://live.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.totalekyc.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 | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 200 | \nNo Data Found | \nNo Record Found for the given DIN | \nYES | \n
\n\n| 422 | \nInvalid DIN | \nDIN is invalid or unregistered | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nServer-side processing error | \nNO | \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":{"path":["api","kyc","din","contact"],"host":["https://live.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"b1d07c28-3fe0-4a42-9cc6-4f295f4053e6","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://live.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":"95a8051d-6b2f-4396-9a06-3591eec21861","name":"No Data Found (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\" : \"072351XX\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.totalekyc.com/api/kyc/din/contact"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4edac65d-cb95-4920-8d66-293627c1decf","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://live.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":"f764a32d-6f60-4284-8796-852441d24c3f"},{"name":"Mobile to UAN","id":"5fad28f0-41fb-4e33-aebf-25673b321b92","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.totalekyc.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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"7e271e0e-edfa-4b3d-bf6d-bc21d19dfef8","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.totalekyc.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":"3cc32a4f-3041-41fe-a4cf-4bfd6451184d","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.totalekyc.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":"5fad28f0-41fb-4e33-aebf-25673b321b92"},{"name":"UDYAM Details","id":"80e0fbe7-ba3f-4ea8-adb7-820ce5cb173f","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 \"msme\": \"UDYAM-DL-07-000XXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/msme/udhyam/details","description":"Introduction
\nThe Udyam Details API allows businesses to fetch MSME (Udyam) registration details using the Udyam Registration Number. It provides comprehensive information such as enterprise details, classification history, address, plant locations, and NIC activity classification.
\nThis API is useful for MSME verification, KYB workflows, lending decisions, and compliance processes.
\n
\nUse Cases
\n\nFetch MSME/Udyam details using registration number
\nVerify authenticity of MSME registration
\nRetrieve enterprise classification and activity details
\nEnable KYB (Know Your Business) verification
\nSupport MSME lending and underwriting workflows
\n
\n
\nAPI Details
\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 | \nRequired | \n
\n\n\n\n| msme | \nString | \nUdyam Registration Number (UDYAM format) | \nYes | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.msme_number | \nstring | \nUdyam registration number | \n
\n\n| data.name_of_enterprise | \nstring | \nName of the enterprise | \n
\n\n| data.organization_type | \nstring | \nType of organization | \n
\n\n| data.major_activity | \nstring | \nPrimary business activity | \n
\n\n| data.social_category | \nstring | \nSocial category of the owner | \n
\n\n| data.date_of_commencement | \nstring | \nBusiness commencement date | \n
\n\n| data.date_of_udyam_registration | \nstring | \nUdyam registration date | \n
\n\n| data.mobile_number | \nstring | \nMasked mobile number | \n
\n\n| data.email | \nstring | \nRegistered email ID | \n
\n\n| data.flat | \nstring | \nFlat/house number | \n
\n\n| data.road | \nstring | \nStreet/road name | \n
\n\n| data.name_of_building | \nstring | \nBuilding name | \n
\n\n| data.state | \nstring | \nState name | \n
\n\n| data.enterprise_type | \narray | \nMSME classification history | \n
\n\n| data.enterprise_type[].classification_year | \nstring | \nFinancial year | \n
\n\n| data.enterprise_type[].enterprise_type | \nstring | \nEnterprise category (Micro/Small/Medium) | \n
\n\n| data.enterprise_type[].classification_date | \nstring | \nClassification date | \n
\n\n| data.location_of_plant_details | \narray | \nPlant/unit location details | \n
\n\n| data.location_of_plant_details[].unit_name | \nstring | \nName of the unit | \n
\n\n| data.location_of_plant_details[].flat | \nstring | \nFlat/shop number | \n
\n\n| data.location_of_plant_details[].building | \nstring | \nBuilding name | \n
\n\n| data.location_of_plant_details[].village | \nstring | \nVillage/locality | \n
\n\n| data.location_of_plant_details[].block | \nstring | \nBlock/area | \n
\n\n| data.location_of_plant_details[].road | \nstring | \nRoad/street | \n
\n\n| data.location_of_plant_details[].district | \nstring | \nDistrict name | \n
\n\n| data.location_of_plant_details[].city | \nstring | \nCity name | \n
\n\n| data.location_of_plant_details[].state | \nstring | \nState name | \n
\n\n| data.location_of_plant_details[].pin | \nstring | \nPincode | \n
\n\n| data.location_of_plant_details[].sn | \nstring | \nSerial number of unit | \n
\n\n| data.nic_code | \narray | \nNIC activity classification | \n
\n\n| data.nic_code[].classification_year | \nstring | \nNIC 2-digit category | \n
\n\n| data.nic_code[].enterprise_type | \nstring | \nNIC 5-digit activity description | \n
\n\n| data.nic_code[].classification_date | \nstring | \nActivity type (Manufacturing/Services) | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Udyam Details | \n500–2000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"msme\" is missing | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \nNO | \n
\n\n| 422 | \nNo Data Found | \nNo Udyam Details Found | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue | \nNO | \n
\n\n
\n
Introduction
\nThe PAN to Udyam MSME Details API allows businesses to fetch MSME (Udyam) registration details linked to a given PAN number. It returns enterprise information such as MSME number, enterprise classification history, business details, location, and NIC classification.
\nThis API is useful for business verification, MSME validation, KYB processes, and lending risk assessment.
\n
\nUse Cases
\n\nVerify MSME (Udyam) registration using PAN
\nRetrieve enterprise classification (Micro/Small/Medium) history
\nFetch business details for KYB onboarding
\nValidate enterprise existence for lending/credit underwriting
\nExtract plant/location and NIC activity details
\n
\n
\nAPI Details
\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
\n{ \"id_number\": \"AAGFMXXXX\"}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nPAN number (10-character alphanumeric) | \nYes | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.msme_number | \nstring | \nUdyam registration number | \n
\n\n| data.name_of_enterprise | \nstring | \nName of the enterprise | \n
\n\n| data.major_activity | \nstring | \nPrimary business activity (e.g., Trading, Manufacturing) | \n
\n\n| data.social_category | \nstring | \nSocial category of the enterprise owner | \n
\n\n| data.date_of_commencement | \nstring | \nBusiness start date | \n
\n\n| data.state | \nstring | \nState of registration | \n
\n\n| data.date_of_udyam_registration | \nstring | \nDate of Udyam registration | \n
\n\n| data.organization_type | \nstring | \nType of organization (e.g., Partnership, Proprietorship) | \n
\n\n| data.mobile_number | \nstring | \nMasked mobile number | \n
\n\n| data.email | \nstring | \nEmail associated with enterprise | \n
\n\n| data.flat | \nstring | \nAddress flat/door number | \n
\n\n| data.name_of_building | \nstring | \nBuilding name | \n
\n\n| data.road | \nstring | \nRoad/street name | \n
\n\n| data.enterprise_type | \narray | \nList of enterprise classification history | \n
\n\n| data.enterprise_type[].classification_year | \nstring | \nFinancial year of classification | \n
\n\n| data.enterprise_type[].enterprise_type | \nstring | \nMSME category (Micro/Small/Medium) | \n
\n\n| data.enterprise_type[].classification_date | \nstring | \nDate of classification | \n
\n\n| data.location_of_plant_details | \narray | \nList of plant/unit location details | \n
\n\n| data.location_of_plant_details[].sn | \nstring | \nSerial number | \n
\n\n| data.location_of_plant_details[].unit_name | \nstring | \nUnit name | \n
\n\n| data.location_of_plant_details[].flat | \nstring | \nAddress flat | \n
\n\n| data.location_of_plant_details[].building | \nstring | \nBuilding name | \n
\n\n| data.location_of_plant_details[].village | \nstring | \nVillage/locality | \n
\n\n| data.location_of_plant_details[].block | \nstring | \nBlock | \n
\n\n| data.location_of_plant_details[].road | \nstring | \nRoad | \n
\n\n| data.location_of_plant_details[].city | \nstring | \nCity | \n
\n\n| data.location_of_plant_details[].pin | \nstring | \nPincode | \n
\n\n| data.location_of_plant_details[].state | \nstring | \nState | \n
\n\n| data.location_of_plant_details[].district | \nstring | \nDistrict | \n
\n\n| data.nic_code | \narray | \nList of NIC classification details | \n
\n\n| data.nic_code[].classification_year | \nstring | \nNIC category description | \n
\n\n| data.nic_code[].enterprise_type | \nstring | \nSpecific NIC code and activity | \n
\n\n| data.nic_code[].classification_date | \nstring | \nBusiness activity type | \n
\n\n
\n
Status Code
\n\n\n\n| Status Code | \nMessage | \nDescription | \nChargeble | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 422 | \nNo Data Found / Invalid PAN / Inactive PAN | \nThere is No information available on MSME Site | \nYES | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API token | \nNO | \n
\n\n| 500 | \nInternal Server Error | \nUnexpected server issue | \nNO | \n
\n\n
\n
Introduction
\nThe PAN to Udyam Number API allows businesses to fetch Udyam Registration Numbers linked to a given PAN (Permanent Account Number).
\nThis API helps in identifying MSME registrations associated with a PAN, enabling business verification and compliance checks.
\n
\nUse Cases
\n\nFetch Udyam Registration Number using PAN
\nIdentify MSME registrations linked to a business
\nSupport business verification and onboarding
\nEnable compliance checks for MSME classification
\nAssist in financial profiling and risk assessment
\n
\n
\nAPI Details
\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
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| id_number | \nString | \nPAN number (10-character alphanumeric) | \nYes | \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 | \nAPI response timestamp | \n
\n\n| transaction_id | \nstring | \nUnique transaction ID for the request | \n
\n\n| status | \nstring | \nStatus of the API response (success/failure) | \n
\n\n| data | \narray | \nList of Udyam registrations linked to the PAN | \n
\n\n| data[].udyam_number | \nstring | \nUdyam Registration Number | \n
\n\n| data[].enterprise_name | \nstring | \nName of the registered enterprise | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| PAN to Udyam Number | \n1000–3000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"id_number\" is missing from the request | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key in the Authorization header | \nNO | \n
\n\n| 422 | \nNo Records Found | \nNo Udyam records found for the given PAN | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue. Retry or check logs | \nNO | \n
\n\n
\n
Introduction
\nThe Mobile to Udyam Detail API allows businesses to fetch Udyam (MSME) registration details using a registered mobile number. It returns enterprise information such as business name, type, classification, address, NIC activity details, and registration metadata.
\nThis API is useful for MSME verification, business onboarding, risk assessment, and compliance workflows.
\n
\nUse Cases
\n\nFetch Udyam (MSME) details using mobile number
\nVerify business registration and enterprise classification
\nRetrieve enterprise name, address, and activity details
\nAssist in MSME-based lending and underwriting
\nEnable KYB (Know Your Business) and onboarding workflows
\n
\n
\nAPI Details
\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
\n\n\n\n| Parameter | \nType | \nDescription | \nRequired | \n
\n\n\n\n| mobile_no | \nString | \nRegistered mobile number linked with Udyam | \nYes | \n
\n\n
\n
\nResponse Parameters
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| data.enterprise_name | \nstring | \nName of the enterprise | \n
\n\n| data.organisation_type | \nstring | \nType of organization (e.g., Proprietary) | \n
\n\n| data.service_type | \nstring | \nNature of business (Manufacturing/Services/Trading) | \n
\n\n| data.gender | \nstring | \nGender of the proprietor | \n
\n\n| data.social_category | \nstring | \nSocial category of the owner | \n
\n\n| data.date_of_incorporation | \nstring | \nDate of incorporation (DD/MM/YYYY) | \n
\n\n| data.date_of_commencement | \nstring | \nBusiness commencement date | \n
\n\n| data.mobile | \nstring | \nMasked mobile number | \n
\n\n| data.email | \nstring | \nRegistered email ID | \n
\n\n| data.address.flat_no | \nstring | \nFlat/shop number | \n
\n\n| data.address.building | \nstring | \nBuilding name | \n
\n\n| data.address.village | \nstring | \nVillage/locality | \n
\n\n| data.address.block | \nstring | \nBlock/area | \n
\n\n| data.address.street | \nstring | \nStreet name | \n
\n\n| data.address.district | \nstring | \nDistrict name | \n
\n\n| data.address.city | \nstring | \nCity name | \n
\n\n| data.address.state | \nstring | \nState name | \n
\n\n| data.address.pin | \nstring | \nPincode | \n
\n\n| data.plant_details | \narray | \nList of plant/unit addresses | \n
\n\n| data.plant_details[].unit_name | \nstring | \nName of the unit | \n
\n\n| data.plant_details[].flat | \nstring | \nFlat/shop number | \n
\n\n| data.plant_details[].building | \nstring | \nBuilding name | \n
\n\n| data.plant_details[].village | \nstring | \nVillage/locality | \n
\n\n| data.plant_details[].block | \nstring | \nBlock/area | \n
\n\n| data.plant_details[].road | \nstring | \nRoad/street | \n
\n\n| data.plant_details[].district | \nstring | \nDistrict | \n
\n\n| data.plant_details[].city | \nstring | \nCity | \n
\n\n| data.plant_details[].state | \nstring | \nState | \n
\n\n| data.plant_details[].pin | \nstring | \nPincode | \n
\n\n| data.enterprise_type | \narray | \nMSME classification details | \n
\n\n| data.enterprise_type[].classification_year | \nstring | \nFinancial year | \n
\n\n| data.enterprise_type[].enterprise_type | \nstring | \nEnterprise category (Micro/Small/Medium) | \n
\n\n| data.enterprise_type[].classification_date | \nstring | \nClassification date (if available) | \n
\n\n| data.nic_code | \narray | \nNIC activity details | \n
\n\n| data.nic_code[].nic_2_digit | \nstring | \n2-digit NIC code description | \n
\n\n| data.nic_code[].nic_4_digit | \nstring | \n4-digit NIC code description | \n
\n\n| data.nic_code[].nic_5_digit | \nstring | \n5-digit NIC code description | \n
\n\n| data.nic_code[].activity | \nstring | \nType of activity (Trading/Manufacturing/Services) | \n
\n\n| data.nic_code[].date | \nstring | \nActivity registration date | \n
\n\n| data.dic | \nstring | \nDistrict Industries Centre | \n
\n\n| data.msme-dfo | \nstring | \nMSME Development Facilitation Office | \n
\n\n| data.date_of_udyam_registeration | \nstring | \nUdyam registration date | \n
\n\n
\n
\nLatency Metrics
\n\n\n\n| API Call | \nAverage Latency | \n
\n\n\n\n| Mobile to Udyam Detail | \n500–2000 ms | \n
\n\n
\n
\nStatus Code
\n\n\n\n| Status Code | \nError Message | \nDescription | \nChargeable | \n
\n\n\n\n| 200 | \nSuccess | \nRequest processed successfully | \nYES | \n
\n\n| 400 | \nMissing Required Parameters | \n\"mobile_no\" is missing | \nNO | \n
\n\n| 403 | \nUnauthorized | \nInvalid or missing API key | \nNO | \n
\n\n| 422 | \nNo Data Found | \nNo Udyam linked to mobile number | \nYES | \n
\n\n| 500 | \nInternal Server Error | \nServer-side issue | \nNO | \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.totalekyc.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.totalekyc.com"],"query":[],"variable":[]}},"response":[{"id":"37b5047d-6680-46a9-bf6b-2764561623c8","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.totalekyc.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":"ff67743e-d159-48d7-ada0-37dc0e37999a","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.totalekyc.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":"dca5c6a6-a4e6-4edb-a000-649115f1bea0"}],"id":"c80df738-e74a-4ee8-a674-ff7d806930fd","_postman_id":"c80df738-e74a-4ee8-a674-ff7d806930fd","description":""},{"name":"Occupation Verification","item":[{"name":"Doctor Verify","id":"acd42fa1-88e8-418e-b0ed-ddcc008853c8","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 \"requestId\" : \"XXX72\",\n \"remark\": \"Optional client note or reference\"\n}","options":{"raw":{"language":"json"}}},"url":"https://live.totalekyc.com/api/kyc/occuption/doctor-verify","description":"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.totalekyc.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.totalekyc.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.totalekyc.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