Find ABHA via IRIS - send authentication request

Starts IRIS authentication for the ABHA account picked from *Search ABHA by mobile*.

POST/abha/api/v3/profile/login/request/otp

Send loginHint: index, the RSA-encrypted index of the chosen account, and the txnId returned by the search.

Endpoint: POST /abha/api/v3/profile/login/request/otp

Flow: Find ABHA - IRIS - step 2 of 3

Previous: Search ABHA by mobile
Next: Find ABHA via IRIS - verify

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", "search-ABHA", "Aadhaar-iris-verify"]`	yes	Scope that selects this use case. Send exactly the values listed for this API.
`loginHint`	`"index"`	yes	Type of identifier sent in `loginId`.
`loginId`	string	yes	Identifier value, RSA-encrypted with the ABHA public certificate.
`otpSystem`	`"Aadhaar"`	yes	System that generates and delivers the OTP (`Aadhaar` = UIDAI, `ABDM` = ABDM).
`txnId`	string	yes	Transaction ID returned by the previous step of this flow.

Responses

200

Success: Find ABHA Via Biometric (Iris) - Send Iris Authentication Request

txnIdstring

messagestring

400

Bad Request (request validation failed).

Error codes for this module

txnIdstring

timestampstring

401

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

Everything returns 401

codestring

messagestring

descriptionstring

404

Not Found: Resource not found

Error codes for this module

timestampstring

pathstring

descriptionstring

errorstring

requestIdstring

500

Internal Server Error.

Error codes for this module

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp \
  --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",
    "search-abha",
    "aadhaar-iris-verify"
  ],
  "loginHint": "index",
  "loginId": "{{rsaIndexEncryptionOutput}}",
  "otpSystem": "aadhaar",
  "txnId": "{{searchTxnId}}"
}'

{
  "txnId": "37d8d312-35a0-41e7-a6e4-1074eb18a5fa",
  "message": "Iris authentication request successfully sent."
}