Platform entity attr

ABR registration details for a contractor ABN.

Part of Platform in the register catalog.

Register ID

platform_entity_attrUse this name to ask for the register. The API calls it a shelf ID.

Each record is

A stateThe current value of something, replaced when it changes.

Status

AvailableFilled today from connected systems, uploads or public data.

Data

PublicShared, from public sources such as procurement portals.

Version

v1Current version.

Download JSON Schema

Connectors

Connected today

Demiton keeps this register current from these systems now.

• Australian Business Register

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

None planned yet.

Fields

14 fields: 8 required, 6 optional.

Required

Every record carries these fields.

abnText

The 11-digit Australian Business Number; the shelf's subject and its SERIES identity.

entity_nameText

The registered entity name as published by the register.

entity_typeText

The register's entity-type name (company / trust / partnership / sole trader, as published).

statusText

Registration status at observation time (e.g. active / cancelled).

gst_registeredTrue or false

Whether the entity is GST-registered (may be false; the field must be present).

observed_atDate and timeISO 8601, with time zone

When this registration snapshot was observed; drives freshness ordering.

source_datasetText

Producer identity (abr).

source_idText

abr:{abn} — the idempotency key.

Optional

Present when the source system records them.

gst_registered_fromDateYYYY-MM-DD

Effective date of GST registration, when registered.

acnText

The 9-digit Australian Company Number, when the entity is a company.

address.stateTextUnit: AU state/territory code

Registered address state.

address.postcodeText

Registered address postcode.

trading_namesList

Trading names the register publishes for the ABN.

jurisdiction_codeTextUnit: ISO 3166-1 alpha-2

Jurisdiction the registration belongs to; today always Australia and NULL on every write.

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

Schema URL

https://docs.demiton.io/registers/platform_entity_attr/v1.json

Show the full JSON Schema

Loading the schema…