ABHA QR Code

Fetch the data for ABHA qr code display.

Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.

There is no fixed structure for this JSON; it can vary depending on the creation of ABHA. Generate the QR code based on the content of the response body.

GET /abdm/v1/profile/asset/qr

cURL

cURL

curl --request GET \
  --url https://api.eka.care/abdm/v1/profile/asset/qr \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.eka.care/abdm/v1/profile/asset/qr"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eka.care/abdm/v1/profile/asset/qr', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/abdm/v1/profile/asset/qr",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/abdm/v1/profile/asset/qr"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eka.care/abdm/v1/profile/asset/qr")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/v1/profile/asset/qr")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "address": "<string>",
  "dist name": "<string>",
  "distlgd": "<string>",
  "district_name": "<string>",
  "dob": "<string>",
  "gender": "<string>",
  "hid": "<string>",
  "hidn": "<string>",
  "mobile": "<string>",
  "name": "<string>",
  "phr": "<string>",
  "state name": "<string>",
  "statelgd": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<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

format · enum<string>

Available options: json

oid · string

OID is used to Identify the user.

Response

200

application/json

OK

address · string

dist name · string

distlgd · string

district_name · string

dob · string

gender · string

hid · string

hidn · string

mobile · string

name · string

phr · string

state name · string

statelgd · string