PartyResponse
objectPEXA-assigned party identifier
The integrator-supplied identifier echoed from the request for this party. Null when no externalPartyId was supplied for the party.
<= 50 characters
Example:cust123
Party type echoed from the request
Allowed values:INDIVIDUALENTITY
Party role echoed from the request
Allowed values:BUYERSELLER
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.
AddPartyRequest
objectRequest 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.
One OfList 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.
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
PartyToAdd
objectBase 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.
Party type. Allowed values: INDIVIDUAL, ENTITY.
Match pattern:^(INDIVIDUAL|ENTITY)$
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)$
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
IndividualPartyToAdd
objectAn 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.
Party type. Allowed values: INDIVIDUAL, ENTITY.
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)
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)$
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
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.
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)$
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Country calling code, e.g. “+61”
Match pattern:^\+[0-9]{1,4}$
>= 1 characters<= 5 characters
Example:+61
Must contain between 8 and 20 digits
Match pattern:^[\d\s\-\+\(\)]{8,25}$
>= 8 characters<= 20 characters
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
EntityPartyToAdd
objectAn 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.
Party type. Allowed values: INDIVIDUAL, ENTITY.
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(ENTITY)$)
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)$
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
Organisation subtype. Allowed values: TRUST, BODY_CORPORATE_COMPANY, PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY, OTHER
Match pattern:^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$
Required when partySubType is OTHER. Must not be provided otherwise.
Match pattern:^[a-zA-Z0-9 \-&/()]+$
>= 3 characters<= 100 characters
Servicing mode. Allowed values: SELF_SERVE, ASSISTED
Match pattern:^(SELF_SERVE|ASSISTED)$
>= 4 characters<= 100 characters
Australian Business Number (ABN) or Australian Company Number (ACN)
Trading name or business name
>= 1 characters<= 100 characters
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
Required when servicingMode is ASSISTED. Contact details for the primary person managing the entity verification.