Search
K
workspace v1

PropertyDto

object
jurisdictionstringrequired

Jurisdiction:

  • ENGLAND_WALES - England/Wales

Match pattern:^(ENGLAND_WALES)$

Example:ENGLAND_WALES

securityAddressobjectrequired
Show Child Parameters
Example

IndividualDetails

object
rolestringrequired

Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace

  • BORROWER
  • BUYER

Match pattern:^(BORROWER|BUYER)$

typestringrequired

Party Type:

  • INDIVIDUAL

Match pattern:^(INDIVIDUAL)$

partyDetailsobjectrequired
Show Child Parameters
Example

CreateWorkspacePartyDto

object
rolestringrequired

Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace

  • BORROWER
  • BUYER

Match pattern:^(BORROWER|BUYER)$

Example

AddressType

string

Address Type:

  • REGISTERED_ADDRESS

Match pattern:^(REGISTERED_ADDRESS)$

schemas-PartyAddress

object

Party address is only applicable for Purchase workspace and should be provided for Organisation buyer party

typestringrequired

Address Type:

  • REGISTERED_ADDRESS

Match pattern:^(REGISTERED_ADDRESS)$

detailsobjectrequired
Show Child Parameters
Example