Search
K
workspace v1

Surname

string

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 50 characters

Example

IndividualPartyDetails

object
forenamesstringrequired

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 90 characters

Example:James Thomas

surnamestringrequired

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 50 characters

Example:Smith

Example

schemas-ParticipantDto

object
idstring(uuid)required
rolestringrequired

Participant Role:

  • INCOMING_LENDER_REPRESENTATIVE
  • INCOMING_LENDER

Match pattern:^(INCOMING_LENDER_REPRESENTATIVE|INCOMING_LENDER)$

Example

CreateWorkspaceRequest

object
transactionTypestringrequired

Allowed values: [PURCHASE, REMORTGAGE]

Match pattern:^(PURCHASE|REMORTGAGE)$

referencestringrequired

>= 1 characters<= 25 characters

Example:109344235

propertyobjectrequired
Show Child Parameters
partiesOne Of
arrayrequired

minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties

Variant 1object
Show Child Parameters
participantsarray[object]required

>= 1 items<= 1 items

Show Child Parameters
Example

X-API-Version

string

The API version that was used to process the request.