Create eligibility request
curl --request POST \
--url https://api.clinikapi.com/v1/eligibility-requests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"purpose": [
"<string>"
],
"patientId": "<string>",
"insurerId": "<string>",
"created": "<string>",
"providerId": "<string>",
"servicedDate": "<string>",
"servicedPeriod": {
"start": "<string>",
"end": "<string>"
},
"insurance": [
{
"coverageId": "<string>",
"focal": true
}
],
"item": [
{
"category": "<string>",
"productOrService": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/eligibility-requests"
payload = {
"purpose": ["<string>"],
"patientId": "<string>",
"insurerId": "<string>",
"created": "<string>",
"providerId": "<string>",
"servicedDate": "<string>",
"servicedPeriod": {
"start": "<string>",
"end": "<string>"
},
"insurance": [
{
"coverageId": "<string>",
"focal": True
}
],
"item": [
{
"category": "<string>",
"productOrService": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
purpose: ['<string>'],
patientId: '<string>',
insurerId: '<string>',
created: '<string>',
providerId: '<string>',
servicedDate: '<string>',
servicedPeriod: {start: '<string>', end: '<string>'},
insurance: [{coverageId: '<string>', focal: true}],
item: [{category: '<string>', productOrService: '<string>'}]
})
};
fetch('https://api.clinikapi.com/v1/eligibility-requests', 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.clinikapi.com/v1/eligibility-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'purpose' => [
'<string>'
],
'patientId' => '<string>',
'insurerId' => '<string>',
'created' => '<string>',
'providerId' => '<string>',
'servicedDate' => '<string>',
'servicedPeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'insurance' => [
[
'coverageId' => '<string>',
'focal' => true
]
],
'item' => [
[
'category' => '<string>',
'productOrService' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/eligibility-requests"
payload := strings.NewReader("{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/eligibility-requests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/eligibility-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyEligibility Requests
Create Eligibility Request
POST
/
v1
/
eligibility-requests
Create eligibility request
curl --request POST \
--url https://api.clinikapi.com/v1/eligibility-requests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"purpose": [
"<string>"
],
"patientId": "<string>",
"insurerId": "<string>",
"created": "<string>",
"providerId": "<string>",
"servicedDate": "<string>",
"servicedPeriod": {
"start": "<string>",
"end": "<string>"
},
"insurance": [
{
"coverageId": "<string>",
"focal": true
}
],
"item": [
{
"category": "<string>",
"productOrService": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/eligibility-requests"
payload = {
"purpose": ["<string>"],
"patientId": "<string>",
"insurerId": "<string>",
"created": "<string>",
"providerId": "<string>",
"servicedDate": "<string>",
"servicedPeriod": {
"start": "<string>",
"end": "<string>"
},
"insurance": [
{
"coverageId": "<string>",
"focal": True
}
],
"item": [
{
"category": "<string>",
"productOrService": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
purpose: ['<string>'],
patientId: '<string>',
insurerId: '<string>',
created: '<string>',
providerId: '<string>',
servicedDate: '<string>',
servicedPeriod: {start: '<string>', end: '<string>'},
insurance: [{coverageId: '<string>', focal: true}],
item: [{category: '<string>', productOrService: '<string>'}]
})
};
fetch('https://api.clinikapi.com/v1/eligibility-requests', 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.clinikapi.com/v1/eligibility-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'purpose' => [
'<string>'
],
'patientId' => '<string>',
'insurerId' => '<string>',
'created' => '<string>',
'providerId' => '<string>',
'servicedDate' => '<string>',
'servicedPeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'insurance' => [
[
'coverageId' => '<string>',
'focal' => true
]
],
'item' => [
[
'category' => '<string>',
'productOrService' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/eligibility-requests"
payload := strings.NewReader("{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/eligibility-requests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/eligibility-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"purpose\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"created\": \"<string>\",\n \"providerId\": \"<string>\",\n \"servicedDate\": \"<string>\",\n \"servicedPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"insurance\": [\n {\n \"coverageId\": \"<string>\",\n \"focal\": true\n }\n ],\n \"item\": [\n {\n \"category\": \"<string>\",\n \"productOrService\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
active, cancelled, draft auth-requirements, benefits, discovery, validation
Required array length:
1 - 10 elementsMaximum string length:
100Maximum string length:
128Maximum string length:
128Maximum string length:
50Maximum string length:
128Maximum string length:
50Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
25Show child attributes
Show child attributes
Response
201
Eligibility request created
⌘I