Search
K
workspace v1

Update Party Request

object

Request to update party

typestringrequired

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

nameChangeOnTitleboolean

Flag to indicate whether the user has consented for name change on title.

representationTypestring

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

Match pattern:^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$

Example:NO_REPRESENTATION

representationIdstring(uuid)
partyDetailsOne Of
Variant 1object
* Additional properties are NOT allowed.
Show Child Parameters
verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example

UpdateIndividualPartyDetails

object
* Additional properties are NOT allowed.
forenamesstring

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 90 characters

Example:James Thomas

surnamestring

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 50 characters

Example:Smith

Example

UpdateOrganisationPartyDetails

object
* Additional properties are NOT allowed.
organisationNamestring

Match pattern:^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#‘’'(){}<>!«»“”"\[\]?*=%+\s.,:\/;\\-]+$

>= 1 characters<= 160 characters

Example:My Organisation

registrationNumberstring

Match pattern:^[A-Z0-9]+$

>= 6 characters<= 8 characters

Example:ABCD1234

organisationTypestring

Organisation Type:

  • LIMITED_COMPANY

Match pattern:^(LIMITED_COMPANY)$

>= 1 characters<= 200 characters

Example:LIMITED_COMPANY

Example

TitleReconciliationResponse

object
partiesarray[object]required

List of workspace parties with their proprietor match information

Show Child Parameters
unmatchedProprietorsarray[object]required

List of title proprietors not matched to any workspace party. Empty for Sale & Purchase workspaces.

Show Child Parameters
Example

PartyMatchInfo

object
partyIdstring(uuid)required

Unique identifier for the party

rolestringrequired

Role of the party in the workspace.
Allowed values: [BORROWER, BUYER, SELLER, OUTGOING_PROPRIETOR, INCOMING_PROPRIETOR]

Match pattern:^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|INCOMING_PROPRIETOR)$

Example:BORROWER

matchstringrequired

Match result between party and proprietor.

Allowed values:
[MATCH, MISMATCH, PENDING, NOT_REQUIRED]

  • MATCH: Party matches proprietor (or reconciliation completed)
  • MISMATCH: Party does not match proprietor
  • PENDING: Title has not been fetched yet
  • NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces)

Match pattern:^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$

Example:MATCH

matchDetailarray[string]required

Match detail providing specific reason for match state.

Allowed values:
[NAME_MISMATCH, PROPRIETOR_NAME_CHANGE_REQUIRED, PARTY_NAME_UPDATED, TYPE_MISMATCH, REGISTRATION_NUMBER_MISMATCH]

  • NAME_MISMATCH: Names do not match
  • PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title
  • PARTY_NAME_UPDATED: Party name has been updated
  • TYPE_MISMATCH: Party type differs from proprietor type
  • REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ

Match pattern:^(NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH)$

Example:NAME_MISMATCH

typestringrequired

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

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

partyDetailsobject

Party details - either individual or organisation

Show Child Parameters
proprietorIdstring(uuid)

ID of the matched proprietor from title, if any

Example