Verify Face

Verify PID endpoint is used to verify face-auth pid.

POST /abdm/na/v1/face-auth/verify

Verify Face

cURL

curl --request POST \
  --url https://api.eka.care/abdm/na/v1/face-auth/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aadhaar": "<string>",
  "txn_id": "<string>"
}
'

200

{
  "abha_profiles": [
    {
      "abha_address": "<string>",
      "kyc_verified": "<string>",
      "name": "<string>"
    }
  ],
  "eka": {
    "min_token": "<string>",
    "oid": "<string>",
    "uuid": "<string>"
  },
  "hint": "<string>",
  "profile": {
    "abha_address": "<string>",
    "abha_addresses": [
      "<string>"
    ],
    "abha_number": "<string>",
    "address": "<string>",
    "day_of_birth": 123,
    "first_name": "<string>",
    "gender": "M",
    "kyc_verified": true,
    "last_name": "<string>",
    "middle_name": "<string>",
    "mobile": "<string>",
    "month_of_birth": 123,
    "pincode": "<string>",
    "year_of_birth": 123
  },
  "refresh_token": "<string>",
  "skip_state": "abha_end",
  "token": "<string>",
  "txn_id": "<string>"
}

Authorizations

Authorization · string · header · required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id · string

Eka User ID (OID)

X-Partner-Pt-Id · string

Partner User ID

X-Hip-Id · string

Partner HIP ID

Body

application/json

aadhaar · string

txn_id · string

Response

200

application/json

OK

abha_profiles · object[]

Abha profiles of the user.

Show child attributes

eka · object

Eka IDs, will be present if SkipState is abha_end

Show child attributes

hint · null | string

Hint for the mobile number

profile · object

Show child attributes

refresh_token · null | string

Refresh token of the user, issued by abdm

skip_state · enum<string>

Available options: abha_end, confirm_mobile_otp, abha_select, abha_create

token · null | string

Abha token of the user, issued by abdm

txn_id · string

Transaction ID required for the next API call.