Search
K
workspace v1

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

AddRepresentationRequest

object
partyIdstring(uuid)required

The unique identifier of the party

representedBystringrequired

Type of legal representation: * PEXA_SUBSCRIBER_LAW_FIRM - Represented by a PEXA subscriber law firm (subscriber ID extracted from JWT token) * EXTERNAL_LAW_FIRM - Represented by an external (non-PEXA subscriber) law firm * NOT_REPRESENTED - Not represented (requires verification of identity)

Match pattern:^(PEXA_SUBSCRIBER_LAW_FIRM|EXTERNAL_LAW_FIRM|NOT_REPRESENTED)$

externalLawFirmobject
Show Child Parameters
representationIdstring(uuid)

Existing representation ID to reuse (for external law firms only)

referenceNumberstring

Reference number for the representation (required for external law firms when not reusing)

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 18 characters

verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example