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

IndividualPartyToAdd

object

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.

partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY.

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

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

organisationPartyIdstring(uuid)

References an existing ENTITY party on the workspace to link this individual to; the linked individual inherits the entity’s role. Optional for a SELF individual (when omitted the individual is standalone and role is required). Required when partySubType is UBO — a UBO only exists under an entity. Applies only to individuals.

partySubTypestringrequired

Subtype of the individual party. Allowed values: SELF, UBO. Use SELF for a standard individual (standalone or entity-linked). Use UBO for an ultimate beneficial owner, which must be linked to an entity (organisationPartyId is required for UBO).

Match pattern:^(SELF|UBO)$

firstNamestring

>= 1 characters<= 50 characters

middleNamesstring

>= 1 characters<= 50 characters

familyNamestringrequired

>= 1 characters<= 50 characters

dateOfBirthstring(date)
countryCodestringrequired

Country calling code, e.g. “+61”

Match pattern:^\+[0-9]{1,4}$

>= 1 characters<= 5 characters

Example:+61

mobileNumberstringrequired

Must contain between 8 and 20 digits

Match pattern:^[\d\s\-\+\(\)]{8,25}$

>= 8 characters<= 20 characters

emailstring(email)required

Email address

Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$

<= 320 characters

Example

EntityPartyToAdd

object

An entity (organisation) party to add. Supports trusts, companies, partnerships, government bodies, and other organisation types. Shares the entity field set with workspace creation (EntityPartyBase); validation mirrors workspace creation.

partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY.

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(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

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

AddPartyResponse

object

Response for the add-party request. The workspaceId is returned once at the top level as it is common to all parties. The parties array mirrors the request order; it currently contains a single element, matching the one-party-per-request limit.

workspaceIdstring(uuid)required

Identifier of the workspace the parties were added to

partiesarray[object]required

Parties created by this request, in the same order as the request. Currently contains a single element, mirroring the one-party-per-request limit.

Show Child Parameters
Example

AddedParty

object
partyIdstring(uuid)

Identifier of the newly created party

partyTypestring

Party type of the added party. Allowed values: INDIVIDUAL, ENTITY.

Allowed values:INDIVIDUALENTITY

rolestring

Role of the added party. Allowed values: BUYER, SELLER.

Allowed values:BUYERSELLER

organisationPartyIdstring(uuid)

Present only for entity-linked individuals; the entity party this individual is linked to

externalPartyIdstring

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

<= 50 characters

partyDetailsobject

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

* Additional properties are allowed.
Example