Skip to main content
POST
/
kyc
/
aadhaar
/
okyc
/
otp
/
verify
curl --request POST \
  --url https://test-api.sandbox.co.in/kyc/aadhaar/okyc/otp/verify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request",
  "reference_id": "1234567",
  "otp": "121212"
}
'
{
  "code": 200,
  "timestamp": 1000000000000,
  "transaction_id": "90d6ea41-210f-43c2-b830-83d6a03aaa77",
  "data": {
    "@entity": "in.co.sandbox.kyc.aadhaar.okyc",
    "reference_id": 1234567,
    "status": "VALID",
    "message": "Aadhaar Card Exists",
    "care_of": "S/O: Johnny Doe",
    "full_address": "Mangal Kanaka Niwas, Main Cross 3rd, Bengaluru, Bengaluru-Karnataka, India ",
    "date_of_birth": "21-04-1985",
    "email_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
    "gender": "M",
    "name": "John Doe",
    "address": {
      "@entity": "in.co.sandbox.kyc.aadhaar.okyc.address",
      "country": "India",
      "district": "Bengaluru",
      "house": "Mangal Kanaka Niwas",
      "landmark": "",
      "pincode": "581615",
      "post_office": "Bengaluru",
      "state": "Karnataka",
      "street": "Main Cross 3rd",
      "subdistrict": "",
      "vtc": "Bengaluru"
    },
    "year_of_birth": "1985",
    "mobile_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
    "photo": "data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q==",
    "share_code": "1234"
  }
}
https://mintcdn.com/sandboxfinancialtechnologiesprivatelimited/gviqebbpT5NUt_6i/static/svg/Postman.svg?fit=max&auto=format&n=gviqebbpT5NUt_6i&q=85&s=da47f2b7e10d87befec951aed9468de3

Run in Postman

Headers

​
Authorization
string
required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

​
x-api-key
string
required

API key used to identify and authenticate the client.

​
x-api-version
string

Specifies the API version for the request.

​
Content-Type
enum<string>

Media type of the request body.

Available options:
application/json

Body

application/json
​
@entity
string
required
Allowed value: "in.co.sandbox.kyc.aadhaar.okyc.request"
​
reference_id
string
required

Unique reference identifier returned by the Generate OTP API for this Aadhaar verification flow. Used to correlate the OTP submission with the original request.

​
otp
string
required

6-digit one-time password sent to the mobile number linked with the Aadhaar. Must be entered exactly as received and is valid only for the associated reference_id.

Required string length: 6
Pattern: ^[0-9]{6}$

Response

​
code
integer
required
​
timestamp
integer
required
​
transaction_id
string
required
​
data
object
required