v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Verify Face

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

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

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Request body

aadhaarstring

txn_idstring

Response

{"stackTrail":"components:schemas:VerifyResponse:properties:hint","oasType":"schema","type":"unknown","description":"Hint for the mobile number"}

{"stackTrail":"components:schemas:VerifyResponse:properties:refresh_token","oasType":"schema","type":"unknown","description":"Refresh token of the user, issued by abdm"}

skip_state'abha_end' | 'confirm_mobile_otp' | 'abha_select' | 'abha_create'

{"stackTrail":"components:schemas:VerifyResponse:properties:token","oasType":"schema","type":"unknown","description":"Abha token of the user, issued by abdm"}

txn_idstring

Transaction ID required for the next API call.