Skip to main content

After ABHA creation - get ABHA address suggestions

Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion

GET/abha/api/v3/enrollment/enrol/suggestion

Flow: Create ABHA - IRIS - step 6 of 7

  • Previous: *After ABHA creation - verify email OTP (optional)*
  • Next: *After ABHA creation - create ABHA address*

---

This API endpoint is used to provide suggestions for ABHA addresses based on the user’s personal information. It helps users find suitable ABHA addresses by generating a list of suggestions. This is particularly useful during the ABHA enrolment process to ensure that users can choose an appropriate and unique ABHA address.

Authorizations

Authorizationbearer tokenRequired

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

Headers

TRANSACTION_IDstringRequired

Transaction ID from the ABHA creation response.

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Responses

200

The 200 response code indicates a successful request. In this context, it refers to the successful operation of the Suggestion API, suggestions for ABHA addresses based on the user’s personal information.

txnIdstring
abhaAddressListstring[]
400

The 400 response code indicates a bad request. In this context, it refers to various errors encountered during the operation of the Suggestion API.

Types of Suggestion API Errors:

Abha Address - Invalid Transaction Id: This error occurs when the transaction ID provided in the request is invalid. The transaction ID is essential for tracking the request and ensuring that the correct information is processed..

Abha Address - Invalid Preferred Flag: This error occurs when the preferred flag provided in the request is invalid. The preferred flag indicates the user’s preference for the suggested ABHA address.

Error codes for this module

txnIdstring
timestampstring
401

The 401 response code indicates an unauthorized request. In this context, This error occurs when the transaction ID provided in the request is invalid. The transaction ID is essential for tracking the request and ensuring that the correct information is processed. An invalid transaction ID means the server cannot verify the request, leading to a failure in generating ABHA address suggestions.

Everything returns 401

errorobject
error.codestring
error.messagestring
500

Internal Server Error

An Internal Server Error (500) indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error codes for this module