Cashfree Payments Developer Documentation

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": "[email protected]",
        "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"
        }
      ]
    }
  }
}

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": "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": "[email protected]",
        "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

header

required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret

string

header

required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-cf-signature

string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameters to retrieve employment details

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.

Example:

"ABC00123"

phone

string

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

Example:

"9988776655"

pan

string

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

Example:

"AZJPG7110R"

uan

string

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

Example:

"101340612345"

dob

string<date>

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

Example:

"1995-11-10"

employee_name

string

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

Example:

"John Doe"

employer_name

string

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

Example:

"Cashfree India Pvt Ltd"

Response

Success response for retreiving employment information

verification_id

string

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

Example:

"test_verification_id"

reference_id

integer

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

Example:

1358

status

string

It displays the list of status of the API request. Possible values are: SUCCESS EMPLOYMENT_DETAILS_NOT_FOUND

Example:

"SUCCESS"

input

object

It contains the information entered in the API request.

Show child attributes

input.phone

string

It displays the phone number of the employee passed in API request.

input.pan

string

It displays the PAN information of the employee passed in API request.

input.uan

string

It displays the UAN information of the employee passed in API request.

input.dob

string

It displays the date of birth of the employee passed in API request.

Example:

"1996-10-02"

input.employee_name

string

It displays the name of the employee passed in API request.

Example:

"John Doe"

input.employer_name

string

It displays the name of the employer passed in API request.

uan_details

object[]

It contains the list of UAN details.

Show child attributes

uan_details.uan

string

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

Example:

"101340612345"

uan_details.source

string

It displays the fields used to fetch the data from source

Example:

"dob and name"

uan_details.source_score

number

It displays the confidence of the source data

Example:

0

uan_details.basic_details

object

It displays the basic information of the employee.

Show child attributes

uan_details.basic_details.gender

string

It displays the gender of the employee.

Example:

"MALE"

uan_details.basic_details.dob

string

It displays the date of birth of the employee.

Example:

"1996-10-02"

uan_details.basic_details.employee_confidence_score

number

It displays the confidence score for the employee.

Example:

0

uan_details.basic_details.employee_name

string

It displays the name of the employee.

Example:

"John Doe"

uan_details.basic_details.phone

string

It displays the phone number of the employee.

Example:

"9988776655"

uan_details.basic_details.aadhaar_verified

boolean

It displays whether the aadhaar information of the employee is verified or not.

Example:

true

uan_details.employment_details

object

It contains the employement details of the individual.

Show child attributes

uan_details.employment_details.member_id

string

It displays the unique ID assigned to an individual.

Example:

"MHBAN12342200000012345"

uan_details.employment_details.establishment_id

string

It displays the unique ID assigned to a specific establishment or business entity.

Example:

"MHBAN1234220000"

uan_details.employment_details.exit_date

string

It displays the last working day of the employee in the organisation.

uan_details.employment_details.joining_date

string

It displays the first working day of the employee in the organisation.

Example:

"2020-02-21"

uan_details.employment_details.leave_reason

string

It displays the reason for leaving the previous job.

uan_details.employment_details.establishment_name

string

It displays the name of the organisation.

Example:

"Cashfree India Private Ltd"

uan_details.employment_details.employer_confidence_score

number

It displays the

Example:

0.1

uan_details.additional_details

object

It contains additional information of the individual.

Show child attributes

uan_details.additional_details.aadhaar

string

It displays the masked aadhaar number of the individual.

Example:

"XXXXXXXX7561"

uan_details.additional_details.email

string

It displays the email address of the individual.

Example:

"[email protected]"

uan_details.additional_details.pan

string

It displays the PAN information of the individual.

Example:

"ABCDE5930G"

uan_details.additional_details.ifsc

string

It displays the IFSC information of the individual's bank account.

Example:

"SBIN0012345"

uan_details.additional_details.bank_account

string

It displays the bank account number of the individual.

Example:

"20329012345"

uan_details.additional_details.bank_address

string

It displays the address of the bank branch.

Example:

"STATE BANK OF INDIA,KATANGA BENGALURU"

uan_details.additional_details.relation

string

It displays the realtionship of the individual with the relative.

Example:

"F"

uan_details.additional_details.relative_name

string

It displays the name of the relative.

Example:

"Alice Doe"

recent_employment_details

object

It contains the recent employment details of the individual.

Show child attributes

recent_employment_details.employee_details

object

It contains the recent details of the individual as an employee.

Show child attributes

recent_employment_details.employee_details.member_id

string

It displays the unique ID assigned to an individual.

Example:

"UPLKO22417520000010171"

recent_employment_details.employee_details.exit_date

string

It displays the last working day of the employee in the organisation.

Example:

"2024-11-01"

recent_employment_details.employee_details.joining_date

string

It displays the first working day of the employee in the organisation.

Example:

"2023-09-01"

recent_employment_details.employee_details.uan

string

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

Example:

"101379636551"

recent_employment_details.employee_details.epfo

object

It contains the information found in Employees' Provident Fund Organisation (EPFO)

Show child attributes

recent_employment_details.employee_details.epfo.recent

boolean

It displays whether the retrieved information is recent.

Example:

true

recent_employment_details.employee_details.epfo.name_unique

boolean

It displays whether the retrieved name is unique.

Example:

true

recent_employment_details.employee_details.epfo.pf_filings_details

boolean

It displays whether the PF filing details are correct.

Example:

true

recent_employment_details.employee_details.employed

boolean

It displays whether the individual is employed.

Example:

false

recent_employment_details.employee_details.employee_name_match

boolean

It displays whether the individual's name matches with the name found in EPFO.

Example:

false

recent_employment_details.employee_details.exit_date_marked

boolean

It displays whether the last working.

Example:

false

recent_employment_details.employer_details

object

It contains the recent details of the employer.

Show child attributes

recent_employment_details.employer_details.establishment_id

string

It displays the unique ID assigned to a specific establishment or business entity.

Example:

"MHBAN1234220000"

recent_employment_details.employer_details.establishment_name

string

It displays the name of the organisation.

Example:

"Cashfree India Private Ltd"

recent_employment_details.employer_details.setup_date

string

It displays the date on which organisation is launched.

Example:

"2020-11-19"

recent_employment_details.employer_details.ownership_type

string

It displays the type of ownership of the organisation.

Example:

"Private Limited Company"

recent_employment_details.employer_details.employer_confidence_score

number

It displays the confidence score of organisation details.

Example:

0.3

recent_employment_details.employer_details.employer_name_match

boolean

It displays the name match score of employer name passed in input with organisation name recieved from the source.

Example:

false

recent_employment_details.employer_details.pf_filing_details

object[]

It displays the pf filling details of the organisation.

Show child attributes

recent_employment_details.employer_details.pf_filing_details.total_amount

number

It displays the pf amount in rupees filed by organisation.

Example:

37524

recent_employment_details.employer_details.pf_filing_details.employees_count

number

It displays the count of employees in the organisation.

Example:

17

recent_employment_details.employer_details.pf_filing_details.wage_month

string

It displays month for which employees wages are being reported or processed.

Example:

"NOV-23"

Mobile 360 Verify OTP Reverse Geocoding

⌘I

Secure ID APIs

V2

V1 (Depricated API's)

Get Employment Details

Authorizations

Headers

Body

Response