Search
K
workspace v1

schemas-SecurityAddressDto

object
namestring

>= 0 characters<= 50 characters

Example:1 The House

numberstring

>= 0 characters<= 4 characters

Example:123a

flatstring

>= 0 characters<= 30 characters

Example:Flat 32

streetstring

>= 0 characters<= 60 characters

Example:Huddersfield

townstring

>= 0 characters<= 30 characters

Example:West Yorkshire

postcodestringrequired

Match pattern:^(([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$

>= 6 characters<= 8 characters

Example:M16 0RA

Example

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)$