Generate captcha/OTP for verification

POST 
/verification/api/1.0/verifications/pre-verify/:verificationName

Generate captcha/OTP for verification

Request

Path Parameters

verificationName stringrequired

Possible values: [pan, pan-entity, gst, bank-account, upi, cin, din, voter-id, employment-check, mobile-employment-check, face-match, aadhaar, dl, liveness, passport, form26as, udyamRegistrationNumber, shopAndEstablishmentCertificate, vehicle-rc, tan, electricity-bill, png, lpg, shareholder, director-kyc, mca-lite, mca-signatories, ptv, iec, legal-entity, ration-card, farmer-registration, uan-lookup, ca-membership, icsi, icwai, nmc, fssai, itr, japanese-resident-card, mexican-id-card, udid, ews-certificate]

Type of verificationName

Responses

200

OK

application/json

Schema

Schema

code integer
message string
data object

Example (from schema)

{
  "code": 0,
  "message": "string",
  "data": {}
}

For Aadhaar

{
  "code": 0,
  "message": "Success",
  "data": {
    "ref_id": "XXXXXXXXXXXXXX:OTP",
    "message": "OTP sent to *******XXXX"
  }
}

For Driving license

{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "-",
    "captcha": "Base 64 image for captcha"
  }
}

For Ews Certificate(TN)

{
  "code": 0,
  "message": "Success",
  "data": {
    "captcha": "Base 64 image for captcha"
  }
}

For Ews Certificate(DL)

{
  "code": 0,
  "message": "Success",
  "data": {
    "captcha": "Base 64 image for captcha",
    "token": "XXXXXXXXXXXXXXXX"
  }
}

For Voter Id

{
  "code": 0,
  "message": "Success",
  "data": {
    "captchaId": "unique identifier for request",
    "captcha": "Base 64 image for captcha"
  }
}

Error Response

{
  "code": 0,
  "message": "Error message",
  "data": {}
}

Loading...