Skip to content

Create Member

POST
/bff/vouch/customer/member

Create a member (proxy to customer-api, requires member:create).

object
id
string format: uuid
firstName
required
string
lastName
required
string
email
required
string format: email
mobileNumber
required
string
dateOfBirth
string
phoneNumber
string
nullable
dob
string
nullable
licenseNumber
string
nullable
rcmCustomerId
string
nullable
authCustomerId
string
nullable
crmId
string
nullable
commsChannelId
string
nullable
kccid
string
nullable
address
object
id
string format: uuid
addressFull
string
addressLineOne
required
string
addressLineTwo
string
suburb
required
string
state
required
string
postcode
required
string
country
required
string
license
object
id
string format: uuid
number
required
string
state
string
nullable
country
string
expiryDate
string
products
Array<object>
object
productTypeId
required
integer
status
required
string
Allowed values: Enquired Approved

Member created

object
id
required
string format: uuid
tenantId
required
string
firstName
required
string
nullable
lastName
required
string
nullable
email
required
string
mobileNumber
required
string
dateOfBirth
required
string
nullable
address
required
object
id
required
string format: uuid
addressFull
required
string
nullable
addressLineOne
required
string
nullable
addressLineTwo
required
string
nullable
suburb
required
string
nullable
state
required
string
nullable
postcode
required
string
nullable
country
required
string
nullable
license
required
object
id
required
string format: uuid
number
required
string
nullable
state
required
string
nullable
country
required
string
nullable
expiryDate
required
string
nullable
active
required
boolean
company
required
object
id
required
string format: uuid
name
required
string
abn
required
string
address
required
object
id
required
string format: uuid
addressFull
required
string
nullable
addressLineOne
required
string
nullable
addressLineTwo
required
string
nullable
suburb
required
string
nullable
state
required
string
nullable
postcode
required
string
nullable
country
required
string
nullable
products
required
Array<object>
object
id
required
string format: uuid
productTypeId
required
integer
status
required
string
archived
required
boolean
archivedDate
required
string
nullable
createdDate
required
string
nullable
lastModifiedDate
required
string
nullable
createdDate
required
string
nullable
lastModifiedDate
required
string
nullable

BAD_REQUEST

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

UNAUTHORIZED

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

FORBIDDEN

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

NOT_FOUND

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

CONFLICT

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

UNPROCESSABLE_ENTITY

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

INTERNAL_SERVER_ERROR

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email