Search
K
workspace v1

TitleReconciliationPatchRequest

object
actionstringrequired

The type of title reconciliation action to perform.
Allowed values: [UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME]

UPDATE_PARTY_NAME

Required attributes

  • partyId
  • type (INDIVIDUAL or ORGANISATION)
  • partyDetails

partyDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdatePartyNameRequest

SET_AS_INCOMING_PROPRIETOR

Required attributes

  • partyId

Use schema: SetAsIncomingProprietorRequest

SET_AS_OUTGOING_PROPRIETOR

Required attributes

  • proprietorId

Use schema: SetAsOutgoingProprietorRequest

UPDATE_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateProprietorNameRequest

UPDATE_OUTGOING_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateOutgoingProprietorNameRequest

Example

UpdatePartyNameRequest

object
actionstringrequired

The type of title reconciliation action to perform.
Allowed values: [UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME]

UPDATE_PARTY_NAME

Required attributes

  • partyId
  • type (INDIVIDUAL or ORGANISATION)
  • partyDetails

partyDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdatePartyNameRequest

SET_AS_INCOMING_PROPRIETOR

Required attributes

  • partyId

Use schema: SetAsIncomingProprietorRequest

SET_AS_OUTGOING_PROPRIETOR

Required attributes

  • proprietorId

Use schema: SetAsOutgoingProprietorRequest

UPDATE_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateProprietorNameRequest

UPDATE_OUTGOING_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateOutgoingProprietorNameRequest

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.
Allowed values: [UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME]

UPDATE_PARTY_NAME

Required attributes

  • partyId
  • type (INDIVIDUAL or ORGANISATION)
  • partyDetails

partyDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdatePartyNameRequest

SET_AS_INCOMING_PROPRIETOR

Required attributes

  • partyId

Use schema: SetAsIncomingProprietorRequest

SET_AS_OUTGOING_PROPRIETOR

Required attributes

  • proprietorId

Use schema: SetAsOutgoingProprietorRequest

UPDATE_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateProprietorNameRequest

UPDATE_OUTGOING_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateOutgoingProprietorNameRequest

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.
Allowed values: [UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME]

UPDATE_PARTY_NAME

Required attributes

  • partyId
  • type (INDIVIDUAL or ORGANISATION)
  • partyDetails

partyDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdatePartyNameRequest

SET_AS_INCOMING_PROPRIETOR

Required attributes

  • partyId

Use schema: SetAsIncomingProprietorRequest

SET_AS_OUTGOING_PROPRIETOR

Required attributes

  • proprietorId

Use schema: SetAsOutgoingProprietorRequest

UPDATE_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateProprietorNameRequest

UPDATE_OUTGOING_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateOutgoingProprietorNameRequest

proprietorIdstring(uuid)required

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

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

Example

UpdateProprietorNameRequest

object
actionstringrequired

The type of title reconciliation action to perform.
Allowed values: [UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME]

UPDATE_PARTY_NAME

Required attributes

  • partyId
  • type (INDIVIDUAL or ORGANISATION)
  • partyDetails

partyDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdatePartyNameRequest

SET_AS_INCOMING_PROPRIETOR

Required attributes

  • partyId

Use schema: SetAsIncomingProprietorRequest

SET_AS_OUTGOING_PROPRIETOR

Required attributes

  • proprietorId

Use schema: SetAsOutgoingProprietorRequest

UPDATE_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateProprietorNameRequest

UPDATE_OUTGOING_PROPRIETOR_NAME

Required attributes

  • proprietorId
  • type (INDIVIDUAL or ORGANISATION)
  • proprietorDetails

proprietorDetails by type

  • INDIVIDUAL: forenames, surname
  • ORGANISATION: organisationName, registrationNumber (optional)

Use schema: UpdateOutgoingProprietorNameRequest

proprietorIdstring(uuid)required

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

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

typestringrequired

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

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

proprietorDetailsobjectrequired

Proprietor details for name update. Required fields depend on proprietor 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