EntityPartyRequest

object

Entity party for AML verification (workspace creation). Supports trusts, companies, partnerships, government bodies, and other organisation types.

partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(ENTITY)$)

rolestringrequired

Party role. Allowed values: BUYER, SELLER

Match pattern:^(BUYER|SELLER)$

externalPartyIdstring

Optional integrator-supplied identifier for this party. May be any string value up to 50 characters (for example, an identifier from your own system) — it does not need to be a UUID. If provided, it is echoed back in the corresponding party in the response so you can correlate your party to the PEXA partyId. Must be unique across the parties in the request. If omitted, only the PEXA-assigned partyId is returned for that party. It is recommended to always supply this value so party correlation is unambiguous.

<= 50 characters

Example:cust123

partySubTypestringrequired

Organisation subtype. Allowed values: TRUST, BODY_CORPORATE_COMPANY, PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY, OTHER

Match pattern:^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$

partySubTypeDescriptionstring

Required when partySubType is OTHER. Must not be provided otherwise.

Match pattern:^[a-zA-Z0-9 \-&/()]+$

>= 3 characters<= 100 characters

servicingModestringrequired

Servicing mode. Allowed values: SELF_SERVE, ASSISTED

Match pattern:^(SELF_SERVE|ASSISTED)$

entityNamestringrequired

>= 4 characters<= 100 characters

abnstring

Australian Business Number (ABN) or Australian Company Number (ACN)

tradingNamestring

Trading name or business name

>= 1 characters<= 100 characters

mainBusinessLocationstringrequired

State and postcode in format ‘STATE POSTCODE’ (e.g. VIC 3000, NSW 2000)

Match pattern:^[A-Z]{2,3} [0-9]{4}$

>= 6 characters<= 8 characters

Example:VIC 3000

primaryContactobject

Required when servicingMode is ASSISTED. Contact details for the primary person managing the entity verification.

Show Child Parameters
Example

Workspace

object
workspaceIdstring(uuid)required
workspaceReferencestring
externalReferencestring

Integrator-supplied reference echoed from the request

workspaceUrlstring(uri)

URL to access the workspace in PEXA Clear

partiesarray[object]required

The parties created in the workspace during initiation. Each entry includes the PEXA-assigned partyId, the integrator-supplied externalPartyId (echoed back when provided, otherwise null), and the party details. Use partyId (or externalPartyId when supplied) to reference a party in subsequent calls.

Show Child Parameters
Example

PartyResponse

object
partyIdstring(uuid)required

PEXA-assigned party identifier

externalPartyIdstringrequired

The integrator-supplied identifier echoed from the request for this party. Null when no externalPartyId was supplied for the party.

<= 50 characters

Example:cust123

partyTypestringrequired

Party type echoed from the request

Allowed values:INDIVIDUALENTITY

rolestringrequired

Party role echoed from the request

Allowed values:BUYERSELLER

partyDetailsobjectrequired

The submitted party details echoed back (e.g. names, contact, entity information), so each returned party is self-describing and can be matched to the party you submitted.

* Additional properties are allowed.
Example

AddPartyRequest

object

Request to add parties (individual or entity) to an existing workspace. The parties field is an array to support adding multiple parties in a single request in future. Currently, exactly one party may be supplied per request — requests containing more than one party, or an empty array, are rejected with 400. Bulk addition (more than one party) is planned and will be enabled without any change to this contract.

partiesOne Of
arrayrequired

List of parties to add to the workspace. Structured as an array to support adding multiple parties in a single request in future. Currently, exactly one party may be supplied per request — requests containing more than one party, or an empty array, are rejected with 400. Bulk addition (more than one party) is planned and will be enabled without any change to this contract.

Variant 1object

An individual party to add. The presence of organisationPartyId is the sole discriminator between the two individual cases: when provided, the individual is linked to that entity and role is inherited; when omitted, the individual is standalone and role is required.

Show Child Parameters
Example

PartyToAdd

object

Base fields shared by the add-party party variants. Discriminated on partyType at the point of use: INDIVIDUAL adds a person (standalone or entity-linked); ENTITY adds an organisation.

partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY.

Match pattern:^(INDIVIDUAL|ENTITY)$

rolestring

Party role. Required for a standalone individual and for an entity. Ignored for an entity-linked individual, which inherits the entity’s role. Allowed values: BUYER, SELLER.

Match pattern:^(BUYER|SELLER)$

externalPartyIdstring

Optional integrator-supplied identifier for this party. May be any string value up to 50 characters (for example, an identifier from your own system). If provided, it is echoed back in the response so you can correlate your party to the PEXA partyId.

<= 50 characters

Example:cust123

Example