Skip to main content
POST
/
abdm
/
na
/
v1
/
registration
/
aadhaar
/
create-phr
Create
curl --request POST \
  --url https://api.eka.care/abdm/na/v1/registration/aadhaar/create-phr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "abha_address": "<string>",
  "txn_id": "<string>"
}
'
{
  "eka": {
    "min_token": "<string>",
    "oid": "<unknown>",
    "uuid": "<unknown>"
  },
  "hint": "<string>",
  "profile": {
    "abha_address": "<string>",
    "abha_addresses": [
      "<string>"
    ],
    "abha_number": "<unknown>",
    "address": "<unknown>",
    "day_of_birth": "<unknown>",
    "first_name": "<unknown>",
    "gender": "M",
    "kyc_verified": "<unknown>",
    "last_name": "<unknown>",
    "middle_name": "<unknown>",
    "mobile": "<unknown>",
    "month_of_birth": "<unknown>",
    "pincode": "<unknown>",
    "year_of_birth": "<unknown>"
  },
  "refresh_token": "<unknown>",
  "skip_state": "abha_end",
  "token": "<unknown>",
  "txn_id": "<string>"
}

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
​
abha_address
string
required

ABHA Address to be linked with the ABHA Number

Example:

"shyam.eka@abdm"

​
txn_id
string
required

Transaction ID received in the previous API response.

Response

OK

​
eka
object

Eka IDs

​
hint
string

Hint for the mobile number

​
profile
object

ABHA Profile

​
refresh_token
null | string

Refresh token for the user

​
skip_state
enum<string>
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