Skip to main content
GET
List entities
List the entity customers (companies, trusts, partnerships, SMSFs) in your organisation. Works exactly like GET /customers — cursor pagination, updated_since polling, opt-in total_count — with two differences:
  • status filters on the entity’s KYB status (kyb_status), since entities verify via KYB rather than KYC.
  • type filters by entity type (COMPANY, TRUST, PARTNERSHIP, SMSF, OTHER).
See Pagination and Polling for status changes.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers in your Instant Compliance organisation. Format: ic_live_….

Query Parameters

limit
integer
default:50

Number of records to return (1–100).

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from the previous response's next_cursor.

status
enum<string>

Filter by KYB status (entities verify via KYB).

Available options:
NOT_STARTED,
PENDING,
IN_PROGRESS,
VERIFIED,
FAILED,
NOT_REQUIRED,
AWAITING_RESUBMISSION
aml_status
enum<string>

Filter by AML compliance status.

Available options:
NOT_SCREENED,
IN_PROGRESS,
CLEAR,
NEEDS_REVIEW,
RESOLVED
type
enum<string>

Filter by entity type. Entity customer types accepted by /entities. SMSF is treated as a type of trust and OTHER as a company for verification purposes, but the type you post round-trips back unchanged. Immutable after creation.

Available options:
COMPANY,
TRUST,
PARTNERSHIP,
SMSF,
OTHER
updated_since
string<date-time>

ISO-8601 timestamp. Return only entities updated after this time.

external_id
string

Lookup by your CRM identifier.

include
enum<string>

Comma-separated list of opt-in response fields. Currently the only supported value is total_count, which adds an exact count of the filtered set to the response envelope. Costs an extra COUNT(*) query — omit it on hot polling loops.

Available options:
total_count

Response

Paginated entity list.

object
enum<string>
required

Always "list" for paginated envelopes.

Available options:
list
data
object[]
required
has_more
boolean
required

True if at least one more page exists. Use as the loop condition.

next_cursor
string | null
required

Pass as cursor on the next request, or null when no more pages.

limit
integer
required

The limit echoed back after defaulting/clamping (1–100, default 50).

total_count
integer

Total records matching the filter set (not the page). Only present when the request included include=total_count.