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": "test_verification_id",
"phone": "9988775566"
}
'{
"verification_id": "test_verification_id",
"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"
}
]
}
}
}Get Employment Details
Use this API to to retrieve an individualās recent employment details.
View the test data and use the information to trigger the validations. The test data can be used only in the sandbox environment.
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": "test_verification_id",
"phone": "9988775566"
}
'{
"verification_id": "test_verification_id",
"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
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Headers
Send the signature if two-factor authentication is selected as Public Key. More details.
Body
Find the request parameters to retrieve employment details.
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.
"ABC00123"
It is the phone number of the employee. (conditonal mandatory).
"9988776655"
It is the PAN information of the employee. (conditonal mandatory).
"AZJPG7110R"
It is the unique number assigned to every employee contributing to the Employees' Provident Fund (EPF). (conditonal mandatory).
"101340612345"
It is the date of birth information of the employee. The format is YYYY-MM-DD.Employee date of birth. (conditonal mandatory).
"1995-11-10"
It is the name of the employee. (conditonal mandatory).
"John Doe"
It is the name of the employer. (conditonal mandatory).
"Cashfree India Pvt Ltd"
Response
Success response for retreiving employment information.
Success response for retreiving employment information.
It displays the unique ID you created to identify the verification request.
"test_verification_id"
It displays the unique ID created by Cashfree Payments for reference purposes.
format: int64
1358
It displays the list of status of the API request.
Possible values are:
SUCCESS EMPLOYMENT_DETAILS_NOT_FOUND
"SUCCESS"
It contains the information entered in the API request.
Show child attributes
Show child attributes
It contains the list of UAN details.
Show child attributes
Show child attributes
It contains the recent employment details of the individual.
Show child attributes
Show child attributes
Was this page helpful?