Verify the enrolment OTP

Flows in the Postman collection:

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

Headers

REQUEST-IDstringRequired

Unique UUID for each request.

TIMESTAMPstringRequired

Request timestamp in UTC, ISO-8601 with Z.

Body

scopestring[]

authDataobject

authData.authMethodsstring[]

authData.otpobject

authData.otp.txnIdstring

authData.otp.otpValuestring

Responses

200

400

Bad Request

Error codes for this module

Verify the enrolment OTP

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/phr/app/enrollment/verify \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-address-enroll",
    "mobile-verify"
  ],
  "authData": {
    "authMethods": [
      "otp"
    ],
    "otp": {
      "txnId": "37d8d312-35a0-41e7-a6e4-1074eb18a5fa",
      "otpValue": "{{encryptedData}}"
    }
  }
}'

{
  "txnId": "1cba575d-02cd-40be-90e6-1e2edca88a88",
  "message": "OTP Verified Successfully",
  "authResult": "success",
  "users": [
    {
      "abhaAddress": "<ABHA_ADDRESS>",
      "fullName": "John Doe",
      "abhaNumber": "XX-XXXX-XXXX-1234",
      "status": "ACTIVE",
      "kycStatus": "VERIFIED"
    }
  ],
  "tokens": {
    "token": "<JWT TOKEN>",
    "expiresIn": 1800,
    "refreshToken": "<JWT TOKEN>",
    "refreshExpiresIn": 1296000
  }
}

Generated from the schema. The values are placeholders, not a captured response.