v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Verify OTP

This endpoint is used to verify Aadhaar otp generated for registration using Aadhaar.

post/abdm/na/v1/registration/aadhaar/verify

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Request body

mobilestring required

10 digit mobile number to be linked with ABHA, this mobile number can be different from the mobile number linked with the Aadhaar. ABHA Created will be linked with this mobile number.

otpstring required

OTP received on the mobile number.

txn_idstring required

Transaction ID received in the previous api response.

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.