Skip to main content

ClientCreateBase

countryCodestringrequired

ISO 3166-1 alpha-2 country code

Example: AU
address objectrequired
streetstring

Business official street address. Allowed characters: letters, digits, spaces and , . - / # ( ) : '

Possible values: >= 4 characters and <= 256 characters, Value must match regular expression ^[A-Za-z0-9\s,.\-/#():']+$

Example: 19 Victoria Ave
citystring

City name of business official address. Allowed characters: letters, spaces and - . '

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z\s\-.']+$

Example: Sydney
statestring

State name of business official address. Allowed characters: letters, spaces and -

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z\s\-]+$

Example: New South Wales
zipstring

Zip code of business official address. Allowed characters: letters, digits, hyphens and spaces

Possible values: <= 32 characters, Value must match regular expression ^[A-Za-z0-9\- ]+$

Example: 2000
contactEmailstring

Personal contact email

Example: john@example.com
referenceIdstring<^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,35}$>

The unique reference id of this entity creation. Optional, but highly recommended to use. When given, it fails the creation if a duplicate entity is found. Only alphanumeric characters, underscores and hyphens are allowed, and cannot start with a hyphen.

Possible values: <= 36 characters

Example: 1234567890
notestring

Note

Example: Manual onboard
transactionContinuationstring

Indicates whether the client’s expected transactions are one-off or ongoing/recurring (used for onboarding/KYC expected transaction profile).

Possible values: [ONEOFF, ONGOING]

Example: ONEOFF
expectedAnnualTransactionAmountnumber

Expected annual transaction amount (applicable when transactionContinuation is ONGOING).

Example: 100000
expectedAnnualTransactionCountnumber

Expected annual transaction count (applicable when transactionContinuation is ONGOING).

Example: 10
ClientCreateBase
{
  "countryCode": "AU",
  "address": {
    "street": "19 Victoria Ave",
    "city": "Sydney",
    "state": "New South Wales",
    "zip": "2000"
  },
  "contactEmail": "john@example.com",
  "referenceId": "1234567890",
  "note": "Manual onboard",
  "transactionContinuation": "ONEOFF",
  "expectedAnnualTransactionAmount": 100000,
  "expectedAnnualTransactionCount": 10
}