Get entity by key

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

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

fetch('https://anzapi.onboardme.app/api/v1/entities/{key}', 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/{key}",
  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/{key}"

	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/{key}")

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

{
  "practiceKey": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "externalSystemID": "CRM-88421",
  "entityCode": "RS-10492",
  "entityName": "Riverstone Holdings Ltd",
  "fullName": "Riverstone Holdings Ltd",
  "entitySalutation": "Riverstone",
  "birthDate": "1990-05-15",
  "email": "accounts@riverstone.example",
  "telephone": "+61 3 9000 1200",
  "entityTypeName": "Company",
  "clientStatusName": "Active",
  "taxNotRequired": false,
  "entityTerminated": false,
  "isTaxEntity": true,
  "updatedOn": "2025-04-10T04:05:00Z",
  "verification": {
    "requestedMethod": "ComplyCube",
    "isVerified": true,
    "verifiedDate": "2025-04-09T12:00:00Z",
    "verificationMethod": "ComplyCube",
    "verificationStatus": "complete",
    "documentCheckId": "chk_doc_abc123",
    "identityCheckId": "chk_id_xyz789",
    "amlCheckId": "chk_aml_def456"
  },
  "customFields": [
    {
      "customFieldId": 42,
      "name": "Industry sector",
      "type": "Drop-Down",
      "value": "Professional services",
      "displayValue": "Professional services",
      "updatedOn": "2025-04-10T04:05:00Z"
    },
    {
      "customFieldId": 7,
      "name": "Partner responsible",
      "type": "User List",
      "value": "123",
      "displayValue": "Jane Smith",
      "updatedOn": "2025-03-01T10:00: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>"
}

Entities

Get entity by key

Returns full detail for one client entity, including contact fields, addresses where configured, custom field values, and identity verification summary when present.

customFields — populated custom field values for the client (active field definitions only). Each item includes customFieldId, name, type, stored value, and displayValue (human-readable; e.g. checkbox Yes/No, user list names, dates as yyyy-MM-dd).

verification — requested verification method (from linked onboarding client when applicable), verification outcome, status, integration check IDs, and document reference fields.

404: Unknown key or entity not in your practice.

429: Rate limit exceeded.

GET

api

entities

{key}

Get entity by key

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

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

fetch('https://anzapi.onboardme.app/api/v1/entities/{key}', 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/{key}",
  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/{key}"

	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/{key}")

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

{
  "practiceKey": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "externalSystemID": "CRM-88421",
  "entityCode": "RS-10492",
  "entityName": "Riverstone Holdings Ltd",
  "fullName": "Riverstone Holdings Ltd",
  "entitySalutation": "Riverstone",
  "birthDate": "1990-05-15",
  "email": "accounts@riverstone.example",
  "telephone": "+61 3 9000 1200",
  "entityTypeName": "Company",
  "clientStatusName": "Active",
  "taxNotRequired": false,
  "entityTerminated": false,
  "isTaxEntity": true,
  "updatedOn": "2025-04-10T04:05:00Z",
  "verification": {
    "requestedMethod": "ComplyCube",
    "isVerified": true,
    "verifiedDate": "2025-04-09T12:00:00Z",
    "verificationMethod": "ComplyCube",
    "verificationStatus": "complete",
    "documentCheckId": "chk_doc_abc123",
    "identityCheckId": "chk_id_xyz789",
    "amlCheckId": "chk_aml_def456"
  },
  "customFields": [
    {
      "customFieldId": 42,
      "name": "Industry sector",
      "type": "Drop-Down",
      "value": "Professional services",
      "displayValue": "Professional services",
      "updatedOn": "2025-04-10T04:05:00Z"
    },
    {
      "customFieldId": 7,
      "name": "Partner responsible",
      "type": "User List",
      "value": "123",
      "displayValue": "Jane Smith",
      "updatedOn": "2025-03-01T10:00: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.

Path Parameters

key

string<uuid>

required

Client entity key (identifier).

Response

Entity detail including custom fields when set

practiceKey

string | null

entityKey

string<uuid> | null

externalSystemID

string | null

entityCode

string | null

entityName

string | null

otherName

string | null

entitySurname

string | null

fullName

string | null

entitySalutation

string | null

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

entityInitials

string | null

birthDate

string<date> | null

incorporationDate

string<date> | null

birthPlace

string | null

gender

string | null

telephone

string | null

mobile

string | null

regNumber

string | null

salesTaxNumber

string | null

taxNotRequired

boolean

entityTerminated

boolean

terminatedDate

string<date-time> | null

isTaxEntity

boolean

isAMLEntity

boolean

isSecEntity

boolean

note

string | null

createdOn

string<date-time> | null

updatedOn

string<date-time> | null

entityTypeName

string | null

clientStatusName

string | null

partnerName

string | null

partnerKey

string | null

managerName

string | null

managerKey

string | null

inChargeName

string | null

inChargeKey

string | null

officeName

string | null

groupName

string | null

addresses

object[] | null

Show child attributes

customFields

object[]

Custom field values set on this client (active definitions only). Empty array when none are set.

Show child attributes

verification

object

Show child attributes

API documentation

Endpoints

Building blocks

Get entity by key

Authorizations

Path Parameters

Response