POST
/
voter-id
curl --request POST \
  --url https://sandbox.cashfree.com/verification/voter-id \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "verification_id": "test123",
  "epic_number": "UAI4574761",
  "name": "John Doe"
}'
{
  "reference_id": 1358,
  "verification_id": "testverificationid",
  "status": "VALID",
  "epic_number": "UAI4574761",
  "name": "HARSHIT PRAJAPATI",
  "name_in_regional_lang": "हर्षित",
  "age": "23",
  "relation_type": "FTHR",
  "relation_name": "RAJ PRAJAPATI",
  "relation_name_in_regional_lang": "राज",
  "father_name": "RAJ PRAJAPATI",
  "dob": "2000-12-07",
  "gender": "Male",
  "address": "GOVT JUNIOR COLLEGE SIRWAR",
  "photo": "PHOTO_LINK.jpeg",
  "split_address": {
    "district": [
      "INDORE"
    ],
    "state": [
      [
        "Madhya Pradesh"
      ]
    ],
    "city": [
      "SANER"
    ],
    "pincode": "560034",
    "country": [
      "IN",
      "IND",
      "INDIA"
    ],
    "address_line": "GOVT JUNIOR COLLEGE SIRWAR"
  },
  "state": "Madhya Pradesh",
  "assembly_constituency_number": "211",
  "assembly_constituency": "SANER",
  "parliamentary_constituency_number": "25",
  "parliamentary_constituency": "INDORE",
  "part_number": "27",
  "part_name": "SIRWAR",
  "serial_number": "713",
  "polling_station": "GOVT JUNIOR COLLEGE SIRWAR"
}

Authorizations

​
x-client-id
string
header
required

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

​
x-client-secret
string
header
required

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 fetch voter ID details

Find the request body parameters to verify the voter ID information.

​
verification_id
string
required

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

Example:

"test123"

​
epic_number
string
default:UAI4574761
required

It is the unique identification number assigned to each voter ID

Example:

"UAI4574761"

​
name
string
default:John Doe

It is the name of the voter ID card holder.

Maximum length: 50
Example:

"John Doe"

Response

200
application/json
Success response for retreiving voter ID information

Verify Voter ID success response

​
reference_id
integer

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

Example:

1358

​
verification_id
string

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

Example:

"testverificationid"

​
status
string

It displays the status of the API request. Possible values are

  • VALID: The provided Epic Number is valid.
  • INVALID: The provided Epic Number is invalid.
Example:

"VALID"

​
name
string

It displays the name of the individual as present in the voter ID card.

Example:

"SUSHMITHA H"

​
name_in_regional_lang
string

It displays the name of the individual in the individual’s regional language as present in the voter ID card.

Example:

"हर्षित"

​
age
string

It displays the age of the voter ID holder as present in the voter ID card

Example:

"25"

​
relation_type
string

It displays the type of the relationship with the parent/guardian as present in the voter ID card.

Example:

"FTHR"

​
relation_name
string

It displays the name of the parent/guardian as present in the voter ID card.

Example:

"SUNILAKUMAR"

​
relation_name_in_regional_lang
string

It displays the name of the parent/guardian in the individual’s regional language as present in the voter ID card.

Example:

"राज"

​
father_name
string

It displays the father’s name of the individual as present in the voter ID card.

Example:

"SUNILAKUMAR"

​
dob
string

It displays the date of birth of the individual as present in the voter ID card.

Example:

""

​
gender
string

It displays the gender of the individual as present in the voter ID card.

Example:

"Female"

​
address
string

It displays the address information of the individual as present in the voter ID card.

Example:

"GOVT JUNIOR COLLEGE SIRWAR"

​
split_address
object

It contains the address information of the individual as present in the voter ID card.

Example:
{
  "value": {
    "district": ["RAICHUR"],
    "state": ["Karnataka"],
    "city": ["Manvi"],
    "pincode": "560034",
    "country": ["IN", "IND", "INDIA"],
    "address_line": "GOVT JUNIOR COLLEGE SIRWAR"
  }
}
​
epic_number
string

It displays the EPIC number of the individual as present in the voter ID card.

Example:

"XXX0000000"

​
state
string

It displays the name of the state as present in the voter ID card.

Example:

"Karnataka"

​
assembly_constituency_number
string

It displays the number associated with the assembly constituency as present in the voter ID card.

Example:

"55"

​
assembly_constituency
string

It displays the name of the assembly constituency as present in the voter ID card.

Example:

"MANVI"

​
parliamentary_constituency_number
string

It displays the number associated with the parliamentary constituency as present in the voter ID card.

Example:

"6"

​
parliamentary_constituency
string

It displays the name of the parliamentary constituency as present in the voter ID card.

Example:

"Raichur"

​
part_number
string

It displays the part number in the electoral roll.

Example:

"29"

​
part_name
string

It displays the part name in the electoral roll.

Example:

"GOVERMENT JUNIOR COLLEGE 2nd Room (South Wing ) sirwar"

​
serial_number
string

It displays the serial number as present in the voter ID card.

Example:

"892"

​
polling_station
string

It displays the place where the individual cast votes during elections.

Example:

"GOVT JUNIOR COLLEGE SIRWAR"

Was this page helpful?