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

IndividualPartyRequest

One Of
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)

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

partySubTypestringrequired

Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.

Match pattern:(?=^(SELF|SOLE_TRADER)$)(?=^(SELF)$)

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

IndividualPartyBase

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)

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

partySubTypestringrequired

Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.

Match pattern:^(SELF|SOLE_TRADER)$

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

IndividualSelfRequest

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)

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

partySubTypestringrequired

Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.

Match pattern:(?=^(SELF|SOLE_TRADER)$)(?=^(SELF)$)

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

IndividualSoleTraderRequest

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)

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

partySubTypestringrequired

Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.

Match pattern:(?=^(SELF|SOLE_TRADER)$)(?=^(SOLE_TRADER)$)

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

abnstring

Australian Business Number (ABN) or Australian Company Number (ACN). Required when partySubType is SOLE_TRADER.

entityNamestringrequired

Trading entity name. Required when partySubType is SOLE_TRADER.

>= 1 characters<= 100 characters

tradingNamestring

Trading name or business name.

>= 1 characters<= 100 characters

mainBusinessLocationstringrequired

State and postcode. Required when partySubType is SOLE_TRADER.

>= 1 characters<= 20 characters

Example:SA 5045

Example