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

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
​
patientId
string
required
Maximum string length: 128
​
payorIds
string[]
required
Required array length: 1 - 10 elements
Maximum string length: 128
​
type
string

medical, dental, vision, pharmacy

Maximum string length: 200
​
subscriberId
string
Maximum string length: 200
​
subscriberRef
string
Maximum string length: 200
​
policyHolderRef
string
Maximum string length: 200
​
relationship
string

self, spouse, child, other

Maximum string length: 100
​
period
object
​
class
object[]
Maximum array length: 20
​
order
integer
​
network
string
Maximum string length: 500
​
dependent
string
Maximum string length: 200
​
subrogation
boolean

Response

201

Coverage created