Skip to main content
POST
/
v1
/
eligibility-responses
Create eligibility response
curl --request POST \
  --url https://api.clinikapi.com/v1/eligibility-responses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "purpose": [
    "<string>"
  ],
  "patientId": "<string>",
  "insurerId": "<string>",
  "created": "<string>",
  "requestId": "<string>",
  "disposition": "<string>",
  "insurance": [
    {
      "coverageId": "<string>",
      "inforce": true,
      "benefitPeriod": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "preAuthRef": "<string>",
  "error": [
    {
      "code": "<string>"
    }
  ]
}
'

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
purpose
string[]
required
Required array length: 1 - 10 elements
Maximum string length: 100
patientId
string
required
Maximum string length: 128
outcome
enum<string>
required
Available options:
queued,
complete,
error,
partial
insurerId
string
required
Maximum string length: 128
created
string
Maximum string length: 50
requestId
string
Maximum string length: 128
disposition
string
Maximum string length: 2000
insurance
object[]
Maximum array length: 10
preAuthRef
string
Maximum string length: 500
error
object[]
Maximum array length: 20

Response

201

Eligibility response created