Advanced Employment

Get Employment Details

Use this API to to retrieve an individual’s recent employment details such as member ID, joining date, and exit date of the company. Verifying the employment information of the individual mitigates risk and prevents fraud. View the test data and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.

Response Codes

Sub Code	Status	Message	Next Action
200	SUCCESS	SUCCESS	-
200	SUCCESS	EMPLOYMENT_DETAILS_NOT_FOUND	Enter the correct information in the request.
400	ERROR	provided input combination is not valid	Enter a combination of values that help fetch the employment details.
400	ERROR	verification_id can include only alphanum, dot, hyphen and underscores.	Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.
400	ERROR	Client secret belongs to test environment	Enter the correct environment credentials in the request.
400	ERROR	x-client-id is missing in the request.	Enter all the header information in the API request.
401	ERROR	Invalid clientId and clientSecret combination	Ensure you enter valid x-client-id and x-client-secret information in the API request.
403	ERROR	IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://docs.cashfree.com/docs/ip-whitelisting-verification	Whitelist the IP address.
409	ERROR	verification id already exists	Enter a unique verification ID to identify the request.
422	ERROR	Insufficient balance to process this request	Try again with sufficient balance.
500	ERROR	something went wrong	Try again after some time.
502	ERROR	verification attempt failed	Try again after some time.

POST

advance-employment

curl --request POST \
  --url https://sandbox.cashfree.com/verification/advance-employment \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "verification_id": "ABC00123",
  "phone": "9988775566"
}'

{
  "verification_id": "ABC00122",
  "reference_id": 12345,
  "status": "SUCCESS",
  "input": {
    "phone": "9988776655",
    "pan": null,
    "uan": "null",
    "dob": null,
    "employee_name": null,
    "employer_name": null
  },
  "uan_details": [
    {
      "uan": "101340612345",
      "source": "dob and name",
      "source_score": 0,
      "basic_details": {
        "gender": "MALE",
        "dob": "1996-10-02",
        "employee_confidence_score": 0,
        "employee_name": "John Doe",
        "phone": "9988776655",
        "aadhaar_verified": true
      },
      "employment_details": {
        "member_id": "MHBAN12342200000012345",
        "establishment_id": "MHBAN1234220000",
        "exit_date": null,
        "joining_date": "2020-02-21",
        "leave_reason": null,
        "establishment_name": "Cashfree India Private Ltd",
        "employer_confidence_score": 0.1
      },
      "additional_details": {
        "aadhaar": "XXXXXXXX7561",
        "email": "johndoe@gmail.com",
        "pan": "ABCDE5930G",
        "ifsc": "SBIN0012345",
        "bank_account": "20329012345",
        "bank_address": "STATE BANK OF INDIA,KATANGA  BENGALURU",
        "relation": "F",
        "relative_name": "Alice Doe"
      }
    }
  ],
  "recent_employment_details": {
    "employee_details": {
      "member_id": "UPLKO22417520000010171",
      "exit_date": null,
      "joining_date": "2023-09-01",
      "uan": "101379636551",
      "epfo": {
        "recent": true,
        "name_unique": true,
        "pf_filings_details": true
      },
      "employed": false,
      "employee_name_match": false,
      "exit_date_marked": false
    },
    "employer_details": {
      "establishment_id": "MHBAN1234220000",
      "establishment_name": "Cashfree India Private Ltd",
      "setup_date": "2020-11-19",
      "ownership_type": "Private Limited Company",
      "employer_confidence_score": 0.3,
      "employer_name_match": false,
      "pf_filing_details": [
        {
          "total_amount": 37524,
          "employees_count": 17,
          "wage_month": "NOV-23"
        },
        {
          "total_amount": 41249,
          "employees_count": 19,
          "wage_month": "OCT-23"
        },
        {
          "total_amount": 37295,
          "employees_count": 16,
          "wage_month": "SEP-23"
        }
      ]
    }
  }
}

Authorizations

x-client-id

string

headerrequired

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret

string

headerrequired

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-cf-signature

string

Send the signature if IP is not whitelisted

Body

application/json

Find the request parameters to retrieve employment infomration

verification_id

string

required

It is the unique ID you create to identify the API request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

phone

string

It is the phone number of the employee. (conditonal mandatory)

pan

string

It is the PAN information of the employee. (conditonal mandatory)

uan

string

It is the unique number assigned to every employee contributing to the Employees' Provident Fund (EPF).(conditonal mandatory)

dob

string

It is the date of birth information of the employee. The format is YYYY-MM-DD.Employee date of birth (conditonal mandatory)

employee_name

string

It is the name of the employee. (conditonal mandatory)

employer_name

string

It is the name of the employer. (conditonal mandatory)

Response

200 - application/json

Success response for Get Employment Details

verification_id

string

It displays the unique ID you created to identify the verification request.

reference_id

integer

It displays the unique ID created by Cashfree Payments for reference purposes.

status

string

It displays the status of the API request.

input

object

It contains the information entered in the API request.

uan_details

object[]

It contains the UAN information.

uan_details.uan

string

It displays the Universal Account Number (UAN) information of the employee.

uan_details.source

string

It displays the

uan_details.source_score

number

It displays the

uan_details.basic_details

object

It displays the basic information of the employee.

uan_details.employment_details

object

It contains the employement details of the individual.

uan_details.additional_details

object

It contains additional information of the individual.

recent_employment_details

object

It contains the employment details of the individual.

recent_employment_details.employee_details

object

It contains the details of the individual as an employee.

recent_employment_details.employer_details

object

Was this page helpful?

Submit OTP to Verify Aadhaar Get BAV Status V2

curl --request POST \
  --url https://sandbox.cashfree.com/verification/advance-employment \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "verification_id": "ABC00123",
  "phone": "9988775566"
}'

{
  "verification_id": "ABC00122",
  "reference_id": 12345,
  "status": "SUCCESS",
  "input": {
    "phone": "9988776655",
    "pan": null,
    "uan": "null",
    "dob": null,
    "employee_name": null,
    "employer_name": null
  },
  "uan_details": [
    {
      "uan": "101340612345",
      "source": "dob and name",
      "source_score": 0,
      "basic_details": {
        "gender": "MALE",
        "dob": "1996-10-02",
        "employee_confidence_score": 0,
        "employee_name": "John Doe",
        "phone": "9988776655",
        "aadhaar_verified": true
      },
      "employment_details": {
        "member_id": "MHBAN12342200000012345",
        "establishment_id": "MHBAN1234220000",
        "exit_date": null,
        "joining_date": "2020-02-21",
        "leave_reason": null,
        "establishment_name": "Cashfree India Private Ltd",
        "employer_confidence_score": 0.1
      },
      "additional_details": {
        "aadhaar": "XXXXXXXX7561",
        "email": "johndoe@gmail.com",
        "pan": "ABCDE5930G",
        "ifsc": "SBIN0012345",
        "bank_account": "20329012345",
        "bank_address": "STATE BANK OF INDIA,KATANGA  BENGALURU",
        "relation": "F",
        "relative_name": "Alice Doe"
      }
    }
  ],
  "recent_employment_details": {
    "employee_details": {
      "member_id": "UPLKO22417520000010171",
      "exit_date": null,
      "joining_date": "2023-09-01",
      "uan": "101379636551",
      "epfo": {
        "recent": true,
        "name_unique": true,
        "pf_filings_details": true
      },
      "employed": false,
      "employee_name_match": false,
      "exit_date_marked": false
    },
    "employer_details": {
      "establishment_id": "MHBAN1234220000",
      "establishment_name": "Cashfree India Private Ltd",
      "setup_date": "2020-11-19",
      "ownership_type": "Private Limited Company",
      "employer_confidence_score": 0.3,
      "employer_name_match": false,
      "pf_filing_details": [
        {
          "total_amount": 37524,
          "employees_count": 17,
          "wage_month": "NOV-23"
        },
        {
          "total_amount": 41249,
          "employees_count": 19,
          "wage_month": "OCT-23"
        },
        {
          "total_amount": 37295,
          "employees_count": 16,
          "wage_month": "SEP-23"
        }
      ]
    }
  }
}

Secure ID APIs

V2

V1

Get Employment Details

Response Codes

Authorizations

Headers

Body

Response