Create coverage
curl --request POST \
--url https://api.clinikapi.com/v1/coverages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"payorIds": [
"<string>"
],
"type": "<string>",
"subscriberId": "<string>",
"subscriberRef": "<string>",
"policyHolderRef": "<string>",
"relationship": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"class": [
{
"type": "<string>",
"value": "<string>",
"name": "<string>"
}
],
"order": 123,
"network": "<string>",
"dependent": "<string>",
"subrogation": true
}
'import requests
url = "https://api.clinikapi.com/v1/coverages"
payload = {
"patientId": "<string>",
"payorIds": ["<string>"],
"type": "<string>",
"subscriberId": "<string>",
"subscriberRef": "<string>",
"policyHolderRef": "<string>",
"relationship": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"class": [
{
"type": "<string>",
"value": "<string>",
"name": "<string>"
}
],
"order": 123,
"network": "<string>",
"dependent": "<string>",
"subrogation": True
}
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({
patientId: '<string>',
payorIds: ['<string>'],
type: '<string>',
subscriberId: '<string>',
subscriberRef: '<string>',
policyHolderRef: '<string>',
relationship: '<string>',
period: {start: '<string>', end: '<string>'},
class: [{type: '<string>', value: '<string>', name: '<string>'}],
order: 123,
network: '<string>',
dependent: '<string>',
subrogation: true
})
};
fetch('https://api.clinikapi.com/v1/coverages', 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/coverages",
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([
'patientId' => '<string>',
'payorIds' => [
'<string>'
],
'type' => '<string>',
'subscriberId' => '<string>',
'subscriberRef' => '<string>',
'policyHolderRef' => '<string>',
'relationship' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'class' => [
[
'type' => '<string>',
'value' => '<string>',
'name' => '<string>'
]
],
'order' => 123,
'network' => '<string>',
'dependent' => '<string>',
'subrogation' => true
]),
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/coverages"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\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/coverages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/coverages")
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 \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\n}"
response = http.request(request)
puts response.read_bodyCoverages
Create Coverage
POST
/
v1
/
coverages
Create coverage
curl --request POST \
--url https://api.clinikapi.com/v1/coverages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"payorIds": [
"<string>"
],
"type": "<string>",
"subscriberId": "<string>",
"subscriberRef": "<string>",
"policyHolderRef": "<string>",
"relationship": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"class": [
{
"type": "<string>",
"value": "<string>",
"name": "<string>"
}
],
"order": 123,
"network": "<string>",
"dependent": "<string>",
"subrogation": true
}
'import requests
url = "https://api.clinikapi.com/v1/coverages"
payload = {
"patientId": "<string>",
"payorIds": ["<string>"],
"type": "<string>",
"subscriberId": "<string>",
"subscriberRef": "<string>",
"policyHolderRef": "<string>",
"relationship": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"class": [
{
"type": "<string>",
"value": "<string>",
"name": "<string>"
}
],
"order": 123,
"network": "<string>",
"dependent": "<string>",
"subrogation": True
}
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({
patientId: '<string>',
payorIds: ['<string>'],
type: '<string>',
subscriberId: '<string>',
subscriberRef: '<string>',
policyHolderRef: '<string>',
relationship: '<string>',
period: {start: '<string>', end: '<string>'},
class: [{type: '<string>', value: '<string>', name: '<string>'}],
order: 123,
network: '<string>',
dependent: '<string>',
subrogation: true
})
};
fetch('https://api.clinikapi.com/v1/coverages', 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/coverages",
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([
'patientId' => '<string>',
'payorIds' => [
'<string>'
],
'type' => '<string>',
'subscriberId' => '<string>',
'subscriberRef' => '<string>',
'policyHolderRef' => '<string>',
'relationship' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'class' => [
[
'type' => '<string>',
'value' => '<string>',
'name' => '<string>'
]
],
'order' => 123,
'network' => '<string>',
'dependent' => '<string>',
'subrogation' => true
]),
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/coverages"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\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/coverages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/coverages")
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 \"patientId\": \"<string>\",\n \"payorIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"subscriberId\": \"<string>\",\n \"subscriberRef\": \"<string>\",\n \"policyHolderRef\": \"<string>\",\n \"relationship\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"class\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"network\": \"<string>\",\n \"dependent\": \"<string>\",\n \"subrogation\": true\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 Maximum string length:
128Required array length:
1 - 10 elementsMaximum string length:
128medical, dental, vision, pharmacy
Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200self, spouse, child, other
Maximum string length:
100Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
500Maximum string length:
200Response
201
Coverage created
⌘I