Search
K
workspace v1

AddRepresentationAcknowledgement

object
workspaceIdstring(uuid)required

The workspace ID

partyIdstring(uuid)required

The party ID

representationIdstring(uuid)

Representation ID (for EXTERNAL_LAW_FIRM types only)

representedBystring

Type of representation

Allowed values:EXTERNAL_LAW_FIRMPEXA_SUBSCRIBER_LAW_FIRMNOT_REPRESENTED

subscriberIdstring(uuid)

Subscriber ID (for PEXA_SUBSCRIBER_LAW_FIRM only)

externalLawFirmobject

External law firm details (for NEW EXTERNAL_LAW_FIRM only)

Show Child Parameters
verificationOfIdentitystring

Verification of identity method (for NOT_REPRESENTED only)

Example

TitleReconciliationPatchRequest

object
actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

Example

UpdatePartyNameRequest

object
actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

partyIdstring(uuid)required

ID of the party to update (required for this action)

Example:123e4567-e89b-12d3-a456-426614174000

typestringrequired

Type of party or proprietor.
Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

partyDetailsobjectrequired

Party details for name update. Required fields depend on party type:

  • For INDIVIDUAL: forenames (string, required), surname (string, required)
  • For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)
* Additional properties are NOT allowed.
Show Child Parameters
Example

SetAsIncomingProprietorRequest

object

Request to mark a party as an incoming proprietor.
Only requires partyId. Only INDIVIDUAL parties are supported.

actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

partyIdstring(uuid)required

ID of the party to mark as incoming proprietor (required for this action)

Example:123e4567-e89b-12d3-a456-426614174000

Example

SetAsOutgoingProprietorRequest

object

Request to mark an unmatched proprietor as outgoing.
Only requires proprietorId - the titleStatus will be set to OUTGOING.
The response will include proprietor details from the Lodgement domain.

actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

proprietorIdstring(uuid)required

ID of the unmatched proprietor to mark as outgoing (required for this action)

Example:987e6543-e21b-98c7-b654-321098765432

Example