Search
K
workspace v1

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

MatchStatusEnum

string

Match status between party and proprietor.

Allowed values:
[MATCH, NAME_MISMATCH, PROPRIETOR_NAME_CHANGE_REQUIRED, PARTY_NAME_UPDATED, TYPE_MISMATCH, REGISTRATION_NUMBER_MISMATCH, BORROWER, BUYER, SELLER, INCOMING_PROPRIETOR, OUTGOING_PROPRIETOR]

  • MATCH: Party matches proprietor
  • 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
  • BORROWER: Party is a borrower
  • BUYER: Party is a buyer (S&P workspace)
  • SELLER: Party is a seller (S&P workspace)
  • INCOMING_PROPRIETOR: Party marked as incoming proprietor
  • OUTGOING_PROPRIETOR: Party marked as outgoing proprietor

@deprecated Use MatchDetailEnum instead. Role values will be removed in future versions.

Match pattern:^(MATCH|NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|BORROWER|BUYER|SELLER|INCOMING_PROPRIETOR|OUTGOING_PROPRIETOR)$

Example

PartyTypeEnum

string

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

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example

PartyRoleEnum

string

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