v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Create

This API is used to create a new ABHA address for the user.

post/abdm/na/v1/registration/mobile/create-phr

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Request body

abha_addressstring required

The ABHA address to be created for the user.

txn_idstring required

Transaction ID received in the previous API response.

Response

OK

{"stackTrail":"components:schemas:CreateResponseType2: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'
successboolean

Indicates whether the API response is successful

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