Search
K
workspace v1

SetAsOutgoingProprietorResponse

object

Response after marking proprietor as outgoing.
Returns the proprietor details from the Lodgement domain response.
Either individualDetails or organisationDetails will be present based on proprietor type.

actionstringrequired

The action that was performed

proprietorIdstring(uuid)required

ID of the proprietor that was marked as outgoing

titleStatusstring

Updated title status (always OUTGOING for this action)

individualDetailsobject

Individual proprietor details (present when proprietor is INDIVIDUAL type)

Show Child Parameters
organisationDetailsobject

Organisation proprietor details (present when proprietor is ORGANISATION type)

Show Child Parameters
Example

UpdateProprietorNameResponse

object

Response for UPDATE_PROPRIETOR_NAME action.
Returns the updated proprietor details after the Lodgement domain updated the proprietor.

actionstringrequired

The action that was performed

proprietorIdstring(uuid)required

ID of the proprietor whose name was updated

typestringrequired

Type of proprietor whose name was updated (INDIVIDUAL or ORGANISATION)

proprietorDetailsobject

Updated proprietor details (type-specific fields)

Show Child Parameters
Example

UpdateOutgoingProprietorNameResponse

object

Response for UPDATE_OUTGOING_PROPRIETOR_NAME action.
Returns the updated proprietor details after the workspace party was updated via orchestrated flow.

actionstringrequired

The action that was performed

proprietorIdstring(uuid)required

ID of the outgoing proprietor whose name was updated

typestringrequired

Type of proprietor that was updated (INDIVIDUAL or ORGANISATION)

proprietorDetailsobject

Updated proprietor details (transformed from party response)

Show Child Parameters
Example

X-Request-Correlation-Id

string

The unique identifier for the request

schemas-TransactionType

string

Allowed values: [PURCHASE, REMORTGAGE]

Match pattern:^(PURCHASE|REMORTGAGE)$