Skip to main content

Verify the enrolment OTP

Flows:

POST/abha/api/v3/phr/app/enrollment/verify
  • P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Verify - Mobile
  • P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › OTP Verify - ABHA OTP
  • P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-Aadhaar OTP › OTP Verify - AADHAR OTP

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

scopestring[]Required
authDataobjectRequired
authData.authMethodsstring[]
authData.otpobject
authData.otp.txnIdstring
authData.otp.otpValuestring

Responses

200

OK

txnIdstring
messagestring
authResultstring
usersobject[]
users.abhaAddressstring
users.fullNamestring
users.abhaNumberstring
users.statusstring
users.kycStatusstring
tokensobject
tokens.tokenstring
tokens.expiresIninteger
tokens.refreshTokenstring
tokens.refreshExpiresIninteger
accountsobject[]
accounts.mobilestring
accounts.firstNamestring
accounts.middleNamestring
accounts.lastNamestring
accounts.namestring
accounts.yearOfBirthstring
accounts.dayOfBirthstring
accounts.monthOfBirthstring
accounts.genderstring
accounts.emailobject
accounts.profilePhotostring
accounts.statusstring
accounts.stateCodestring
accounts.districtCodestring
accounts.subDistrictCodeobject
accounts.villageCodeobject
accounts.townCodeobject
accounts.wardCodeobject
accounts.pincodestring
accounts.addressstring
accounts.kycPhotostring
accounts.stateNamestring
accounts.districtNamestring
accounts.subdistrictNamestring
accounts.villageNameobject
accounts.townNamestring
accounts.wardNameobject
accounts.authMethodsstring[]
accounts.tagsobject
accounts.kycVerifiedboolean
accounts.verificationStatusstring
accounts.verificationTypestring
accounts.emailVerifiedobject
accounts.ABHANumberstring
accounts.preferredAbhaAddressstring
400

Bad Request

Error codes for this module