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>"
}
'import requests
url = "https://api.clinikapi.com/v1/accounts"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.clinikapi.com/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/accounts"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAccounts
Create Account
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>"
}
'import requests
url = "https://api.clinikapi.com/v1/accounts"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.clinikapi.com/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/accounts"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"patientId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"coverage\": [\n {\n \"coverageId\": \"<string>\",\n \"priority\": 123\n }\n ],\n \"ownerId\": \"<string>\",\n \"description\": \"<string>\",\n \"guarantor\": [\n {\n \"partyId\": \"<string>\",\n \"onHold\": true,\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"partOfId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
active, inactive, on-hold Account type (patient, expense, depreciation)
Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
Organization managing the account
Maximum string length:
2000Show child attributes
Show child attributes
Parent account ID
Response
201
Account created
⌘I