Search
K
workspace v1

Get Workspace Details

This API allows you to get existing workspace data by providing the PEXA workspace ID generated on workspace creation

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/json

OK

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

get/partner/api/platformconnect/v1/workspaces/{workspace_id}
 
application/json

Update Party

This API allows the Law Firm to update existing borrower’s details within an existing workspace

patch
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/parties/{party_id}

Path Parameters

workspace_idstring(uuid)required

Workspace id

party_idstring(uuid)required

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json

Update Party Request

Request to update party

typestringrequired

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

nameChangeOnTitleboolean

Flag to indicate whether the user has consented for name change on title.

representationTypestring

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

Match pattern:^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$

Example:NO_REPRESENTATION

representationIdstring(uuid)
partyDetailsOne Of
Variant 1object
* Additional properties are NOT allowed.
Show Child Parameters
verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Response

application/json

OK

partyIdstring(uuid)read-only
rolestring

Allowed values: [BORROWER, OUTGOING_PROPRIETOR]

Match pattern:^(BORROWER|OUTGOING_PROPRIETOR)$

Example:BORROWER

proprietorMatchStatusarray[string]

Allowed values: [MATCH, NAME_MISMATCH, PENDING, PROPRIETOR_NAME_CHANGE_REQUIRED, TYPE_MISMATCH, REGISTRATION_NUMBER_MISMATCH, PARTY_NAME_UPDATED]

Match pattern:^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|PARTY_NAME_UPDATED)$

Example:NAME_MISMATCH

typestringrequired

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

partyDetailsOne Of
Variant 1object
Show Child Parameters
representationTypestring

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

Match pattern:^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$

Example:NO_REPRESENTATION

representationIdstring(uuid)
sourceProprietorIdstring(uuid)
verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

patch/partner/api/platformconnect/v1/workspaces/{workspace_id}/parties/{party_id}

Body

{ "type": "INDIVIDUAL", "partyDetails": { "forenames": "James Thomas", "surname": "Smith" } }
 
application/json

CreateRemortgageWorkspaceRequest

object
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

CreateRemortgageWorkspacePartyDto

object
rolestringrequired

Party Role:

  • BORROWER

Match pattern:^(BORROWER)$

Example

RemortgageIndividualDetails

object
rolestringrequired

Party Role:

  • BORROWER

Match pattern:^(BORROWER)$

typestringrequired

Party Type:

  • INDIVIDUAL

Match pattern:(INDIVIDUAL)

partyDetailsobjectrequired
Show Child Parameters
Example