List client entities

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/entities/list \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/entities/list', 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/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://anzapi.onboardme.app/api/v1/entities/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/entities/list")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

[
  {
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "externalSystemID": "CRM-88421",
    "entityCode": "RS-10492",
    "fullEntityName": "Riverstone Holdings Ltd",
    "entitySalutation": "Riverstone",
    "entityInitials": "RH",
    "entityBirthDate": "1990-05-15",
    "entityEmail": "accounts@riverstone.example",
    "entityTelephone": "+61 3 9000 1200",
    "entityMobile": "+61 400 555 220",
    "entitySalesTaxNumber": "12 345 678 901",
    "entityRegNumber": "ACN 123 456 789",
    "entityTerminated": false,
    "entityType": "Company",
    "officeName": "Melbourne",
    "isTaxEntity": true,
    "updatedOn": "2025-04-10T04:05:00Z"
  }
]

{
  "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>"
}

GET

api

entities

list

List client entities

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/entities/list \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/entities/list', 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/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://anzapi.onboardme.app/api/v1/entities/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/entities/list")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

[
  {
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "externalSystemID": "CRM-88421",
    "entityCode": "RS-10492",
    "fullEntityName": "Riverstone Holdings Ltd",
    "entitySalutation": "Riverstone",
    "entityInitials": "RH",
    "entityBirthDate": "1990-05-15",
    "entityEmail": "accounts@riverstone.example",
    "entityTelephone": "+61 3 9000 1200",
    "entityMobile": "+61 400 555 220",
    "entitySalesTaxNumber": "12 345 678 901",
    "entityRegNumber": "ACN 123 456 789",
    "entityTerminated": false,
    "entityType": "Company",
    "officeName": "Melbourne",
    "isTaxEntity": true,
    "updatedOn": "2025-04-10T04:05:00Z"
  }
]

{
  "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

Authorization

string

header

required

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.

Query Parameters

lastUpdated

string<date-time>

Only entities changed on or after this UTC time (incremental sync).

pageNumber

integer<int32>

1-based page index (1–10000).

name

string

Substring match on entity first/given name (afEntityName).

otherName

string

Substring match on other/trading name (afOtherName).

surname

string

Substring match on surname (afEntitySurname).

string

Substring match on email (afEntityEmail).

Response

entityKey

string<uuid> | null

externalSystemID

string | null

entityCode

string | null

fullEntityName

string | null

entitySalutation

string | null

Friendly or preferred name for the client (not an honorific title such as Mr or Ms).

entityInitials

string | null

entityBirthDate

string<date> | null

entityIncorporationDate

string<date> | null

entityBirthPlace

string | null

entityEmail

string | null

entityTelephone

string | null

entityMobile

string | null

entitySalesTaxNumber

string | null

entityRegNumber

string | null

entityIDNumber

string | null

entityTerminated

boolean

entityType

string | null

officeName

string | null

groupName

string | null

isTaxEntity

boolean

isAMLEntity

boolean

isSecEntity

boolean

partnerName

string | null

managerName

string | null

inChargeName

string | null

updatedOn

string<date-time> | null

API documentation

Endpoints

Building blocks

List client entities

Authorizations

Query Parameters

Response