PersonalClientEdit

countryCodestring

ISO 3166-1 alpha-2 country code

Example: AU

address object

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

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

phonestring<E.164>

Phone number

Example: +612...

nationalitystring

Client nationality, ISO 3166-1 alpha-2 country code

Example: AU

occupationstringnullable

Client occupation. Allowed characters: letters, digits, spaces and / & - . , ' +

Possible values: <= 128 characters, Value must match regular expression ^[a-zA-Z0-9/&.,'\- +]+$

Example: Software Engineer

identificationTypePersonalClientIdentificationTypesnullable

Client identification type (required for PM role). Note: identificationType, identificationNumber and identificationIssueCountry must all be provided together to be saved

Possible values: [Drivers License, Social Security Number, Passport, Social Insurance Number, National Id]

Example: Passport

identificationNumberstringnullable

Client identification number (required for PM role). Note: identificationType, identificationNumber and identificationIssueCountry must all be provided together to be saved

Example: P12345678

identificationExpiryDatestringnullable

Client identification expiry date

Example: 2030-12-31

identificationIssueCountrystringnullable

Client identification issue country, ISO 3166-1 alpha-2 country code (required for PM role). Note: identificationType, identificationNumber and identificationIssueCountry must all be provided together to be saved

Possible values: <= 2 characters

Example: AU

PersonalClientEdit

{
  "countryCode": "AU",
  "address": {
    "street": "19 Victoria Ave",
    "city": "Sydney",
    "state": "New South Wales",
    "zip": "2000"
  },
  "contactEmail": "john@example.com",
  "note": "Manual onboard",
  "transactionContinuation": "ONEOFF",
  "expectedAnnualTransactionAmount": 100000,
  "expectedAnnualTransactionCount": 10,
  "phone": "+612...",
  "nationality": "AU",
  "occupation": "Software Engineer",
  "identificationType": "Passport",
  "identificationNumber": "P12345678",
  "identificationExpiryDate": "2030-12-31",
  "identificationIssueCountry": "AU"
}