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.

post
https://api.pexaclear.com.au/api/experience/v1/workspaces/{workspaceId}/parties

Path Parameters

workspaceIdstring(uuid)required

Identifier of the workspace to add the party to

Body

application/json

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

Response

application/json

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.

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
post/api/experience/v1/workspaces/{workspaceId}/parties

Body

{ "parties": [ { "partyType": "INDIVIDUAL", "partySubType": "SELF", "role": "BUYER", "familyName": "Smith", "firstName": "Jane", "dateOfBirth": "1990-05-20", "countryCode": "+61", "mobileNumber": 412345678, "email": "jane.smith@example.com" } ] }
 
application/json

CreateWorkspaceRequest

object
transactionTypestringrequired

Transaction type. Allowed values: AML

Match pattern:^(AML)$

externalReferencestring

Optional integrator-supplied reference for this workspace

<= 50 characters

Example:123e4567-e89b-12d3-a456-426614174000

settlementDatestring(date)
propertyobject
Show Child Parameters
partiesOne Of
arrayrequired

List of parties to be verified. Minimum 1 and maximum 4 parties per request.

>= 1 items<= 4 items

Variant 1One Of
Variant 1object
Show Child Parameters
Example

Property

object
addressobject
Show Child Parameters
Example

Address

object
unitNumberstring

<= 20 characters

streetNumberstringrequired

>= 1 characters<= 20 characters

streetNamestringrequired

>= 1 characters<= 100 characters

streetTypestringrequired

e.g. Street, Road, Avenue, Drive, Court

>= 1 characters<= 50 characters

suburbstringrequired

>= 1 characters<= 50 characters

statestringrequired

Australian state or territory code

Match pattern:^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$

>= 2 characters<= 3 characters

postcodestringrequired

4-digit Australian postcode

Match pattern:^[0-9]{4}$

>= 4 characters<= 4 characters

Example

PartyRequest

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:^(INDIVIDUAL|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

Example