Skip to main content
POST
/
v1
/
accounts
Create account
curl --request POST \
  --url https://api.clinikapi.com/v1/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "patientId": "<string>",
  "servicePeriod": {
    "start": "<string>",
    "end": "<string>"
  },
  "coverage": [
    {
      "coverageId": "<string>",
      "priority": 123
    }
  ],
  "ownerId": "<string>",
  "description": "<string>",
  "guarantor": [
    {
      "partyId": "<string>",
      "onHold": true,
      "period": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "partOfId": "<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,
inactive,
on-hold
type
string

Account type (patient, expense, depreciation)

name
string
Maximum string length: 500
patientId
string
servicePeriod
object
coverage
object[]
ownerId
string

Organization managing the account

description
string
Maximum string length: 2000
guarantor
object[]
partOfId
string

Parent account ID

Response

201

Account created