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

CreateWorkspaceRequest

object
transactionTypestringrequired

Transaction type. Allowed values: AML

Match pattern:^(AML)$

externalReferencestring

Optional integrator-supplied reference for this workspace

<= 50 characters

Example:123e4567-e89b-12d3-a456-426614174000

settlementDatestring(date)
propertyobject
Show Child Parameters
partiesOne Of
arrayrequired

List of parties to be verified. Minimum 1 and maximum 30 parties per request.

>= 1 items<= 30 items

Variant 1One Of
Variant 1object
Show Child Parameters
Example

Property

object
addressobject
Show Child Parameters
Example

Address

object
unitNumberstring

<= 20 characters

streetNumberstringrequired

>= 1 characters<= 20 characters

streetNamestringrequired

>= 1 characters<= 100 characters

streetTypestringrequired

e.g. Street, Road, Avenue, Drive, Court

>= 1 characters<= 50 characters

suburbstringrequired

>= 1 characters<= 50 characters

statestringrequired

Australian state or territory code

Match pattern:^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$

>= 2 characters<= 3 characters

postcodestringrequired

4-digit Australian postcode

Match pattern:^[0-9]{4}$

>= 4 characters<= 4 characters

Example

PartyRequest

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:^(INDIVIDUAL|ENTITY)$

rolestringrequired

Party role. Allowed values: BUYER, SELLER

Match pattern:^(BUYER|SELLER)$

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

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