curl --request GET \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests"
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests")
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",
"error_code": "<string>",
"error_message": "<string>",
"outcome": "<string>",
"request_id": 1,
"request_subtype": "<string>",
"request_type": "<string>",
"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 Requests
Every exchange with the payer on this claim, oldest first: eligibility, pre-auth, claim, communication and more, each with its status and outcome.
curl --request GET \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests"
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/requests")
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",
"error_code": "<string>",
"error_message": "<string>",
"outcome": "<string>",
"request_id": 1,
"request_subtype": "<string>",
"request_type": "<string>",
"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 >= 0Response
OK
ErrorCode / ErrorMessage carry a gateway/payer ProtocolResponse error so the UI can show WHY a request failed, not just that it did.
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?

