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.
Show Child Parameters
AddPartyResponse
objectResponse 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.
Identifier of the workspace the parties were added to
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
AddedParty
objectIdentifier of the newly created party
Party type of the added party. Allowed values: INDIVIDUAL, ENTITY.
Allowed values:INDIVIDUALENTITY
Role of the added party. Allowed values: BUYER, SELLER.
Allowed values:BUYERSELLER
Present only for entity-linked individuals; the entity party this individual is linked to
The integrator-supplied identifier echoed from the request for this party. Null when no externalPartyId was supplied.
<= 50 characters
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.