API reference / Employment

EPF employment history

Employer-wise EPF history by UAN, by PAN with employee_name, or by mobile. dob is optional.

POST/v1/employment/uan
Authentication
Bearer token
Scope
kyc:verify

Before you integrate

  • Look up by uan, by pan together with employee_name, or by mobile; at least one of uan, pan or mobile is required.
  • result is a list, not an object; the field names above are for each item in it.

Request body

FieldTypeRequiredDescription
uanstringNoUniversal Account Number, 12 digits. Give this, or pan with employee_name, or mobile.
panstringNoPAN of the employee, for example ABCDE1234F. When used, employee_name is required.
employee_namestringNoEmployee's name, 2 to 100 characters. Required with pan.
mobilestringNoMobile number linked to the EPF account. 10-digit Indian mobile number starting 6 to 9; a leading +91, 91 or 0 and spaces are ignored.
dobstringNoDate of birth, a past date as YYYY-MM-DD, DD/MM/YYYY or DD-MM-YYYY.

Sample code

Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.

curl -sS -X POST 'https://grappi.ai/v1/employment/uan' \
  -H "Authorization: Bearer $GRAPPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "uan": "100123456789"
}'

Sample response

{
  "request_id": "req_01HZY3K8M2",
  "result": [
    {
      "uan": "100123456789",
      "name": "ASHA RAO",
      "father_or_husband_name": "RAMESH RAO",
      "member_id": "MHBAN00123450000012345",
      "establishment_name": "EXAMPLE TECHNOLOGIES PRIVATE LIMITED",
      "date_of_joining": "01-Feb-2019",
      "date_of_exit": "31-Oct-2023"
    }
  ]
}

Response fields

FieldTypeDescription
[]arrayOne entry per employer the person has worked for.
[].uanstringUniversal Account Number.
[].namestringEmployee's name on the EPF record.
[].father_or_husband_namestringFather's or husband's name on the EPF record.
[].member_idstringEPF member ID with that employer.
[].establishment_namestringName of the employer.
[].date_of_joiningstringDate the person joined.
[].date_of_exitstringDate the person left, empty if still employed.

Errors

Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.