Skip to main content
POST
Verify Face

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
required
txn_id
string
required

Response

OK

abha_profiles
object[]

Abha profiles of the user.

eka
object

Eka IDs, will be present if SkipState is abha_end

hint
null | string

Hint for the mobile number

profile
object

Will be present if SkipState is abha_end

refresh_token
null | string

Refresh token of the user, issued by abdm

skip_state
enum<string>

SkipState abha_end - When the user has completed the Aadhaar registration process once earlier and this was a login call. confirm_mobile_otp - when it's a first time (registration) user and the user has to link the mobile number to Aadhaar.

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.