Login via Biometric (Iris) - v3.1 single step

v3.1 IRIS login in a single call. Send the encrypted Aadhaar number and the IRIS PID. Returns the user X-token (token). No send-request step is needed.

POST/abha/api/v3.1/profile/login/verify

Endpoint: POST /abha/api/v3.1/profile/login/verify

Flow: Login - Biometric v3.1 - independent API; call the one that fits your identifier / modality.

Headers (plus Authorization: Bearer <gateway token>):

Header	Required	Description
REQUEST-ID	yes	Unique UUID for every request.
TIMESTAMP	yes	Current UTC timestamp in ISO-8601 format.

Request body for this use case:

Field	Value / Type	Required	Description
`scope`	`["ABHA-login", "Aadhaar-iris-login-verify"]`	yes	Scope that selects this use case. Send exactly the values listed for this API.
`authData`	object	yes	Authentication payload for this use case.
`authData.authMethods`	`["iris_login"]`	yes	Authentication method used in this step.
`authData.iris_login`	object	yes	IRIS login block (v3.1).
`authData.iris_login.aadhaar`	string	yes	Aadhaar number, RSA-encrypted.
`authData.iris_login.irisAuthPid`	string	yes	Base64 PID block captured from a registered IRIS RD device.

Note: This API is only in the Postman collection (v3.1). The request/response is taken from there, and the success response shape reuses the v3 biometric verify example.

Responses

200

Success: Verify Login via Iris (v3.1) - Positive flow

authResultstring

messagestring

tokenstring

expiresIninteger

refreshTokenstring

refreshExpiresIninteger

accountsobject[]

accounts.ABHANumberstring

accounts.preferredAbhaAddressstring

accounts.namestring

accounts.statusstring

accounts.profilePhotostring

400

Bad Request (request validation failed).

Error codes for this module

401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Invalid Credentials (generic)

Everything returns 401

codestring

descriptionstring

messagestring

404

Not Found: User Not Found; Resource Not Found

Error codes for this module

errorobject

error.codestring

error.messagestring

500

Internal Server Error.

Error codes for this module

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3.1/profile/login/verify \
  --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 '{
  "scope": [
    "abha-login",
    "aadhaar-iris-login-verify"
  ],
  "authData": {
    "authMethods": [
      "iris_login"
    ],
    "iris_login": {
      "aadhaar": "{{encryptedAadhaar}}",
      "irisAuthPid": "{{irisAuthPid}}"
    }
  }
}'

{
  "txnId": "a2s9f59d-dfba-4261-8ea2-16541cfd6f2a",
  "authResult": "success",
  "message": "IRIS verified successfully",
  "token": "<TOKEN>",
  "expiresIn": 1800,
  "refreshToken": "<TOKEN>",
  "refreshExpiresIn": 1296000,
  "accounts": [
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    }
  ]
}