Create a client entity
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/entities \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"entityType": "Company",
"entityTypeID": 2,
"clientStatus": "Lead",
"entityCode": "NEW-2048",
"externalSystemID": "EXT-9001",
"entityName": "Harbour View Pty Ltd",
"email": "contact@harbourview.example",
"telephone": "+61 2 8000 3300",
"physicalAddress": {
"address1": "Level 4, 55 Pitt Street",
"city": "Sydney",
"state": "NSW",
"postcode": "2000",
"country": "AU"
}
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/entities"
payload = {
"entityType": "Company",
"entityTypeID": 2,
"clientStatus": "Lead",
"entityCode": "NEW-2048",
"externalSystemID": "EXT-9001",
"entityName": "Harbour View Pty Ltd",
"email": "contact@harbourview.example",
"telephone": "+61 2 8000 3300",
"physicalAddress": {
"address1": "Level 4, 55 Pitt Street",
"city": "Sydney",
"state": "NSW",
"postcode": "2000",
"country": "AU"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entityType: 'Company',
entityTypeID: 2,
clientStatus: 'Lead',
entityCode: 'NEW-2048',
externalSystemID: 'EXT-9001',
entityName: 'Harbour View Pty Ltd',
email: 'contact@harbourview.example',
telephone: '+61 2 8000 3300',
physicalAddress: {
address1: 'Level 4, 55 Pitt Street',
city: 'Sydney',
state: 'NSW',
postcode: '2000',
country: 'AU'
}
})
};
fetch('https://anzapi.onboardme.app/api/v1/entities', 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://anzapi.onboardme.app/api/v1/entities",
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([
'entityType' => 'Company',
'entityTypeID' => 2,
'clientStatus' => 'Lead',
'entityCode' => 'NEW-2048',
'externalSystemID' => 'EXT-9001',
'entityName' => 'Harbour View Pty Ltd',
'email' => 'contact@harbourview.example',
'telephone' => '+61 2 8000 3300',
'physicalAddress' => [
'address1' => 'Level 4, 55 Pitt Street',
'city' => 'Sydney',
'state' => 'NSW',
'postcode' => '2000',
'country' => 'AU'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://anzapi.onboardme.app/api/v1/entities"
payload := strings.NewReader("{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://anzapi.onboardme.app/api/v1/entities")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Entities
Create a client entity
Creates a new client (entity) in the practice. Requires an API client with write access (canWrite from /api/v1/auth/validate).
Body fields (common)
entityTypeID: numeric id (see/api/v1/settings/entity-types). Ignored whenentityTypeis set.entityType: optional code or display name for the practice’s country (e.g.Company,CO,Trust) — resolved toentityTypeIDautomatically.clientStatus: typically"Lead"or"Active".entityName,entitySurname,entityInitials: naming depends on entity type.externalSystemID(optional): your system’s identifier for this client; stored on the entity and returned on list/load.email,telephone,mobile,taxNumber,regNumber,idNumber, etc.: optional identifiers.physicalAddress/postalAddress: optional nested address objects (address1…country).
Example
{
"entityType": "Company",
"clientStatus": "Lead",
"entityName": "Acme Holdings Pty Ltd",
"email": "accounts@partner.example",
"physicalAddress": {
"address1": "100 Queen St",
"city": "Melbourne",
"state": "VIC",
"postcode": "3000",
"country": "AU"
}
}
201: Location references the new entity; body includes entityKey.
403: API client is read-only.
429: Rate limit exceeded.
POST
/
api
/
v1
/
entities
Create a client entity
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/entities \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"entityType": "Company",
"entityTypeID": 2,
"clientStatus": "Lead",
"entityCode": "NEW-2048",
"externalSystemID": "EXT-9001",
"entityName": "Harbour View Pty Ltd",
"email": "contact@harbourview.example",
"telephone": "+61 2 8000 3300",
"physicalAddress": {
"address1": "Level 4, 55 Pitt Street",
"city": "Sydney",
"state": "NSW",
"postcode": "2000",
"country": "AU"
}
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/entities"
payload = {
"entityType": "Company",
"entityTypeID": 2,
"clientStatus": "Lead",
"entityCode": "NEW-2048",
"externalSystemID": "EXT-9001",
"entityName": "Harbour View Pty Ltd",
"email": "contact@harbourview.example",
"telephone": "+61 2 8000 3300",
"physicalAddress": {
"address1": "Level 4, 55 Pitt Street",
"city": "Sydney",
"state": "NSW",
"postcode": "2000",
"country": "AU"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entityType: 'Company',
entityTypeID: 2,
clientStatus: 'Lead',
entityCode: 'NEW-2048',
externalSystemID: 'EXT-9001',
entityName: 'Harbour View Pty Ltd',
email: 'contact@harbourview.example',
telephone: '+61 2 8000 3300',
physicalAddress: {
address1: 'Level 4, 55 Pitt Street',
city: 'Sydney',
state: 'NSW',
postcode: '2000',
country: 'AU'
}
})
};
fetch('https://anzapi.onboardme.app/api/v1/entities', 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://anzapi.onboardme.app/api/v1/entities",
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([
'entityType' => 'Company',
'entityTypeID' => 2,
'clientStatus' => 'Lead',
'entityCode' => 'NEW-2048',
'externalSystemID' => 'EXT-9001',
'entityName' => 'Harbour View Pty Ltd',
'email' => 'contact@harbourview.example',
'telephone' => '+61 2 8000 3300',
'physicalAddress' => [
'address1' => 'Level 4, 55 Pitt Street',
'city' => 'Sydney',
'state' => 'NSW',
'postcode' => '2000',
'country' => 'AU'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://anzapi.onboardme.app/api/v1/entities"
payload := strings.NewReader("{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://anzapi.onboardme.app/api/v1/entities")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"Company\",\n \"entityTypeID\": 2,\n \"clientStatus\": \"Lead\",\n \"entityCode\": \"NEW-2048\",\n \"externalSystemID\": \"EXT-9001\",\n \"entityName\": \"Harbour View Pty Ltd\",\n \"email\": \"contact@harbourview.example\",\n \"telephone\": \"+61 2 8000 3300\",\n \"physicalAddress\": {\n \"address1\": \"Level 4, 55 Pitt Street\",\n \"city\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country\": \"AU\"\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.
Body
application/jsontext/jsonapplication/*+json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created