Creating a sub-customer

Create subcustomer

post
/v1/subcustomers
Authorizations
ww-api-keystringRequired
Body
firstNamestringOptional

First name of the subcustomer. Required if type is individual

lastNamestringOptional

Last name of the subcustomer. Required if type is individual

businessNamestringOptional

Business name of the subcustomer. Required if type is business

emailstringRequired

Email address of the subcustomer

countrystringRequired

Country of the subcustomer

typestring · enumRequiredPossible values:
businessTypestring · enumOptionalPossible values:
referenceIdstringOptional

The unique referenceId on your system representing the subcustomer

Responses
chevron-right
200

200 response

application/json
idstringRequired

Unique identifier for the subcustomer

namestringRequired

Name of the subcustomer

emailstringRequired

Email address of the subcustomer

countrystringOptional

ISO 3166-1 alpha-3 country code

statusstring · enumRequiredPossible values:
typestring · enumRequiredPossible values:
onboardingStatusstring · enumRequiredPossible values:
businessIdstringRequired

Identifier of the business to which the subcustomer belongs

referenceIdstringOptional

The unique referenceId on your system representing the subcustomer

addressLine1stringOptional

Address line 1 of the subcustomer

addressLine2stringOptional

Address line 2 of the subcustomer

postalCodestringOptional

Postal code of the subcustomer

citystringOptional

City of the subcustomer

statestringOptional

State of the subcustomer

createdAtstring · date-timeRequired

Date and time when the subcustomer was created

updatedAtstring · date-timeRequired

Date and time when the subcustomer was last updated

post
/v1/subcustomers

Last updated