Skip to main content
GET
Get an entity
Fetch a single entity customer by Instant Compliance’s UUID or by your own external_id — the format is detected automatically. The response includes the entity’s kyb_status, its AML screening block, and a summary of its current contact person (including whether the contact’s own KYC is intended to run with the entity’s KYB). Beneficial-owner / UBO detail is not exposed through the API — that resolution happens in-app during KYB.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Entity identifier. Accepts either Instant Compliance's UUID (550e8400-…) or your own external_id.

Response

Entity record.

id
string<uuid>
required

Instant Compliance customer UUID (entities are customers too).

type
enum<string>
required

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
name
string
required

The entity's legal name.

origin
enum<string>
required

Where the entity is formed. AUSTRALIAN (the default) uses ABN/ACN identifiers; INTERNATIONAL uses countryOfFormation + registrationNumber. Immutable after creation.

Available options:
AUSTRALIAN,
INTERNATIONAL
kyb_status
enum<string>
required
Available options:
NOT_STARTED,
PENDING,
IN_PROGRESS,
VERIFIED,
FAILED,
NOT_REQUIRED,
AWAITING_RESUBMISSION
aml
object
required
added_via
enum<string>
required

How the record entered Instant Compliance.

Available options:
ADMIN_MANUAL,
AI_EXTRACTED,
CONTACT_PORTAL,
BULK_IMPORT,
INTEGRATION,
SYSTEM
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_id
string | null
abn
string | null
acn
string | null
country_of_formation
string | null

ISO 3166-1 alpha-3. AUS for Australian entities; the country of formation for international entities.

registration_number
string | null

Registry number recorded for international entities.

kyb_started_at
string<date-time> | null
kyb_completed_at
string<date-time> | null
contact
object | null

The entity's current contact person, or null when none is set.