Suggest Abha Address

This API endpoint is used to fetch some suggested abha id that are available on the basis of user details.

GET /abdm/na/v1/registration/suggest

Suggest Abha Address

cURL

curl --request GET \
  --url https://api.eka.care/abdm/na/v1/registration/suggest \
  --header 'Authorization: Bearer <token>'

200

{
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id · string

Eka User ID (OID)

X-Partner-Pt-Id · string

Partner User ID

X-Hip-Id · string

Partner HIP ID

Query Parameters

mn · string

Middle Name

Example:

"Singh"

ln · string

Last Name

Example:

"Kumar"

fn · string

First Name

Example:

"Raj"

dob · string

Date of Birth (YYYY-MM-DD)

Example:

"1990-05-15"

transactionId · string

Transaction id received in the previous api.

Response

200

application/json

OK

suggestions · string[] | null

List of suggested abha addresses