Skip to content

Get Account

GET
/bff/vouch/customer/account/{accountId}

Get an account by id (proxy to customer-api, requires account:read).

accountId
required
string format: uuid

Account details with active members

object
id
required
string format: uuid
tenantId
required
string
name
required
string
type
required
string
Allowed values: personal business
status
required
string
metadata
required
object
key
additional properties
createdAt
required
string
nullable
updatedAt
required
string
nullable
members
required
Array<object>
object
id
required
string format: uuid
accountId
required
string format: uuid
memberId
required
string format: uuid
tenantId
required
string
role
required
string
status
required
string
joinedAt
required
string
nullable
createdAt
required
string
nullable
updatedAt
required
string
nullable
firstName
required
string
nullable
lastName
required
string
nullable
email
required
string
nullable
mobile
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