Add Parties to an Existing Workspace
Add one or more parties to an existing workspace. A party may be an individual or an entity (organisation). The request and response are array-shaped to accommodate future bulk party addition without a contract change. At present a single party per request is supported; supplying more than one party, or none, returns 400. An individual may be standalone (organisationPartyId omitted; role required) or linked to an existing entity party on the workspace (organisationPartyId provided; role inherited from the entity). An entity is added with its own role. Added parties undergo the same IDV/compliance verification flow as parties supplied at workspace creation.
Path Parameters
Identifier of the workspace to add the party to
Body
application/json
Body
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.
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
Response
application/json
Response
Party added successfully
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.
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
Authentication
Path Parameters
Body
CreateWorkspaceRequest
objectTransaction type. Allowed values: AML
Match pattern:^(AML)$
Optional integrator-supplied reference for this workspace
<= 50 characters
Example:123e4567-e89b-12d3-a456-426614174000
Show Child Parameters
One OfList of parties to be verified. Minimum 1 and maximum 4 parties per request.
>= 1 items<= 4 items
One OfShow Child Parameters
Property
objectShow Child Parameters
Address
object<= 20 characters
>= 1 characters<= 20 characters
>= 1 characters<= 100 characters
e.g. Street, Road, Avenue, Drive, Court
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Australian state or territory code
Match pattern:^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$
>= 2 characters<= 3 characters
4-digit Australian postcode
Match pattern:^[0-9]{4}$
>= 4 characters<= 4 characters
PartyRequest
objectParty type. Allowed values: INDIVIDUAL, ENTITY
Match pattern:^(INDIVIDUAL|ENTITY)$
Party 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) — 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