PATCH

/v1/insurance_cards/{id}

Authorization*
curl --request PATCH \
  --url https://api.opkit.co/v1/insurance_cards/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json'
{
  "back_photo_download_url": "string",
  "created_at": "string",
  "dependent_names": [
    "string"
  ],
  "front_photo_download_url": "string",
  "group_number": "string",
  "id": "string",
  "insurance_carrier_ids": [
    "string"
  ],
  "member_id": "string",
  "member_name": "string",
  "network_status": "in_network",
  "plan_name": "string",
  "plan_status": "active",
  "plan_status_fetched_at": "string",
  "reference_id": "string",
  "rx_bin": "string",
  "rx_group": "string",
  "rx_pcn": "string",
  "source": "collection_page",
  "submission_id": "string"
}

Authorizations

Authorizationheaderrequired
string

The Opkit API uses the HTTP Bearer Token scheme for authentication. You should provide your API key in the Authorization header like so: "Authorization: Bearer [api-key]".

Path Parameters

idrequired
string

Body

application/json
back_photo_object_key
string | null
dependent_names
string[] | null
front_photo_object_key
string | null
group_number
string | null
insurance_carrier_ids
string[]
member_id
string | null
member_name
string | null
network_status
enum<string> | null
Available options:
in_network,
out_of_network
plan_name
string | null
reference_id
string | null
rx_bin
string | null
rx_group
string | null
rx_pcn
string | null

Response

200 - application/json
back_photo_download_url
string
created_atrequired
string
dependent_names
string[]
front_photo_download_url
string
group_number
string
idrequired
string
insurance_carrier_idsrequired
string[]
member_id
string
member_name
string
network_status
enum<string> | null
Available options:
in_network,
out_of_network
plan_name
string
plan_status
enum<string>
Available options:
active,
inactive
plan_status_fetched_at
string
reference_id
string
rx_bin
string
rx_group
string
rx_pcn
string
sourcerequired
enum<string>
Available options:
collection_page,
dashboard,
api
submission_id
string