Search
K
workspace v1

Update External Law Firm Representation

Update external law firm representation details (name and address only)

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

Path Parameters

workspace_idstring(uuid)required

Workspace id

representation_idstring(uuid)required

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
namestringrequired

Updated external law firm name

>= 1 characters<= 160 characters

addressobjectrequired
Show Child Parameters

Response

application/json

OK

representationIdstring(uuid)

Unique identifier for the representation

partyIdstring(uuid)

The party identifier

representedBystring

Type of representation

subscriberIdstring(uuid)

PEXA subscriber ID (for PEXA subscriber representations)

externalLawFirmobject
Show Child Parameters
referenceNumberstring

Reference number (for external law firms)

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}/representation/{representation_id}

Body

{ "name": "Updated Law Firm Ltd", "address": { "street": "New Street", "town": "Manchester", "postcode": "M1 2AA" } }
 
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

RemortgageOrganisationDetails

object
rolestringrequired

Party Role:

  • BORROWER

Match pattern:^(BORROWER)$

typestringrequired

Party Type:

  • ORGANISATION

Match pattern:(ORGANISATION)

partyDetailsobjectrequired
Show Child Parameters
Example