Workspace

object
workspaceIdstring(uuid)required
workspaceReferencestring
externalReferencestring

Integrator-supplied reference echoed from the request

workspaceUrlstring(uri)

URL to access the workspace in PEXA Clear

partiesarray[object]required

The parties created in the workspace during initiation. Each entry includes the PEXA-assigned partyId, the integrator-supplied externalPartyId (echoed back when provided, otherwise null), and the party details. Use partyId (or externalPartyId when supplied) to reference a party in subsequent calls.

Show Child Parameters
Example

PartyResponse

object
partyIdstring(uuid)required

PEXA-assigned party identifier

externalPartyIdstringrequired

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

<= 50 characters

Example:cust123

partyTypestringrequired

Party type echoed from the request

Allowed values:INDIVIDUALENTITY

rolestringrequired

Party role echoed from the request

Allowed values:BUYERSELLER

partyDetailsobjectrequired

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.

* Additional properties are allowed.
Example

AddPartyRequest

object

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
Example

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