Skip to main content
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
    }
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
active,
cancelled,
draft
type
string
required

institutional, oral, pharmacy, professional, vision

Maximum string length: 200
use
enum<string>
required
Available options:
claim,
preauthorization,
predetermination
patientId
string
required
Maximum string length: 128
insurerId
string
required
Maximum string length: 128
providerId
string
required
Maximum string length: 128
outcome
enum<string>
required
Available options:
queued,
complete,
error,
partial
insurance
object[]
required
Required array length: 1 - 10 elements
created
string
Maximum string length: 50
disposition
string
Maximum string length: 2000
claimId
string
Maximum string length: 128
claimResponseId
string
Maximum string length: 128
billablePeriod
object
item
object[]
Maximum array length: 50
total
object[]
Maximum array length: 10
payment
object
processNote
object[]
Maximum array length: 20

Response

201

EOB created