Create Customer

post

http://localhost:8080/v0/customers/create

Body Params

address

object

required

Customer's address

customData

object

Custom data associated with customer

customerDetails

object

required

Personal details of a customer

customerTier

string

enum

required

Customer tier, will be STANDARD unless additional tiers have been agreed as part of the product offering. Possible values:

FOUNDER
STANDARD
PREMIUM

Allowed:

string

required

length ≥ 1

Email address of the Customer

externalCustomerId

string

length between 0 and 64

Only applicable to Clients using their own Auth solution. This value will be included in the subject on the token which in turn will be used by Shaype to represent the customer Id on the external system. Max length is 64 characters.

idempotencyKey

uuid

required

Unique value (UUID) used to identify this request and used to recognise any subsequent retries

identityDocumentCardNumber

string

Identity document card number. Between 6 to 10 characters which can be either just numeric or alphanumeric characters based on the state. Should be specified for Driver's Licenses that provide it.

identityDocumentIssuingCountry

string

Optional three-letter ISO country code of the customer's identity document issuing country.

identityDocumentNumber

string

Number of the Customer's identity document (if supplied)

identityDocumentRegion

string

Identity document region, one of: NSW, QLD, SA, TAS, VIC, WA, ACT, NT. (uppercase only) Should be specified for Driver's Licenses.

identityDocumentType

string

enum

Type of Customer's identity document (if supplied). Possible values:

DRIVING_LICENSE
PASSPORT

Allowed:

identityVerificationCaseId

uuid

Optional Identity Verification ID for the identity check

journeyId

uuid

deprecated

Deprecated: Please do not use this field for customer creation, please refer to identityVerificationCaseId

onlySanctionsCheck

boolean

Applicable only to clients using our Sanctions-Check-Only KYC functionality. Used to only perform sanctions check on the Customer as part of KYC checks. This flag cannot be used at the same time as skipKyc.

phoneNumber

object

required

Phone number of the Customer

skipKyc

boolean

Only applicable to Clients using Shaype KYC solution. Used to bypass KYC checks for the Customer. Must only set as 'true' in agreed scenarios (i.e. permission to generate a dummy / test account has been granted). This flag cannot be used at the same time as onlySanctionsCheck.

taxObligations

array of objects

Captures any foreign (outside Australia) tax obligations for the Customer

taxObligations

Responses

200Success

400Bad Request

403Forbidden

422Unprocessable Entity

500Internal Server Error

501Not Implemented