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

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)$

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

abnstringrequired

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

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