Skip to main content

Get the ABHA address suggestion

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.

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

This is particularly useful during the ABHA enrolment process to ensure that users can choose an appropriate and unique ABHA address.

Authorizations

Authorizationbearer tokenRequired

Headers

TRANSACTION_IDstringRequired
REQUEST-IDstringRequired
TIMESTAMPstringRequired

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.

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.<br><br> <p><strong>Types of Suggestion API Errors:</strong></p> <ol> <li><strong>Abha Address - Invalid Transaction Id:</strong> 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..</li> </ol> <ol start="2"> <li><strong>Abha Address - Invalid Preferred Flag:</strong> 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.</li> </ol>

Error codes for this module

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

500

<b>Internal Server Error</b><br><br> 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