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
IndividualPartyRequest
One OfParty type. Allowed values: INDIVIDUAL, ENTITY
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)
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
Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.
Match pattern:(?=^(SELF|SOLE_TRADER)$)(?=^(SELF)$)
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Country calling code, e.g. “+61”
Match pattern:^\+[0-9]{1,4}$
>= 1 characters<= 5 characters
Example:+61
Must contain between 8 and 20 digits
Match pattern:^[\d\s\-\+\(\)]{8,25}$
>= 8 characters<= 20 characters
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
IndividualPartyBase
objectParty type. Allowed values: INDIVIDUAL, ENTITY
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)
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
Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.
Match pattern:^(SELF|SOLE_TRADER)$
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Country calling code, e.g. “+61”
Match pattern:^\+[0-9]{1,4}$
>= 1 characters<= 5 characters
Example:+61
Must contain between 8 and 20 digits
Match pattern:^[\d\s\-\+\(\)]{8,25}$
>= 8 characters<= 20 characters
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
IndividualSelfRequest
objectParty type. Allowed values: INDIVIDUAL, ENTITY
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)
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
Subtype of the individual party. Use “SELF” for a standard individual or “SOLE_TRADER” for a sole trader.
Match pattern:(?=^(SELF|SOLE_TRADER)$)(?=^(SELF)$)
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Country calling code, e.g. “+61”
Match pattern:^\+[0-9]{1,4}$
>= 1 characters<= 5 characters
Example:+61
Must contain between 8 and 20 digits
Match pattern:^[\d\s\-\+\(\)]{8,25}$
>= 8 characters<= 20 characters
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
IndividualSoleTraderRequest
objectParty type. Allowed values: INDIVIDUAL, ENTITY
Match pattern:(?=^(INDIVIDUAL|ENTITY)$)(?=^(INDIVIDUAL)$)
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
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)$)
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
>= 1 characters<= 50 characters
Country calling code, e.g. “+61”
Match pattern:^\+[0-9]{1,4}$
>= 1 characters<= 5 characters
Example:+61
Must contain between 8 and 20 digits
Match pattern:^[\d\s\-\+\(\)]{8,25}$
>= 8 characters<= 20 characters
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
Australian Business Number (ABN) or Australian Company Number (ACN). Required when partySubType is SOLE_TRADER.
Trading entity name. Required when partySubType is SOLE_TRADER.
>= 1 characters<= 100 characters
Trading name or business name.
>= 1 characters<= 100 characters
State and postcode. Required when partySubType is SOLE_TRADER.
>= 1 characters<= 20 characters
Example:SA 5045