Skip to content

Get Customer By Id (legacy snake_case compat)

GET
/bff/vouch/customer/by-id/{customerId}

Drop-in replacement for vouch-frontend’s legacy trpc.customer.getCustomerById. Fetches the member from customer-api (requires member:read) and returns the legacy snake_case shape. Licence number is masked unless the caller holds customer_licence:write:all.

customerId
required
string format: uuid

Customer in legacy snake_case shape

object
id
required
string format: uuid
first_name
required
string
nullable
last_name
required
string
nullable
email
required
string
date_of_birth
required
string
nullable
dob
required
string format: date-time
nullable
mobile_number
required
string
source_code
required

Not sourced from customer-api; always null (see NITRO-1087).

string
nullable
license
required
object
number
required

Full licence number when the caller holds customer_licence:write:all, otherwise last-4 masked.

string
nullable
expiry_date
required
string format: date-time
nullable
state
required
string
nullable
country
required
string
nullable
maskedNumber
required

Always last-4 masked, regardless of permissions.

string
nullable
customer_product
required
Array<object>
object
product_type
required
object
description
required
string
nullable
status
required
string
address
required
object
address_line_one
required
string
nullable
address_line_two
required
string
nullable
suburb
required
string
nullable
state
required
string
nullable
postcode
required
string
nullable
country
required
string
nullable
company
required
object
name
required
string
abn
required
string
id
required
string
address
required
object
address_line_one
required
string
nullable
address_line_two
required
string
nullable
suburb
required
string
nullable
state
required
string
nullable
postcode
required
string
nullable
country
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