Search
K
workspace v1

PartyDetailsDto

object

Party details - either individual or organisation

forenamesstring

Forenames for INDIVIDUAL type party

<= 90 characters

Example:James Thomas

surnamestring

Surname for INDIVIDUAL type party

<= 50 characters

Example:Smith

organisationNamestring

Organisation name for ORGANISATION type party

<= 160 characters

Example:Acme Ltd

registrationNumberstring

Companies House registration number for ORGANISATION type party

<= 8 characters

Example:12345678

organisationTypestring

Type of organisation

Example:LIMITED_COMPANY

Example

UnmatchedProprietorDto

object
proprietorIdstring(uuid)required

Unique identifier for the proprietor from title

typestringrequired

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

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

proprietorDetailsobject

Proprietor details - either individual or organisation

Show Child Parameters
Example

ProprietorDetailsDto

object

Proprietor details - either individual or organisation

forenamesstring

Forenames for INDIVIDUAL type proprietor

Example:John

surnamestring

Surname for INDIVIDUAL type proprietor

Example:Doe

organisationNamestring

Organisation name for ORGANISATION type proprietor

Example:Corp Ltd

registrationNumberstring

Registration number for ORGANISATION type proprietor

Example

MatchEnum

string

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

MatchDetailEnum

string

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