Search
K
workspace v1

WorkspaceStatus

string

Allowed values: [CREATED, PREPARED, FUNDS_AUTHORISED, FUNDS_EXCHANGED, LODGED, REQUISITIONED, CLOSED, CANCELLED]

Match pattern:^(CREATED|PREPARED|FUNDS_AUTHORISED|FUNDS_EXCHANGED|LODGED|REQUISITIONED|CLOSED|CANCELLED)$

TransactionType

string

Transaction Type:

  • REMORTGAGE
  • PURCHASE

Match pattern:^(REMORTGAGE|PURCHASE)$

AddressDto

object
addressIdstring(uuid)read-only

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

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

SecurityAddressDto

object
securityAddressIdstring(uuid)read-only

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

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

ParticipantDto

object
participantIdstring(uuid)read-only
subscriberIdstring(uuid)required
rolestringrequired

Allowed values: [INCOMING_LENDER, BUYER_REPRESENTATIVE, SELLER_REPRESENTATIVE, INCOMING_LENDER_REPRESENTATIVE]

Match pattern:^(INCOMING_LENDER|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|INCOMING_LENDER_REPRESENTATIVE)$

Example