UAN Verification API
Send a 12-digit UAN and get the person’s employment history back: every employer, the months with each and the most recent job.
The documentation opens in the VerifyAll dashboard after sign-in, for accounts with approved API access. New to the API? Start with the developer guide.
Overview
What the UAN Verification API does
The UAN Verification API takes a Universal Account Number (UAN), the 12-digit number that follows an employee from job to job in India, and answers with the employment history on record for it. For each establishment the member contributed under you get the employer name, the establishment and member ids (partly masked), the first and last contribution month, the months in between, the exit reason where one is recorded and the establishment’s address.
A summary block adds the number of employers, the minimum total experience in months and the most recent employer with its dates, so a screening rule can read one object instead of walking the list. Send the candidate’s name as well and name_match compares it with the member name on the account, with a score from 0 to 100.
CVs overstate tenure and invent employers; reference calls are slow and often go unanswered. A UAN check shows which organisations actually paid provident fund contributions for the person and for how long, so HR teams can confirm a work history before an offer and lenders can confirm that a salaried applicant works where they say.
How it works
- 1
Your server sends POST /universal/epf-uan-validation with the 12-digit UAN, the consent object and, if you want a name comparison, the candidate’s name.
- 2
The request is checked first: a UAN that is not 12 digits or a missing consent object is refused with every problem listed before anything runs or is charged.
- 3
The UAN is checked against live records and the employment history comes back in the same call, usually within about 3 seconds.
- 4
The result is stored in your VerifyAll account with a checkResultId; read it again, find it by your client_ref or download the PDF report for the candidate’s file.
Request and response
UAN verification API endpoints and fields
The main fields; the full reference with every field, error code and a cURL sample is in the dashboard docs.
| Endpoint | What it does |
|---|---|
| POST/universal/epf-uan-validation | Return the employment history of a UAN and compare a name |
Request fields
| Field | What it is |
|---|---|
| uanRequired | The Universal Account Number, 12 digits (for example 100512345678). |
| consentRequired | obtained: true and a purpose of up to 200 characters, for the employee the UAN belongs to. |
| nameOptional | The name the candidate or applicant gave; sets name_match. |
| client_refOptional | Your own reference, stored with the result (up to 100 characters). |
What the answer returns
| Field | What it is |
|---|---|
| uan | The Universal Account Number checked. |
| name / relation_name | The member name on the account (may be partly masked), and the father’s or husband’s name where held. |
| name_match | exact, partial, mismatch or not_checked, with a score from 0 to 100. |
| employers | Every establishment the member contributed under: name, establishment_id, member_id, address and status. |
| employers[].from / to / months | First and last contribution month (YYYY-MM) and the months between them; to is null while the person is still employed there. |
| employers[].exit_reason | The reason of exit, when one is recorded. |
| summary | employer_count, total_experience_months and last_employer with its name, dates and months. |
| remark | A remark on the account, when there is one. |
Base URL https://api.verifyall.ai. Authenticate with the X-API-Key header (a va_sandbox_ or va_live_ key). Every answer carries data, status_code, success, message and message_code; checks add outcome, checkResultId, charged and charged_amount.
Key features
UAN Verification API features and capabilities
Full history, not a single employer
Every establishment the person contributed under comes back as its own entry, so gaps, overlaps and short stints are visible at a glance.
Current employer flagged
A null to month means the person is still employed there, which is the quickest way to confirm current employment for a salary loan.
Summary for screening rules
employer_count, total_experience_months and last_employer let you apply rules such as “at least 24 months of experience” without parsing the list.
Name match on the account
Compare the candidate’s name with the member name and get exact, partial or mismatch with a 0–100 score.
Use cases
Where businesses use the UAN Verification API
Pre-offer employment verification
Confirm the employers and tenures on a candidate’s CV before you make an offer, and spot undeclared jobs.
Salaried loan underwriting
Check that a personal-loan or credit-card applicant is employed with the company they named, and for how long.
Background verification packages
Add an employment history line to your own background checks, with a stored result and PDF for the case file.
Gig and contract staffing
Check the formal employment history of contract staff and agency workers before deployment to a client site.
Industries
Coverage
UANs issued in India, covering employment with establishments that paid provident fund contributions for the person. Work that never had provident fund contributions does not appear.
Limitations to plan for
- Only employment with provident fund contributions is shown. Self-employment, consulting, many small employers and most work outside India will not appear.
- Dates are contribution months (YYYY-MM), not exact joining and leaving dates. The member name, establishment id and member id may be partly masked.
- A UAN with no record answers record_not_found. The lookup ran, so it is charged like any completed check.
- Checks about a person need the consent object, and you keep the consent record.
Integration
How to integrate the UAN Verification API
From a business account to your first live call.
Step 1
Create a business account on VerifyAll and get it approved, as for running checks in the dashboard.
Step 2
Request Developer API access under Developers in the dashboard: the APIs you need, your expected monthly volume and your use case. The VerifyAll team reviews it and shares the API Services Agreement.
Step 3
Once the agreement is signed and access is approved, create your Sandbox key and build against sample data. Sandbox calls are never charged.
Step 4
Create your Production key, recharge your wallet and switch the key in your code: the endpoint and fields stay the same.
Get started
Request access to the UAN Verification API
Tell us what you want to verify. We reply within one business day with access steps, Sandbox details and your API pricing.
View API documentation
The full reference for UAN Verification API (endpoints, fields, errors, cURL) opens in the dashboard once your access is approved.
Open the docs (sign-in)Create a business account
API keys are issued to an approved business account. Sign up, then request access under Developers.
Create account
Pricing
Production calls are charged per check from your prepaid VerifyAll wallet, at your account’s API price; GST is added separately when you recharge. Sandbox calls are never charged. Your API prices are shown in the dashboard once access is approved. How pricing works
Already have a business account? Sign in to request access
UAN Verification API: frequently asked questions
Answers for teams planning an integration.
Still have questions? Our team is happy to help.
Contact SupportRelated APIs
Mobile to EPFO API
LiveInstant answerStart from a mobile number and get every UAN linked to it, each with the employment history behind it, in one call.
View API detailsBackground Verification API
LiveFinishes laterRun the background checks you choose on one person in a single request, and read back one report with an overall result and every check’s outcome.
View API detailsPAN Verification API
LiveInstant answerConfirm a PAN exists, see who holds it and match the name and date of birth your customer typed, in one call.
View API details
All employment verification APIsRun UAN verification in the dashboard, without codeBrowse the API Marketplace
Start with the UAN Verification API
Request access, build against the Sandbox, then go live with your Production key.