Search
K
gap-au-aml-customer-experience-standard v1

EntityPartyRequest

object

Entity party for AML verification. Supports trusts, companies, partnerships, government bodies, and other organisation types.

partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

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

rolestringrequired

Party role. Allowed values: BUYER, SELLER

Match pattern:^(BUYER|SELLER)$

partySubTypestringrequired

Organisation subtype. Allowed values: TRUST, BODY_CORPORATE_COMPANY, PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY, OTHER

Match pattern:^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$

partySubTypeDescriptionstring

Required when partySubType is OTHER. Must not be provided otherwise.

Match pattern:^[a-zA-Z0-9 \-&/()]+$

>= 3 characters<= 100 characters

servicingModestringrequired

Servicing mode. Allowed values: SELF_SERVE, ASSISTED

Match pattern:^(SELF_SERVE|ASSISTED)$

entityNamestringrequired

>= 4 characters<= 100 characters

abnstring

Australian Business Number (ABN) or Australian Company Number (ACN)

tradingNamestring

Trading name or business name

>= 1 characters<= 100 characters

mainBusinessLocationstringrequired

State and postcode in format ‘STATE POSTCODE’ (e.g. VIC 3000, NSW 2000)

Match pattern:^[A-Z]{2,3} [0-9]{4}$

>= 6 characters<= 8 characters

Example:VIC 3000

primaryContactobject

Required when servicingMode is ASSISTED. Contact details for the primary person managing the entity verification.

Show Child Parameters
Example

Workspace

object
workspaceIdstring(uuid)
workspaceReferencestring
externalReferencestring

Integrator-supplied reference echoed from the request

workspaceUrlstring(uri)

URL to access the workspace in PEXA Clear

Example

ErrorResponse

object
errorsarray[object]
Show Child Parameters
Example

Error

object
codestring
messagestring
fieldstring
Example

Email

string

Email address

Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$

<= 320 characters