Create user

POST

organizations

{organization_id}

users

cURL

curl --request POST \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-secret: <x-organization-secret>' \
  --data '
{
  "given_name": "Darlene",
  "family_name": "Cameron",
  "email": "darlene.cameron@example.com",
  "date_of_birth": "1969-10-02",
  "sex": "F",
  "phone": "0412345678",
  "access_roles": [
    "admin",
    "provider"
  ],
  "hpii_number": "8003614900029560",
  "prescriber_type": "M",
  "prescriber_number": "1234567",
  "qualifications": "MBBS, FRACGP",
  "title": "Dr",
  "provider_number": "123456789",
  "ahpra_number": "MED0000932846",
  "hospital_provider_number": "H123456",
  "erx_entity_id": "AB12C"
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users"

payload = {
    "given_name": "Darlene",
    "family_name": "Cameron",
    "email": "darlene.cameron@example.com",
    "date_of_birth": "1969-10-02",
    "sex": "F",
    "phone": "0412345678",
    "access_roles": ["admin", "provider"],
    "hpii_number": "8003614900029560",
    "prescriber_type": "M",
    "prescriber_number": "1234567",
    "qualifications": "MBBS, FRACGP",
    "title": "Dr",
    "provider_number": "123456789",
    "ahpra_number": "MED0000932846",
    "hospital_provider_number": "H123456",
    "erx_entity_id": "AB12C"
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    given_name: 'Darlene',
    family_name: 'Cameron',
    email: 'darlene.cameron@example.com',
    date_of_birth: '1969-10-02',
    sex: 'F',
    phone: '0412345678',
    access_roles: ['admin', 'provider'],
    hpii_number: '8003614900029560',
    prescriber_type: 'M',
    prescriber_number: '1234567',
    qualifications: 'MBBS, FRACGP',
    title: 'Dr',
    provider_number: '123456789',
    ahpra_number: 'MED0000932846',
    hospital_provider_number: 'H123456',
    erx_entity_id: 'AB12C'
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users', 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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users",
  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([
    'given_name' => 'Darlene',
    'family_name' => 'Cameron',
    'email' => 'darlene.cameron@example.com',
    'date_of_birth' => '1969-10-02',
    'sex' => 'F',
    'phone' => '0412345678',
    'access_roles' => [
        'admin',
        'provider'
    ],
    'hpii_number' => '8003614900029560',
    'prescriber_type' => 'M',
    'prescriber_number' => '1234567',
    'qualifications' => 'MBBS, FRACGP',
    'title' => 'Dr',
    'provider_number' => '123456789',
    'ahpra_number' => 'MED0000932846',
    'hospital_provider_number' => 'H123456',
    'erx_entity_id' => 'AB12C'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users"

	payload := strings.NewReader("{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 201,
  "message": "User created successfully",
  "code": "USER_CREATED",
  "data": {
    "user_id": "0b4c1a49-fea8-4922-a3da-2ca8ff8af9bd"
  },
  "timestamp": "2026-09-04T10:30:00.000Z",
  "requestId": "1-68d1b225-2a98752c7b2da3fa489267fc"
}

Overview

Creates a Parchment login for a user in your organization and assigns roles. When access_roles contains provider or rx_queue_manager, Parchment also verifies the HPI-I against the HI Service and creates a provider record. A 201 is not always a complete success. Read code. Every USER_CREATED_PROVIDER_* code means the login and roles exist but there is no provider record, and the user cannot create prescriptions. The response returns user_id only. There is no partner_user_id. Map user_id to your own record.

Request Example

{
  "given_name": "Darlene",
  "family_name": "Cameron",
  "date_of_birth": "1969-10-02",
  "sex": "F",
  "email": "darlene.cameron@example.com",
  "phone": "0412345678",
  "access_roles": ["admin", "provider"],
  "hpii_number": "8003614900029560",
  "prescriber_type": "M",
  "prescriber_number": "1234567",
  "qualifications": "MBBS, FRACGP",
  "title": "Dr",
  "provider_number": "123456789",
  "ahpra_number": "MED0000932846",
  "hospital_provider_number": "H123456"
}

Response Examples

Created (201)

{
  "success": true,
  "statusCode": 201,
  "message": "User created successfully",
  "code": "USER_CREATED",
  "data": {
    "user_id": "0b4c1a49-fea8-4922-a3da-2ca8ff8af9bd"
  },
  "timestamp": "2025-09-22T20:31:54.558Z",
  "requestId": "1-68d1b225-2a98752c7b2da3fa489267fc"
}

Created, No Provider Record (201)

{
  "success": true,
  "statusCode": 201,
  "message": "User created but provider not found",
  "code": "USER_CREATED_PROVIDER_NOT_FOUND",
  "data": {
    "user_id": "faa41171-235e-4822-b524-9f8bb07ebd3d",
    "warning": "User created successfully but provider search failed"
  },
  "timestamp": "2025-09-22T20:48:47.878Z",
  "requestId": "1-68d1b61a-156915754ad812fd58a24d90"
}

Email Already Registered (409)

{
  "success": false,
  "statusCode": 409,
  "code": "USER_ALREADY_EXISTS",
  "error": {
    "type": "https://parchment.health/errors/resource-conflict",
    "title": "Resource conflict",
    "detail": "User with this email already exists"
  },
  "timestamp": "2025-09-22T20:46:51.702Z",
  "requestId": "1-68d1b5b6-31fbc67e15cff9b13268e6f0"
}

Validation Error (422)

{
  "success": false,
  "statusCode": 422,
  "code": "VALIDATION_ERROR",
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "validation": [
      {
        "field": "hpii_number",
        "message": "HPII Number is required and must be valid when access_roles contains \"provider\" or \"rx_queue_manager\"",
        "code": "VALIDATION_ERROR"
      }
    ]
  },
  "timestamp": "2025-09-22T20:47:35.790Z",
  "requestId": "1-68d1b5e7-0a243a3a24ba148126eff847"
}

Unauthorized (401)

{
  "success": false,
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "error": {
    "type": "https://parchment.health/errors/authentication-required",
    "title": "Unauthorized",
    "detail": "Insufficient scope"
  },
  "timestamp": "2025-09-22T20:50:36.942Z",
  "requestId": "1-68d1b69c-3599f32a653cd17e49a79a07"
}

Result Codes

`code`	Provider record	Cause	Action
`USER_CREATED`	Yes	All steps completed.	None.
`USER_CREATED_PROVIDER_NOT_FOUND`	No	The HI Service found no HPI-I record for the supplied demographics.	Correct the demographics. Call Update User with `provider_details`.
`USER_CREATED_PROVIDER_SEARCH_FAILED`	No	The lookup could not run: no HPI-O, HI Service down, or data rejected.	Check the organization has an HPI-O. Retry later.
`USER_CREATED_PROVIDER_ALREADY_EXISTS`	No	Another active provider in this organization holds this `hpii_number`.	Disable the duplicate, or call Update User with the correct HPI-I.
`USER_CREATED_PROVIDER_INVALID_PARAMS`	No	The provider record was rejected.	Contact Parchment support with the `requestId`.
`USER_CREATED_PROVIDER_RESOURCE_NOT_FOUND`	No	A required record (usually the organization) was not found.	Contact Parchment support with the `requestId`.
`USER_CREATED_PROVIDER_FAILED`	No	Provider creation failed for another reason.	Contact Parchment support with the `requestId`.
`USER_CREATED_ROLES_FAILED`	No	The login exists but no roles were assigned.	Contact Parchment support with the `requestId`.

A user with rx_queue_manager but not provider always returns USER_CREATED, even when the provider record was not created. Read the user back and check provider_details is not null.

Response Fields

Field	Type	Description
`user_id`	string	Parchment’s identifier for the new user. The only identifier returned.
`warning`	string	Partial success only. Names the step that did not complete. Branch on `code`, not on this text.

Request Fields

Field	Required	Rule
`given_name`	Always	Not empty. Legal given name only, no middle names.
`family_name`	Always	Not empty.
`email`	Always	Valid email. Unique across all of Parchment, stored lower-case.
`access_roles`	No	`admin`, `provider`, `receptionist`, `rx_reader`, `rx_queue_manager`. Omitted: the user gets `member` only.
`date_of_birth`	`provider` or `rx_queue_manager`	`YYYY-MM-DD`.
`sex`	`provider` or `rx_queue_manager`	`M`, `F`, `I`, `N`.
`hpii_number`	`provider` or `rx_queue_manager`	16 digits. Must pass the HPI-I check digit.
`qualifications`	`provider` or `rx_queue_manager`	Not empty.
`prescriber_type`	`provider`	`M` medical, `E` optometrist, `U` nurse, `F` midwife, `D` dentist, `V` veterinarian, `T` podiatrist, `C` pharmacist.
`prescriber_number`	`provider`, unless `prescriber_type` is `T`	Max 10 characters.
`provider_number`	No	Max 10 characters.
`ahpra_number`	No	3-letter prefix + 10 digits, e.g. `MED0000932846`.
`erx_entity_id`	No	Exactly 5 alphanumeric characters.
`title`, `phone`, `hospital_provider_number`	No	Free text. `phone` is not validated. Send an Australian number such as `0412345678` or `+61412345678`.

Status Codes

Code	Meaning
201	User created. Read `code`.
400	The identity provider rejected the user parameters, for example a malformed email.
401	Authentication failed, or the token lacks the `create:user` scope.
403	Rejected by the API gateway, or the user creation service refused access.
404	Platform configuration error. Contact Parchment support with the `requestId`.
409	A Parchment user already exists with this email, possibly in another organization.
422	Validation failed. See `error.validation`.
429	Rate limited by the identity provider. Retry with back-off.
500	Unexpected error, including a request body that is not valid JSON.

Notes

The HI Service lookup sends hpii_number, given_name, family_name, date_of_birth and sex. All five must match the record held by Services Australia.
Parchment never returns the HI Service reason or the HPI-I number. Quote the requestId to Parchment support.
Patient operations are not affected by a missing provider record. Patients belong to the organization.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-secret

string

required

Organization secret for authentication - provided by Parchment

Path Parameters

organization_id

string<uuid>

required

Organization ID

Body

application/json

User data to add to Parchment

User information to be created

given_name

string

required

User's given name

Minimum string length: 1

Example:

"Darlene"

family_name

string

required

User's family name

Minimum string length: 1

Example:

"Cameron"

string<email>

required

User's email address

Example:

"darlene.cameron@example.com"

date_of_birth

string<date>

User's date of birth in YYYY-MM-DD format (required if role includes 'provider' or 'rx_queue_manager')

Example:

"1969-10-02"

sex

enum<string>

User's sex — M (male), F (female), I (indeterminate), N (not stated). Required if access_roles includes 'provider' or 'rx_queue_manager'.

Available options:

M,

F,

I,

N

Example:

"F"

phone

string

Contact phone number. Not validated by the API — send an Australian number (04xxxxxxxx, 0[2378]xxxxxxxx, or +61 prefixed) so it prints correctly on prescriptions.

Example:

"0412345678"

access_roles

enum<string>[]

Roles for the user. Omitted: the user gets member only. provider and rx_queue_manager require date_of_birth, sex, hpii_number and qualifications; provider also requires prescriber_type, and prescriber_number unless prescriber_type is T.

Available options:

admin,

provider,

receptionist,

rx_reader,

rx_queue_manager

Example:

["admin", "provider"]

hpii_number

string

Healthcare Provider Individual Identifier, 16 digits with a valid check digit. Required when access_roles includes provider or rx_queue_manager. Verified against the HI Service together with given_name, family_name, date_of_birth and sex.

Example:

"8003614900029560"

prescriber_type

enum<string>

Prescriber type — M (medical practitioner), E (optometrist), U (nurse), F (midwife), D (dentist), V (veterinarian), T (podiatrist), C (pharmacist). Required if access_roles includes 'provider'.

Available options:

M,

E,

U,

F,

D,

V,

T,

C

Example:

"M"

prescriber_number

string

Prescriber number (required if role includes 'provider' and prescriber_type is not 'T')

Maximum string length: 10

Example:

"1234567"

qualifications

string

Professional qualifications. Required when access_roles includes provider or rx_queue_manager.

Example:

"MBBS, FRACGP"

title

string

Professional title

Example:

"Dr"

provider_number

string

Medicare provider number

Maximum string length: 10

Example:

"123456789"

ahpra_number

string

AHPRA registration number: a 3-letter profession prefix followed by 10 digits (13 characters).

Pattern: ^[A-Z]{3}[0-9]{10}$

Example:

"MED0000932846"

hospital_provider_number

string

Hospital provider number

Example:

"H123456"

erx_entity_id

string

eRx Entity ID — exactly 5 alphanumeric characters.

Required string length: 5

Pattern: ^[A-Za-z0-9]{5}$

Example:

"AB12C"

Response

User created. Read the code field — a provider record may not have been created.

success

boolean

required

Example:

true

statusCode

integer

required

Example:

201

message

string

required

Example:

"User created successfully"

code

enum<string>

required

Result code. USER_CREATED means the provider record exists. Any USER_CREATED_PROVIDER_* code means there is no provider record and the user cannot prescribe.

Available options:

USER_CREATED,

USER_CREATED_PROVIDER_NOT_FOUND,

USER_CREATED_PROVIDER_SEARCH_FAILED,

USER_CREATED_PROVIDER_ALREADY_EXISTS,

USER_CREATED_PROVIDER_INVALID_PARAMS,

USER_CREATED_PROVIDER_RESOURCE_NOT_FOUND,

USER_CREATED_PROVIDER_FAILED,

USER_CREATED_ROLES_FAILED

Example:

"USER_CREATED"

data

object

required

User creation/update response data

Show child attributes

timestamp

string<date-time>

required

Example:

"2025-09-22T20:31:54.558Z"

requestId

string

required

Example:

"1-68d1b225-2a98752c7b2da3fa489267fc"

cURL

curl --request POST \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-secret: <x-organization-secret>' \
  --data '
{
  "given_name": "Darlene",
  "family_name": "Cameron",
  "email": "darlene.cameron@example.com",
  "date_of_birth": "1969-10-02",
  "sex": "F",
  "phone": "0412345678",
  "access_roles": [
    "admin",
    "provider"
  ],
  "hpii_number": "8003614900029560",
  "prescriber_type": "M",
  "prescriber_number": "1234567",
  "qualifications": "MBBS, FRACGP",
  "title": "Dr",
  "provider_number": "123456789",
  "ahpra_number": "MED0000932846",
  "hospital_provider_number": "H123456",
  "erx_entity_id": "AB12C"
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users"

payload = {
    "given_name": "Darlene",
    "family_name": "Cameron",
    "email": "darlene.cameron@example.com",
    "date_of_birth": "1969-10-02",
    "sex": "F",
    "phone": "0412345678",
    "access_roles": ["admin", "provider"],
    "hpii_number": "8003614900029560",
    "prescriber_type": "M",
    "prescriber_number": "1234567",
    "qualifications": "MBBS, FRACGP",
    "title": "Dr",
    "provider_number": "123456789",
    "ahpra_number": "MED0000932846",
    "hospital_provider_number": "H123456",
    "erx_entity_id": "AB12C"
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    given_name: 'Darlene',
    family_name: 'Cameron',
    email: 'darlene.cameron@example.com',
    date_of_birth: '1969-10-02',
    sex: 'F',
    phone: '0412345678',
    access_roles: ['admin', 'provider'],
    hpii_number: '8003614900029560',
    prescriber_type: 'M',
    prescriber_number: '1234567',
    qualifications: 'MBBS, FRACGP',
    title: 'Dr',
    provider_number: '123456789',
    ahpra_number: 'MED0000932846',
    hospital_provider_number: 'H123456',
    erx_entity_id: 'AB12C'
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users', 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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users",
  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([
    'given_name' => 'Darlene',
    'family_name' => 'Cameron',
    'email' => 'darlene.cameron@example.com',
    'date_of_birth' => '1969-10-02',
    'sex' => 'F',
    'phone' => '0412345678',
    'access_roles' => [
        'admin',
        'provider'
    ],
    'hpii_number' => '8003614900029560',
    'prescriber_type' => 'M',
    'prescriber_number' => '1234567',
    'qualifications' => 'MBBS, FRACGP',
    'title' => 'Dr',
    'provider_number' => '123456789',
    'ahpra_number' => 'MED0000932846',
    'hospital_provider_number' => 'H123456',
    'erx_entity_id' => 'AB12C'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users"

	payload := strings.NewReader("{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"Darlene\",\n  \"family_name\": \"Cameron\",\n  \"email\": \"darlene.cameron@example.com\",\n  \"date_of_birth\": \"1969-10-02\",\n  \"sex\": \"F\",\n  \"phone\": \"0412345678\",\n  \"access_roles\": [\n    \"admin\",\n    \"provider\"\n  ],\n  \"hpii_number\": \"8003614900029560\",\n  \"prescriber_type\": \"M\",\n  \"prescriber_number\": \"1234567\",\n  \"qualifications\": \"MBBS, FRACGP\",\n  \"title\": \"Dr\",\n  \"provider_number\": \"123456789\",\n  \"ahpra_number\": \"MED0000932846\",\n  \"hospital_provider_number\": \"H123456\",\n  \"erx_entity_id\": \"AB12C\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 201,
  "message": "User created successfully",
  "code": "USER_CREATED",
  "data": {
    "user_id": "0b4c1a49-fea8-4922-a3da-2ca8ff8af9bd"
  },
  "timestamp": "2026-09-04T10:30:00.000Z",
  "requestId": "1-68d1b225-2a98752c7b2da3fa489267fc"
}

API Documentation

Authentication

Authentication Endpoints

Patient Management Endpoints

User Management Endpoints

Custom Drug Endpoints

Overview

Request Example

Response Examples

Created (201)

Created, No Provider Record (201)

Email Already Registered (409)

Validation Error (422)

Unauthorized (401)

Result Codes

Response Fields

Request Fields

Status Codes

Notes

Authorizations

Headers

Path Parameters

Body

Response

​Overview

​Request Example

​Response Examples

​Created (201)

​Created, No Provider Record (201)

​Email Already Registered (409)

​Validation Error (422)

​Unauthorized (401)

​Result Codes

​Response Fields

​Request Fields

​Status Codes

​Notes

Authorizations

Headers

Path Parameters

Body

Response

Overview

Request Example

Response Examples

Created (201)

Created, No Provider Record (201)

Email Already Registered (409)

Validation Error (422)

Unauthorized (401)

Result Codes

Response Fields

Request Fields

Status Codes

Notes