Enrol ABHA address

Flows:

POST/abha/api/v3/phr/app/enrollment/enrol

P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Enrol ABHA Address
P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › Enrol ABHA Address
P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-Aadhaar OTP › Enrol ABHA Address

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Headers

REQUEST-IDstringRequired

Unique UUID for each request.

TIMESTAMPstringRequired

Request timestamp in UTC, ISO-8601 with Z.

Body

txnIdstringRequired

phrDetailsobjectRequired

phrDetails.mobilestring

phrDetails.firstNamestring

phrDetails.middleNamestring

phrDetails.lastNamestring

phrDetails.yearOfBirthstring

phrDetails.dayOfBirthstring

phrDetails.monthOfBirthstring

phrDetails.genderstring

phrDetails.emailstring

phrDetails.profilePhotostring

phrDetails.addressstring

phrDetails.stateNamestring

phrDetails.stateCodestring

phrDetails.districtNamestring

phrDetails.districtCodestring

phrDetails.pinCodestring

phrDetails.abhaAddressstring

phrDetails.passwordstring

Responses

200

txnIdstring

messagestring

phrDetailsobject

phrDetails.firstNamestring

phrDetails.middleNamestring

phrDetails.lastNamestring

phrDetails.fullNamestring

phrDetails.dayOfBirthstring

phrDetails.monthOfBirthstring

phrDetails.yearOfBirthstring

phrDetails.dateOfBirthstring

phrDetails.genderstring

phrDetails.emailstring

phrDetails.mobilestring

phrDetails.addressstring

phrDetails.stateNamestring

phrDetails.districtNamestring

phrDetails.pinCodestring

phrDetails.abhaAddressstring[]

phrDetails.stateCodestring

phrDetails.districtCodestring

tokensobject

tokens.tokenstring

tokens.expiresIninteger

tokens.refreshTokenstring

tokens.refreshExpiresIninteger

400

Bad Request

Error codes for this module

codestring

messagestring

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/phr/app/enrollment/enrol \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'Content-Type: application/json' \
  --data '{
  "txnId": "37d8d312-35a0-41e7-a6e4-1074eb18a5fa",
  "phrDetails": {
    "firstName": "John",
    "middleName": "",
    "lastName": "Doe",
    "dayOfBirth": "<DOB>",
    "monthOfBirth": "<DOB>",
    "yearOfBirth": "<DOB>",
    "gender": "M",
    "email": "",
    "mobile": "<ENCRYPTED_MOBILE>",
    "address": "<ADDRESS>",
    "stateName": "Maharashtra",
    "stateCode": "27",
    "districtName": "<ADDRESS>",
    "districtCode": "123",
    "pinCode": "<PINCODE>",
    "abhaAddress": "<ABHA_ADDRESS>",
    "password": "<ENCRYPTED_PASSWORD>"
  }
}'

{
  "txnId": "6907ebb5-ff71-47f9-8052-6dd5554df5df",
  "message": "ABHA Address Created Successfully",
  "phrDetails": {
    "firstName": "John",
    "middleName": "",
    "lastName": "Doe",
    "fullName": "John Doe",
    "dayOfBirth": "<DOB>",
    "monthOfBirth": "<DOB>",
    "yearOfBirth": "<DOB>",
    "dateOfBirth": "<DOB>",
    "gender": "M",
    "email": "<EMAIL>",
    "mobile": "******1234",
    "address": "<ADDRESS>",
    "stateName": "Maharashtra",
    "districtName": "<ADDRESS>",
    "pinCode": "<PINCODE>",
    "abhaAddress": [
      "<ABHA_ADDRESS>",
      "<ABHA_ADDRESS>",
      "<ABHA_ADDRESS>"
    ],
    "stateCode": "27",
    "districtCode": "123"
  },
  "tokens": {
    "token": "<JWT TOKEN>",
    "expiresIn": 1800,
    "refreshToken": "<JWT TOKEN>",
    "refreshExpiresIn": 1296000
  }
}