curl --request GET \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}"
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/nhcx/v1/claims/{claimId}/requests/{correlationId}', 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/nhcx/v1/claims/{claimId}/requests/{correlationId}",
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/nhcx/v1/claims/{claimId}/requests/{correlationId}"
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/nhcx/v1/claims/{claimId}/requests/{correlationId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}")
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{
"approved_amount": 123,
"correlation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"documents": [
{
"category": "<string>",
"content_type": "<string>",
"doc_id": "<string>",
"title": "<string>"
}
],
"error_code": "<string>",
"error_message": "<string>",
"items": [
{
"approved_amount": 123,
"claim_amount": 123,
"copay_amount": 123,
"deducted_amount": 123,
"procedure_code": "<string>",
"quantity": 123,
"reason_code": "<string>",
"reasons": [
"<string>"
],
"sequence": 123,
"speciality_code": "<string>",
"state": "<string>",
"strat_code": "<string>"
}
],
"outcome": "<string>",
"request_id": 1,
"request_meta": "<unknown>",
"request_subtype": "<string>",
"request_type": "<string>",
"response_meta": "<unknown>",
"status": "<string>",
"submitted_amount": 123,
"updated_at": "2023-11-07T05:31:56Z",
"workflow_id": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Get Claim Request
One exchange in full: what was sent (request_meta, documents), the parsed payer answer (response_meta, empty while pending) and the per-item verdicts (items).
curl --request GET \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}"
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/nhcx/v1/claims/{claimId}/requests/{correlationId}', 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/nhcx/v1/claims/{claimId}/requests/{correlationId}",
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/nhcx/v1/claims/{claimId}/requests/{correlationId}"
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/nhcx/v1/claims/{claimId}/requests/{correlationId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}")
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{
"approved_amount": 123,
"correlation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"documents": [
{
"category": "<string>",
"content_type": "<string>",
"doc_id": "<string>",
"title": "<string>"
}
],
"error_code": "<string>",
"error_message": "<string>",
"items": [
{
"approved_amount": 123,
"claim_amount": 123,
"copay_amount": 123,
"deducted_amount": 123,
"procedure_code": "<string>",
"quantity": 123,
"reason_code": "<string>",
"reasons": [
"<string>"
],
"sequence": 123,
"speciality_code": "<string>",
"state": "<string>",
"strat_code": "<string>"
}
],
"outcome": "<string>",
"request_id": 1,
"request_meta": "<unknown>",
"request_subtype": "<string>",
"request_type": "<string>",
"response_meta": "<unknown>",
"status": "<string>",
"submitted_amount": 123,
"updated_at": "2023-11-07T05:31:56Z",
"workflow_id": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Authorizations
The API requires a Bearer token (JWT) for authentication.
Headers
Eka User ID (OID)
Partner User ID
Partner HIP ID
Path Parameters
claim_id returned by Create Claim
x >= 0request_id from a submit, or correlation_id from Get Claim Requests
Response
OK
Show child attributes
Show child attributes
ErrorCode / ErrorMessage carry a gateway/payer ProtocolResponse error so the UI can show WHY a request failed, not just that it did.
Show child attributes
Show child attributes
x >= 0Distinguishes a variant within RequestType that workflow_id cannot (e.g. "cancel"/"enhancement"/"reprocess" within request_type "preauth"/"claim") — and, for request_type "communication", carries the payer's Task.reasonCode (tatquery/grievance/ walletupdate/policychange/additionalinfo), which has no workflow_id at all. Previously unexposed on this summary; see nhcx_api_contract_changes.md.
Was this page helpful?

