v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Mobile Verify OTP

This API operates on a skip logic basis. If the mobile number provided in the second step differs from the one linked to the Aadhaar, this API will be used to verify the new mobile number.

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

Query parameters

oidstring

OID is used to Identify the user.

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Request body

otpstring required

OTP received on the mobile number

txn_idstring required

Transaction ID received in the previous API response.

Response

{"stackTrail":"components:schemas:VerifyResponseType2:properties:hint","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:VerifyResponseType2: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:VerifyResponseType2: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.