Create explanation of benefit
curl --request POST \
--url https://api.clinikapi.com/v1/eobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "<string>",
"patientId": "<string>",
"insurerId": "<string>",
"providerId": "<string>",
"insurance": [
{
"focal": true,
"coverageId": "<string>"
}
],
"created": "<string>",
"disposition": "<string>",
"claimId": "<string>",
"claimResponseId": "<string>",
"billablePeriod": {
"start": "<string>",
"end": "<string>"
},
"item": [
{
"sequence": 123,
"productOrService": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"unitPrice": {
"value": 123,
"currency": "<string>"
},
"net": {
"value": 123,
"currency": "<string>"
},
"adjudication": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"total": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
],
"payment": {
"type": "<string>",
"date": "<string>"
},
"processNote": [
{
"text": "<string>",
"number": 123
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/eobs"
payload = {
"type": "<string>",
"patientId": "<string>",
"insurerId": "<string>",
"providerId": "<string>",
"insurance": [
{
"focal": True,
"coverageId": "<string>"
}
],
"created": "<string>",
"disposition": "<string>",
"claimId": "<string>",
"claimResponseId": "<string>",
"billablePeriod": {
"start": "<string>",
"end": "<string>"
},
"item": [
{
"sequence": 123,
"productOrService": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"unitPrice": {
"value": 123,
"currency": "<string>"
},
"net": {
"value": 123,
"currency": "<string>"
},
"adjudication": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"total": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
],
"payment": {
"type": "<string>",
"date": "<string>"
},
"processNote": [
{
"text": "<string>",
"number": 123
}
]
}
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({
type: '<string>',
patientId: '<string>',
insurerId: '<string>',
providerId: '<string>',
insurance: [{focal: true, coverageId: '<string>'}],
created: '<string>',
disposition: '<string>',
claimId: '<string>',
claimResponseId: '<string>',
billablePeriod: {start: '<string>', end: '<string>'},
item: [
{
sequence: 123,
productOrService: '<string>',
quantity: {value: 123, unit: '<string>'},
unitPrice: {value: 123, currency: '<string>'},
net: {value: 123, currency: '<string>'},
adjudication: [{category: '<string>', amount: {value: 123, currency: '<string>'}}]
}
],
total: [{category: '<string>', amount: {value: 123, currency: '<string>'}}],
payment: {type: '<string>', date: '<string>'},
processNote: [{text: '<string>', number: 123}]
})
};
fetch('https://api.clinikapi.com/v1/eobs', 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/eobs",
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([
'type' => '<string>',
'patientId' => '<string>',
'insurerId' => '<string>',
'providerId' => '<string>',
'insurance' => [
[
'focal' => true,
'coverageId' => '<string>'
]
],
'created' => '<string>',
'disposition' => '<string>',
'claimId' => '<string>',
'claimResponseId' => '<string>',
'billablePeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'item' => [
[
'sequence' => 123,
'productOrService' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'unitPrice' => [
'value' => 123,
'currency' => '<string>'
],
'net' => [
'value' => 123,
'currency' => '<string>'
],
'adjudication' => [
[
'category' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
]
]
],
'total' => [
[
'category' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
],
'payment' => [
'type' => '<string>',
'date' => '<string>'
],
'processNote' => [
[
'text' => '<string>',
'number' => 123
]
]
]),
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/eobs"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\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/eobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/eobs")
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 \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyExplanation of Benefits
Create Explanation of Benefit
POST
/
v1
/
eobs
Create explanation of benefit
curl --request POST \
--url https://api.clinikapi.com/v1/eobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "<string>",
"patientId": "<string>",
"insurerId": "<string>",
"providerId": "<string>",
"insurance": [
{
"focal": true,
"coverageId": "<string>"
}
],
"created": "<string>",
"disposition": "<string>",
"claimId": "<string>",
"claimResponseId": "<string>",
"billablePeriod": {
"start": "<string>",
"end": "<string>"
},
"item": [
{
"sequence": 123,
"productOrService": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"unitPrice": {
"value": 123,
"currency": "<string>"
},
"net": {
"value": 123,
"currency": "<string>"
},
"adjudication": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"total": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
],
"payment": {
"type": "<string>",
"date": "<string>"
},
"processNote": [
{
"text": "<string>",
"number": 123
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/eobs"
payload = {
"type": "<string>",
"patientId": "<string>",
"insurerId": "<string>",
"providerId": "<string>",
"insurance": [
{
"focal": True,
"coverageId": "<string>"
}
],
"created": "<string>",
"disposition": "<string>",
"claimId": "<string>",
"claimResponseId": "<string>",
"billablePeriod": {
"start": "<string>",
"end": "<string>"
},
"item": [
{
"sequence": 123,
"productOrService": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"unitPrice": {
"value": 123,
"currency": "<string>"
},
"net": {
"value": 123,
"currency": "<string>"
},
"adjudication": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"total": [
{
"category": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
],
"payment": {
"type": "<string>",
"date": "<string>"
},
"processNote": [
{
"text": "<string>",
"number": 123
}
]
}
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({
type: '<string>',
patientId: '<string>',
insurerId: '<string>',
providerId: '<string>',
insurance: [{focal: true, coverageId: '<string>'}],
created: '<string>',
disposition: '<string>',
claimId: '<string>',
claimResponseId: '<string>',
billablePeriod: {start: '<string>', end: '<string>'},
item: [
{
sequence: 123,
productOrService: '<string>',
quantity: {value: 123, unit: '<string>'},
unitPrice: {value: 123, currency: '<string>'},
net: {value: 123, currency: '<string>'},
adjudication: [{category: '<string>', amount: {value: 123, currency: '<string>'}}]
}
],
total: [{category: '<string>', amount: {value: 123, currency: '<string>'}}],
payment: {type: '<string>', date: '<string>'},
processNote: [{text: '<string>', number: 123}]
})
};
fetch('https://api.clinikapi.com/v1/eobs', 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/eobs",
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([
'type' => '<string>',
'patientId' => '<string>',
'insurerId' => '<string>',
'providerId' => '<string>',
'insurance' => [
[
'focal' => true,
'coverageId' => '<string>'
]
],
'created' => '<string>',
'disposition' => '<string>',
'claimId' => '<string>',
'claimResponseId' => '<string>',
'billablePeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'item' => [
[
'sequence' => 123,
'productOrService' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'unitPrice' => [
'value' => 123,
'currency' => '<string>'
],
'net' => [
'value' => 123,
'currency' => '<string>'
],
'adjudication' => [
[
'category' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
]
]
],
'total' => [
[
'category' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
],
'payment' => [
'type' => '<string>',
'date' => '<string>'
],
'processNote' => [
[
'text' => '<string>',
'number' => 123
]
]
]),
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/eobs"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\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/eobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/eobs")
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 \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"insurerId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"insurance\": [\n {\n \"focal\": true,\n \"coverageId\": \"<string>\"\n }\n ],\n \"created\": \"<string>\",\n \"disposition\": \"<string>\",\n \"claimId\": \"<string>\",\n \"claimResponseId\": \"<string>\",\n \"billablePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"item\": [\n {\n \"sequence\": 123,\n \"productOrService\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"unitPrice\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"net\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"adjudication\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"total\": [\n {\n \"category\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ],\n \"payment\": {\n \"type\": \"<string>\",\n \"date\": \"<string>\"\n },\n \"processNote\": [\n {\n \"text\": \"<string>\",\n \"number\": 123\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 institutional, oral, pharmacy, professional, vision
Maximum string length:
200Available options:
claim, preauthorization, predetermination Maximum string length:
128Maximum string length:
128Maximum string length:
128Available options:
queued, complete, error, partial Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Maximum string length:
50Maximum string length:
2000Maximum string length:
128Maximum string length:
128Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Response
201
EOB created
⌘I