Search
K
workspace v1

ExternalLawFirmDto

object
namestringrequired

External law firm name

>= 1 characters<= 160 characters

addressobjectrequired
Show Child Parameters
Example

RepresentationResponse

object
representationIdstring(uuid)

Unique identifier for the representation

partyIdstring(uuid)

The party identifier

representedBystring

Type of representation

subscriberIdstring(uuid)

PEXA subscriber ID (for PEXA subscriber representations)

externalLawFirmobject
Show Child Parameters
referenceNumberstring

Reference number (for external law firms)

verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example

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.
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