Search
K
workspace v1

CancelWorkspaceRequest

object
cancellationReasonstringrequired

Reason to cancel the workspace.

Allowed values:
[APPLICANT_DECIDED_NOT_TO_PROCEED, TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE, LAW_FIRM_NO_LONGER_ACTING, LENDER_DECIDED_NOT_TO_PROCEED, LOAN_INVOLVES_MULTIPLE_TITLES, OTHER]

Match pattern:^(APPLICANT_DECIDED_NOT_TO_PROCEED|TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE|LAW_FIRM_NO_LONGER_ACTING|LENDER_DECIDED_NOT_TO_PROCEED|LOAN_INVOLVES_MULTIPLE_TITLES|OTHER)$

Example:APPLICANT_DECIDED_NOT_TO_PROCEED

cancellationNotesForOtherstring

Mandatory when cancellationReason “OTHER” is provided

>= 1 characters<= 100 characters

Example:Title complications outside PEXA scope

Example

WorkspaceDto

object
workspaceIdstring(uuid)
workspaceReferenceIdstring

Example:PEXA210000012

statusstring

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

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

transactionTypestring

Transaction Type:

  • REMORTGAGE
  • PURCHASE

Match pattern:^(REMORTGAGE|PURCHASE)$

referencestring

Example:109344235

jurisdictionstring

Jurisdiction:

  • ENGLAND_WALES - England/Wales

Match pattern:^(ENGLAND_WALES)$

Example:ENGLAND_WALES

createdAtstring(date-time)
completionDatestring(2022-08-01)
securityAddressobject
Show Child Parameters
partiesarray[object]
Show Child Parameters
referencesarray[object]
Show Child Parameters
readyForApprovalboolean

flag to indicate if the workspace is ready to be approved status.

Default:false

participantsarray[object]
Show Child Parameters
canBeUnapprovedboolean

flag to indicate if the workspace can be unapproved.

Default:false

hardLockedboolean

workspace hardlocked status.

Default:false

isLockedboolean

flag to indicate if the workspace can be soft locked.

Default:false

canBeCancelledboolean

flag to indicate if the workspace can be cancelled.

Default:false

borrowersValidationStatusstring

Allowed values: [VALID, INVALID, PENDING, COUNT_INVALID, TYPE_INVALID, NOT_REQUIRED, UNSUPPORTED_TYPE]

Match pattern:^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$

remarksobject
Show Child Parameters
transferOfEquityboolean

flag to indicate if the workspace features transfer of equity

Default:false

subscriberIdstring(uuid)

Subscriber Id of workspace creator

Example

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