--- title: "Workspace" url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77" --- # Workspace OpenAPI specification document. ```json {"openapi":"3.0.1","info":{"title":"Workspace","description":"This API specification includes all workspace-related experience endpoints for creating, managing, and working with workspaces","version":"v1.3.0","x-api-version":"1.3.0","x-pexa-products":["partner"],"x-pexa-segments":["lawfirms","lenders"],"x-idp-audience":"PexaPartnerAPI","x-idp-audience-identifier":"https://app.pexauk.co.uk/api/v1/pexa-partner"},"servers":[{"url":"https://api.pexa.co.uk","description":"API Gateway URL"}],"tags":[{"name":"PCS Workspace","description":"Workspace Endpoints to create, edit, cancel and manage workspaces"}],"paths":{"/partner/api/platformconnect/v1/workspaces":{"post":{"tags":["WorkspaceV1"],"summary":"Create Workspace","description":"This API is used to create a new purchase and remortgage workspace using a simple data set, returning the newly created PEXA workspace UUID","security":[{"oauth2":["x-api:create:purchase_workspaces","x-api:create:remortgage_workspaces","create:workspaces"]}],"operationId":"createWorkspace","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["transactionType","reference","property","participants","parties"],"properties":{"transactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"property":{"type":"object","required":["jurisdiction","securityAddress"],"properties":{"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"securityAddress":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"parties":{"type":"array","description":"*minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties* *maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties*\n","items":{"oneOf":[{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL)$","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"^(ORGANISATION)$","description":"Party Type:\n * `ORGANISATION`\n"},"addresses":{"type":"array","items":{"type":"object","description":"Party address is only applicable for Purchase workspace and should be provided for Organisation buyer party","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"maxItems":1},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}}]}},"participants":{"type":"array","items":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER_REPRESENTATIVE|INCOMING_LENDER)$","description":"Participant Role:\n * `INCOMING_LENDER_REPRESENTATIVE`\n * `INCOMING_LENDER`\n"}}},"maxItems":1,"minItems":1}}},"examples":{"CreateRemortgageWorkspaceRequestWithIndividualBorrower":{"value":{"transactionType":"REMORTGAGE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BORROWER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}},"CreateRemortgageWorkspaceRequestWithOrganisationBorrower":{"value":{"transactionType":"REMORTGAGE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BORROWER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}},"CreatePurchaseWorkspaceRequestWithIndividualBorrower":{"value":{"transactionType":"PURCHASE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BUYER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER"}]}},"CreatePurchaseWorkspaceRequestWithOrganisationBorrower":{"value":{"transactionType":"PURCHASE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BUYER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"},"addresses":[{"type":"REGISTERED_ADDRESS","details":{"flat":"1234","name":"Pexa Ltd.","number":"1234","postcode":"M16 7YY","street":"main","town":"new"}}]}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}}}}},"required":true},"responses":{"202":{"description":"ACCEPTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string","example":"PEXA210000012"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"securityAddress.number","message":"size must be between 0 and 4"},{"field":"reference","message":"size must be between 1 and 25"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/remortgage/workspaces":{"post":{"tags":["RemortgageWorkspace"],"summary":"Create Remortgage Workspace","description":"This API is used to create a new workspace using a simple data set, returning the newly created PEXA workspace UUID","security":[{"oauth2":["x-api:create:remortgage_workspaces","create:workspaces"]}],"operationId":"createRemortgageWorkspace","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reference","property","participants","parties"],"properties":{"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"property":{"type":"object","required":["jurisdiction","securityAddress"],"properties":{"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"securityAddress":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"parties":{"type":"array","description":"*minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties* *maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties*\n","items":{"oneOf":[{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"(INDIVIDUAL)","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"(ORGANISATION)","description":"Party Type:\n * `ORGANISATION`\n"},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}}]}},"participants":{"type":"array","items":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(CONVEYANCER)","description":"Participant Role:\n * `CONVEYANCER`\n"}}},"maxItems":1,"minItems":1}}},"examples":{"CreateWorkspaceRequestWithIndividualBorrower":{"value":{"reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BORROWER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"CONVEYANCER"}]}},"CreateWorkspaceRequestWithOrganisationBorrower":{"value":{"reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BORROWER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"CONVEYANCER"}]}}}}},"required":true},"responses":{"202":{"description":"ACCEPTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string","example":"PEXA210000012"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"securityAddress.number","message":"size must be between 0 and 4"},{"field":"reference","message":"size must be between 1 and 25"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/cancel-workspace":{"delete":{"tags":["CancelWorkspace"],"summary":"Cancel Workspace","description":"This API is used to cancel the created workspaces which are no longer required by the integrators.","security":[{"oauth2":["x-api:cancel:workspaces","edit:workspaces"]}],"operationId":"cancelWorkspace","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["cancellationReason"],"properties":{"cancellationReason":{"type":"string","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","description":"Reason to cancel the workspace.\n\nAllowed values:\n [`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`]\n"},"cancellationNotesForOther":{"maxLength":100,"minLength":1,"type":"string","example":"Title complications outside PEXA scope","description":"Mandatory when cancellationReason \"OTHER\" is provided"}}}}},"required":true},"responses":{"204":{"description":"NO CONTENT","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"cancellationNotesForOther","message":"cancellation notes cannot be null for the cancellationReason OTHER"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"workspace_id","message":"Resource not found for: workspaceId"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/references":{"post":{"tags":["Reference"],"summary":"Add Participant Reference","description":"This API allows the user to add a reference number to the workspace","operationId":"addReference","security":[{"oauth2":["add:law_firm_reference","add:legal_representation_details"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}}}}},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"reference-number","message":"incorrect data type"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}":{"get":{"tags":["Workspace"],"summary":"Get Workspace Details","description":"This API allows you to get existing workspace data by providing the PEXA workspace ID generated on workspace creation","operationId":"getWorkspace","security":[{"oauth2":["view:workspaces"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string","example":"PEXA210000012"},"status":{"type":"string","pattern":"^(CREATED|PREPARED|FUNDS_AUTHORISED|FUNDS_EXCHANGED|LODGED|REQUISITIONED|CLOSED|CANCELLED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `FUNDS_AUTHORISED`, `FUNDS_EXCHANGED`, `LODGED`, `REQUISITIONED`, `CLOSED`, `CANCELLED`]\n"},"transactionType":{"type":"string","pattern":"^(REMORTGAGE|PURCHASE)$","description":"Transaction Type:\n * REMORTGAGE\n * PURCHASE\n"},"reference":{"type":"string","example":"109344235"},"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"createdAt":{"type":"string","format":"date-time"},"completionDate":{"type":"string","format":"2022-08-01"},"securityAddress":{"required":["postcode"],"type":"object","properties":{"securityAddressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}},"auditDetails":{"required":["status"],"type":"object","properties":{"enhancedDueDiligence":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACCEPTED","REFERRED","DECLINED"]}}},"status":{"type":"string","enum":["AWAITING_REVIEW","UNDER_REVIEW","ACCEPTED","DECLINED"]}}},"parties":{"type":"array","items":{"type":"object","required":["type"],"properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `OUTGOING_LENDER`]\n"},"proprietorMatchStatus":{"type":"array","items":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `NOT_REQUIRED`, `PARTY_NAME_UPDATED`]\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"representativeType":{"type":"string","pattern":"^(EXTERNAL_LAW_FIRM|PARTICIPANT)$","example":"EXTERNAL_LAW_FIRM","description":"Allowed values: [`EXTERNAL_LAW_FIRM`, `PARTICIPANT`]\n"},"sourceProprietorId":{"type":"string","format":"uuid"},"addresses":{"type":"array","items":{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"required":["postcode"],"type":"object","properties":{"addressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}}},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}}},"references":{"type":"array","items":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}}},"readyForApproval":{"type":"boolean","default":false,"description":"flag to indicate if the workspace is ready to be approved status."},"participants":{"type":"array","items":{"type":"object","required":["subscriberId","role"],"properties":{"participantId":{"type":"string","format":"uuid","readOnly":true},"subscriberId":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|INCOMING_LENDER_REPRESENTATIVE)$","description":"Allowed values: [`INCOMING_LENDER`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `INCOMING_LENDER_REPRESENTATIVE`]\n"}}}},"canBeUnapproved":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be unapproved."},"hardLocked":{"type":"boolean","default":false,"description":"workspace hardlocked status."},"isLocked":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be soft locked."},"canBeCancelled":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be cancelled."},"borrowersValidationStatus":{"type":"string","pattern":"^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$","description":"Allowed values: [`VALID`, `INVALID`, `PENDING`, `COUNT_INVALID`, `TYPE_INVALID`, `NOT_REQUIRED`, `UNSUPPORTED_TYPE`]\n"},"remarks":{"type":"object","required":["cancellationReason"],"properties":{"cancellationReason":{"type":"string","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)$","description":"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`]\n"},"cancellationNotesForOther":{"maxLength":100,"minLength":1,"type":"string","example":"Title complications outside PEXA scope"},"actionedAt":{"type":"string","example":"2024-03-14T09:48:59.698092Z"}}},"transferOfEquity":{"type":"boolean","default":false,"description":"flag to indicate if the workspace features transfer of equity"},"subscriberId":{"type":"string","format":"uuid","description":"Subscriber Id of workspace creator"}}},"examples":{"WorkspaceResponseWithIndividualBorrower":{"value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","workspaceReferenceId":"PEXA210000012","status":"CREATED","transactionType":"REMORTGAGE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-06-02T04:42:12.062Z","completionDate":"string","securityAddress":{"securityAddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"sourceProprietorId":"31036f14-12d0-4569-adef-3a57be06cbe1"}],"readyForApproval":false,"participants":[{"participantId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subscriberId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"INCOMING_LENDER_REPRESENTATIVE"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":false,"borrowersValidationStatus":"VALID","transferOfEquity":false},"summary":"Workspace with Individual borrower"},"WorkspaceResponseWithOrganisationBorrower":{"value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","workspaceReferenceId":"PEXA210000012","status":"CREATED","transactionType":"REMORTGAGE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-06-02T04:42:12.062Z","completionDate":"string","securityAddress":{"securityAddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"0c8530b5-06d8-4c14-998f-35b42ba9d250"}],"readyForApproval":false,"participants":[{"participantId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subscriberId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"INCOMING_LENDER_REPRESENTATIVE"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":false,"borrowersValidationStatus":"VALID","transferOfEquity":false},"summary":"Workspace with Organisation Borrower"},"WorkspaceResponseWithIndividualBuyer":{"value":{"workspaceId":"14dbf34c-b094-46b4-a1c8-915b032acb8d","workspaceReferenceId":"PEXA230000182","status":"CREATED","transactionType":"PURCHASE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-10-17T08:06:27.45916Z","securityAddress":{"postcode":"M16 0RA","securityAddressId":"20296c1e-73cb-4927-8b59-b888469d2eba","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"type":"INDIVIDUAL","partyId":"98ae6866-e290-473b-95d1-6f3c1fe6ad7d","role":"BUYER","proprietorMatchStatus":["NOT_REQUIRED"],"partyDetails":{"forenames":"James Thomas","surname":"Smith"},"representationType":"DUAL_REPRESENTATION"}],"references":[{"representativeId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","referenceNumber":"109344235","representativeRole":"BUYER_REPRESENTATIVE","referenceId":"6335d6f5-b530-4814-ab05-61b5f7fa3284"}],"readyForApproval":false,"participants":[{"subscriberId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","role":"BUYER_REPRESENTATIVE","participantId":"7dc5c786-c3c2-488d-b8e3-538a2e737c55"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":true,"borrowersValidationStatus":"NOT_REQUIRED","transferOfEquity":false},"summary":"Workspace with Individual buyer"},"WorkspaceResponseWithOrganisationBuyer":{"value":{"workspaceId":"14dbf34c-b094-46b4-a1c8-915b032acb8d","workspaceReferenceId":"PEXA230000182","status":"CREATED","transactionType":"PURCHASE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-10-17T08:06:27.45916Z","securityAddress":{"postcode":"M16 0RA","securityAddressId":"20296c1e-73cb-4927-8b59-b888469d2eba","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BUYER","proprietorMatchStatus":["NOT_REQUIRED"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"123456","organisationType":"LIMITED_COMPANY"},"addresses":[{"type":"REGISTERED_ADDRESS","details":{"addressId":"5cfa07b0-5127-4637-bffd-b4b1d80020bf","name":"Pexa Ltd.","number":"1234","flat":"1234","street":"main","town":"new","postcode":"M16 7YY"}}],"representationType":"DUAL_REPRESENTATION"}],"references":[{"representativeId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","referenceNumber":"109344235","representativeRole":"BUYER_REPRESENTATIVE","referenceId":"6335d6f5-b530-4814-ab05-61b5f7fa3284"}],"readyForApproval":false,"participants":[{"subscriberId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","role":"BUYER_REPRESENTATIVE","participantId":"7dc5c786-c3c2-488d-b8e3-538a2e737c55"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":true,"borrowersValidationStatus":"NOT_REQUIRED","transferOfEquity":false},"summary":"Workspace with Organisation buyer"}}}}},"204":{"description":"NO CONTENT","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"WorkspaceResponseWithIndividualBorrower":{"value":{"errors":[{"field":"workspaceId","message":"workspace-id has to be a UUID"}]}},"WorkspaceResponseWithOrganisationBorrower":{"value":{"errors":[{"field":"workspaceId","message":"workspace-id has to be a UUID"}]}},"WorkspaceResponseWithIndividualBuyer":{"value":{"errors":[{"field":"workspaceId","message":"workspace-id has to be a UUID"}]}},"WorkspaceResponseWithOrganisationBuyer":{"value":{"errors":[{"field":"workspaceId","message":"workspace-id has to be a UUID"}]}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"WorkspaceResponseWithIndividualBorrower":{"value":{"errors":[{"message":"Internal Server Error"}]}},"WorkspaceResponseWithOrganisationBorrower":{"value":{"errors":[{"message":"Internal Server Error"}]}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/parties/{party_id}":{"patch":{"tags":["Party"],"summary":"Update Party","description":"This API allows the Law Firm to update existing borrower's details within an existing workspace","operationId":"updateParty","security":[{"oauth2":["add:legal_representation_details","create:title_change_request","edit:workspace_parties"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"party_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/UpdateIndividualPartyDetails","ORGANISATION":"#/components/schemas/UpdateOrganisationPartyDetails"}},"properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"nameChangeOnTitle":{"type":"boolean","description":"Flag to indicate whether the user has consented for name change on title."},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"partyDetails":{"oneOf":[{"type":"object","properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}},"additionalProperties":false},{"type":"object","properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}},"additionalProperties":false}]},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}},"title":"Update Party Request","description":"Request to update party"},"examples":{"UpdateIndividualParty":{"value":{"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"}},"summary":"Individual Party"},"UpdateOrganisationParty":{"value":{"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"}},"summary":"Organisation Party"},"Individual Party Name Change On Title":{"value":{"type":"INDIVIDUAL","nameChangeOnTitle":true}},"Organisation Party Confirm Representation Type":{"value":{"type":"ORGANISATION","representationType":"NO_REPRESENTATION"}}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"role":{"type":"string","pattern":"^(BORROWER|OUTGOING_PROPRIETOR)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `OUTGOING_PROPRIETOR`]\n"},"proprietorMatchStatus":{"type":"array","items":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `PARTY_NAME_UPDATED`]\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"sourceProprietorId":{"type":"string","format":"uuid"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}},"examples":{"IndividualPartyResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"sourceProprietorId":"ab5ca64f-c5a5-4bda-a440-13a2c1316663"},"summary":"Individual Party"},"OrganisationPartyResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"c60ec4c1-1188-409c-88b1-9deb9e5bfce3"},"summary":"Organisation Party"},"OrganisationPartyConfirmRepresentationTypeResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","representationType":"NO_REPRESENTATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"3f51fdea-9738-4363-b344-de1a41d796f5"},"summary":"Organisation Party Confirm Representation Type"}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"IndividualPartyResponse":{"value":{"errors":[{"message":"Party cannot be updated as the current workspace status is LODGED"},{"field":"party-id","message":"party-id has to be a UUID"}]}},"OrganisationPartyResponse":{"value":{"errors":[{"message":"Party cannot be updated as the current workspace status is LODGED"},{"field":"party-id","message":"party-id has to be a UUID"}]}},"OrganisationPartyConfirmRepresentationTypeResponse":{"value":{"errors":[{"message":"Party cannot be updated as the current workspace status is LODGED"},{"field":"party-id","message":"party-id has to be a UUID"}]}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"IndividualPartyResponse":{"value":{"errors":[{"message":"Internal Server Error"}]}},"OrganisationPartyResponse":{"value":{"errors":[{"message":"Internal Server Error"}]}},"OrganisationPartyConfirmRepresentationTypeResponse":{"value":{"errors":[{"message":"Internal Server Error"}]}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/title-reconciliation":{"get":{"tags":["TitleReconciliationV1"],"summary":"Get Title Reconciliation Status","description":"This API retrieves the party-proprietor match status for a workspace.\n","security":[{"oauth2":["x-api:view:title_reconciliation","view:workspaces","view:lodgement_proprietors"]}],"operationId":"getTitleReconciliation","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["parties","unmatchedProprietors"],"properties":{"parties":{"type":"array","description":"List of workspace parties with their proprietor match information","items":{"type":"object","required":["partyId","role","matchDetail","type","match"],"properties":{"partyId":{"type":"string","format":"uuid","description":"Unique identifier for the party"},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|INCOMING_PROPRIETOR)$","example":"BORROWER","description":"Role of the party in the workspace.\nAllowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `INCOMING_PROPRIETOR`]\n"},"match":{"type":"string","pattern":"^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$","example":"MATCH","description":"Match result between party and proprietor.\n\nAllowed values:\n[`MATCH`, `MISMATCH`, `PENDING`, `NOT_REQUIRED`]\n\n- MATCH: Party matches proprietor (or reconciliation completed)\n- MISMATCH: Party does not match proprietor\n- PENDING: Title has not been fetched yet\n- NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces)\n"},"matchDetail":{"type":"array","description":"List of match details for this party (e.g., NAME_MISMATCH, TYPE_MISMATCH)","items":{"type":"string","pattern":"^(NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH)$","example":"NAME_MISMATCH","description":"Match detail providing specific reason for match state.\n\nAllowed values:\n[`NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`]\n\n- NAME_MISMATCH: Names do not match\n- PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title\n- PARTY_NAME_UPDATED: Party name has been updated\n- TYPE_MISMATCH: Party type differs from proprietor type\n- REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"type":"object","description":"Party details - either individual or organisation","properties":{"forenames":{"type":"string","maxLength":90,"description":"Forenames for INDIVIDUAL type party","example":"James Thomas"},"surname":{"type":"string","maxLength":50,"description":"Surname for INDIVIDUAL type party","example":"Smith"},"organisationName":{"type":"string","maxLength":160,"description":"Organisation name for ORGANISATION type party","example":"Acme Ltd"},"registrationNumber":{"type":"string","maxLength":8,"description":"Companies House registration number for ORGANISATION type party","example":"12345678"},"organisationType":{"type":"string","description":"Type of organisation","example":"LIMITED_COMPANY"}}},"proprietorId":{"type":"string","format":"uuid","description":"ID of the matched proprietor from title, if any"}}}},"unmatchedProprietors":{"type":"array","description":"List of title proprietors not matched to any workspace party. Empty for Sale & Purchase workspaces.","items":{"type":"object","required":["proprietorId","type"],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"Unique identifier for the proprietor from title"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"proprietorDetails":{"type":"object","description":"Proprietor details - either individual or organisation","properties":{"forenames":{"type":"string","description":"Forenames for INDIVIDUAL type proprietor","example":"John"},"surname":{"type":"string","description":"Surname for INDIVIDUAL type proprietor","example":"Doe"},"organisationName":{"type":"string","description":"Organisation name for ORGANISATION type proprietor","example":"Corp Ltd"},"registrationNumber":{"type":"string","description":"Registration number for ORGANISATION type proprietor"}}}}}}}},"examples":{"MatchedPartyResponse":{"summary":"Matched individual party","value":{"parties":[{"partyId":"c394dc94-64cd-444d-ba5f-376eaaff2c98","role":"BORROWER","match":true,"status":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"proprietorId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"unmatchedProprietors":[]}},"NameMismatchResponse":{"summary":"Party with name mismatch","value":{"parties":[{"partyId":"c394dc94-64cd-444d-ba5f-376eaaff2c98","role":"BORROWER","match":false,"status":["NAME_MISMATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James","surname":"Smith"},"proprietorId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"unmatchedProprietors":[{"proprietorId":"b2c3d4e5-f6a7-8901-bcde-f23456789012","proprietorType":"INDIVIDUAL","forenames":"John","surname":"Doe"}]}},"OrganisationPartyResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"c60ec4c1-1188-409c-88b1-9deb9e5bfce3"},"summary":"Organisation Party"}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"workspace_id","message":"Invalid UUID format"}]}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Unauthorized"}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not a participant of the workspace"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"workspace_id","message":"Resource not found for: workspaceId"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}},"patch":{"tags":["TitleReconciliationV1"],"summary":"Update Title Reconciliation","description":"This API allows updating party and proprietor information to resolve mismatches.\n","security":[{"oauth2":["x-api:edit:title_reconciliation","edit:workspace_parties","edit:lodgement_proprietors"]}],"operationId":"patchTitleReconciliation","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}},"examples":{"UpdatePartyNameRequest":{"summary":"Update party name to match proprietor (INDIVIDUAL)","value":{"action":"UPDATE_PARTY_NAME","partyId":"123e4567-e89b-12d3-a456-426614174000","type":"INDIVIDUAL","partyDetails":{"forenames":"John","surname":"Doe"}}},"UpdatePartyNameOrganisationRequest":{"summary":"Update party name to match proprietor (ORGANISATION)","value":{"action":"UPDATE_PARTY_NAME","partyId":"123e4567-e89b-12d3-a456-426614174000","type":"ORGANISATION","partyDetails":{"organisationName":"Pexa Ltd"}}},"SetAsIncomingProprietorRequest":{"summary":"Mark party as incoming proprietor","description":"Request to mark a party as incoming proprietor. Only partyId is required - PCS fetches party details from the workspace.","value":{"action":"SET_AS_INCOMING_PROPRIETOR","partyId":"123e4567-e89b-12d3-a456-426614174000"}},"SetAsOutgoingProprietorRequest":{"summary":"Mark proprietor as outgoing","value":{"action":"SET_AS_OUTGOING_PROPRIETOR","proprietorId":"987e6543-e21b-98c7-b654-321098765432"}},"UpdateProprietorNameRequest":{"summary":"Update proprietor name to match party (INDIVIDUAL)","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameOrganisationRequest":{"summary":"Update proprietor name to match party (ORGANISATION)","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"ORGANISATION","proprietorDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"UpdateOutgoingProprietorNameRequest":{"summary":"Update outgoing role proprietor name","description":"Request to update an outgoing proprietor's name. PCS will call getProprietors to find\nthe linked workspace party (via sourcePartyId), then update the workspace party name.\n","value":{"action":"UPDATE_OUTGOING_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"FN","surname":"LN"}}}}}}},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}},"examples":{"UpdatePartyNameIndividualResponse":{"summary":"Update Individual Party Name Response","description":"Response showing party with updated name details","value":{"action":"UPDATE_PARTY_NAME","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdatePartyNameOrganisationResponse":{"summary":"Update Organisation Party Name Response","description":"Response showing party with updated organisation details","value":{"action":"UPDATE_PARTY_NAME","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"ORGANISATION","partyDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"SetAsIncomingProprietorResponse":{"summary":"Set As Incoming Proprietor Response","description":"Response showing party marked as incoming proprietor with new proprietor ID created in lodgement case","value":{"action":"SET_AS_INCOMING_PROPRIETOR","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","proprietorId":"7c8d9e0f-1234-5678-90ab-cdef12345678","titleStatus":"INCOMING"}},"SetAsOutgoingProprietorResponse":{"summary":"Set As Outgoing Proprietor Response","description":"Response showing proprietor marked with OUTGOING title status. Includes proprietor details from Lodgement domain.","value":{"action":"SET_AS_OUTGOING_PROPRIETOR","proprietorId":"ab5ca64f-c5a5-4bda-a440-13a2c1316663","titleStatus":"OUTGOING","individualDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameIndividualResponse":{"summary":"Update Individual Proprietor Name Response","description":"Response showing proprietor name updated via Lodgement domain","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameOrganisationResponse":{"summary":"Update Organisation Proprietor Name Response","description":"Response showing organisation proprietor details updated via Lodgement domain","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"ORGANISATION","proprietorDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"action","message":"Invalid action type"}]}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Unauthorized"}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not a participant of the workspace"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"workspace_id","message":"Resource not found for: workspaceId"}]}}}},"422":{"description":"UNPROCESSABLE ENTITY","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Party already matched with proprietor"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/representation":{"post":{"tags":["PartyRepresentation"],"summary":"Add Party Representation","description":"Add legal representation details for a party in a workspace","operationId":"addPartyRepresentation","security":[{"oauth2":["x-api:add:legal_representation_details","add:legal_representation_details","edit:workspace_parties","add:law_firm_reference","add:workspace_participants"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["partyId","representedBy"],"properties":{"partyId":{"type":"string","format":"uuid","description":"The unique identifier of the party"},"representedBy":{"type":"string","pattern":"^(PEXA_SUBSCRIBER_LAW_FIRM|EXTERNAL_LAW_FIRM|NOT_REPRESENTED)$","description":"Type of legal representation: * `PEXA_SUBSCRIBER_LAW_FIRM` - Represented by a PEXA subscriber law firm (subscriber ID extracted from JWT token) * `EXTERNAL_LAW_FIRM` - Represented by an external (non-PEXA subscriber) law firm * `NOT_REPRESENTED` - Not represented (requires verification of identity)\n"},"externalLawFirm":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"representationId":{"type":"string","format":"uuid","description":"Existing representation ID to reuse (for external law firms only)"},"referenceNumber":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","description":"Reference number for the representation (required for external law firms when not reusing)"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}},"examples":{"PEXASubscriberLawFirm":{"value":{"partyId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","representedBy":"PEXA_SUBSCRIBER_LAW_FIRM"},"summary":"Add PEXA Subscriber Law Firm Representation (subscriber ID extracted from JWT token)"},"ExternalLawFirm":{"value":{"partyId":"b2c3d4e5-f6a7-8901-2345-678901bcdefg","representedBy":"EXTERNAL_LAW_FIRM","externalLawFirm":{"name":"Smith & Partners LLP","address":{"number":"123","street":"High Street","town":"London","postcode":"SW1A 1AA"}},"referenceNumber":"EXT789012"},"summary":"Add External Law Firm Representation"},"NotRepresented":{"value":{"partyId":"c3d4e5f6-a7b8-9012-3456-789012cdefgh","representedBy":"NOT_REPRESENTED","verificationOfIdentity":"LAW_FIRM_CERTIFIED"},"summary":"Add Not Represented with Verification of Identity"},"ReuseExternalLawFirm":{"value":{"partyId":"d4e5f6a7-b8c9-0123-4567-890123defghi","representedBy":"EXTERNAL_LAW_FIRM","representationId":"repr-ext-law-123"},"summary":"Reuse Existing External Law Firm Representation"}}}},"required":true},"responses":{"202":{"description":"Accepted - Party representation request queued for async processing","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","partyId"],"properties":{"workspaceId":{"type":"string","format":"uuid","description":"The workspace ID"},"partyId":{"type":"string","format":"uuid","description":"The party ID"},"representationId":{"type":"string","format":"uuid","description":"Representation ID (for EXTERNAL_LAW_FIRM types only)"},"representedBy":{"type":"string","description":"Type of representation","enum":["EXTERNAL_LAW_FIRM","PEXA_SUBSCRIBER_LAW_FIRM","NOT_REPRESENTED"]},"subscriberId":{"type":"string","format":"uuid","description":"Subscriber ID (for PEXA_SUBSCRIBER_LAW_FIRM only)"},"externalLawFirm":{"description":"External law firm details (for NEW EXTERNAL_LAW_FIRM only)","type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"verificationOfIdentity":{"type":"string","description":"Verification of identity method (for NOT_REPRESENTED only)"}}},"examples":{"newExternal":{"summary":"NEW external law firm","value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa7","representationId":"3fa85f64-5717-4562-b3fc-2c963f66afa8","representedBy":"EXTERNAL_LAW_FIRM","externalLawFirm":{"name":"Smith & Partners LLP","address":{"name":"Suite 100","number":"1","street":"King Street","town":"Manchester","postcode":"M2 4LQ"}}}},"existingExternal":{"summary":"EXISTING external law firm","value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa7","representationId":"3fa85f64-5717-4562-b3fc-2c963f66afa8","representedBy":"EXTERNAL_LAW_FIRM"}},"pexaSubscriber":{"summary":"PEXA subscriber law firm","value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa7","representedBy":"PEXA_SUBSCRIBER_LAW_FIRM","subscriberId":"3fa85f64-5717-4562-b3fc-2c963f66afa9"}},"notRepresented":{"summary":"NOT_REPRESENTED","value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa7","representedBy":"NOT_REPRESENTED","verificationOfIdentity":"LAW_FIRM_CERTIFIED"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/representation/{representation_id}":{"patch":{"tags":["PartyRepresentation"],"summary":"Update External Law Firm Representation","description":"Update external law firm representation details (name and address only)","operationId":"updatePartyRepresentation","security":[{"oauth2":["x-api:edit:external_law_firm_details","edit:external_law_firm_details","edit:law_firm_reference"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"representation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"Updated external law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"examples":{"UpdateExternalLawFirm":{"value":{"name":"Updated Law Firm Ltd","address":{"street":"New Street","town":"Manchester","postcode":"M1 2AA"}},"summary":"Update External Law Firm Details"}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"representationId":{"type":"string","format":"uuid","description":"Unique identifier for the representation"},"partyId":{"type":"string","format":"uuid","description":"The party identifier"},"representedBy":{"type":"string","description":"Type of representation"},"subscriberId":{"type":"string","format":"uuid","description":"PEXA subscriber ID (for PEXA subscriber representations)"},"externalLawFirm":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"referenceNumber":{"type":"string","description":"Reference number (for external law firms)"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}}},"components":{"schemas":{"CreateRemortgageWorkspaceRequest":{"type":"object","required":["reference","property","participants","parties"],"properties":{"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"property":{"type":"object","required":["jurisdiction","securityAddress"],"properties":{"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"securityAddress":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"parties":{"type":"array","description":"*minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties* *maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties*\n","items":{"oneOf":[{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"(INDIVIDUAL)","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"(ORGANISATION)","description":"Party Type:\n * `ORGANISATION`\n"},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}}]}},"participants":{"type":"array","items":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(CONVEYANCER)","description":"Participant Role:\n * `CONVEYANCER`\n"}}},"maxItems":1,"minItems":1}}},"CreateRemortgageWorkspacePartyDto":{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]},"RemortgageIndividualDetails":{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"(INDIVIDUAL)","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},"RemortgageOrganisationDetails":{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/RemortgageIndividualDetails","ORGANISATION":"#/components/schemas/RemortgageOrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER)$","description":"Party Role: \n * `BORROWER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"(ORGANISATION)","description":"Party Type:\n * `ORGANISATION`\n"},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}},"RemortgageParticipantDto":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(CONVEYANCER)","description":"Participant Role:\n * `CONVEYANCER`\n"}}},"CancelWorkspaceRequest":{"type":"object","required":["cancellationReason"],"properties":{"cancellationReason":{"type":"string","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","description":"Reason to cancel the workspace.\n\nAllowed values:\n [`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`]\n"},"cancellationNotesForOther":{"maxLength":100,"minLength":1,"type":"string","example":"Title complications outside PEXA scope","description":"Mandatory when cancellationReason \"OTHER\" is provided"}}},"WorkspaceDto":{"type":"object","properties":{"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string","example":"PEXA210000012"},"status":{"type":"string","pattern":"^(CREATED|PREPARED|FUNDS_AUTHORISED|FUNDS_EXCHANGED|LODGED|REQUISITIONED|CLOSED|CANCELLED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `FUNDS_AUTHORISED`, `FUNDS_EXCHANGED`, `LODGED`, `REQUISITIONED`, `CLOSED`, `CANCELLED`]\n"},"transactionType":{"type":"string","pattern":"^(REMORTGAGE|PURCHASE)$","description":"Transaction Type:\n * REMORTGAGE\n * PURCHASE\n"},"reference":{"type":"string","example":"109344235"},"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"createdAt":{"type":"string","format":"date-time"},"completionDate":{"type":"string","format":"2022-08-01"},"securityAddress":{"required":["postcode"],"type":"object","properties":{"securityAddressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}},"auditDetails":{"required":["status"],"type":"object","properties":{"enhancedDueDiligence":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACCEPTED","REFERRED","DECLINED"]}}},"status":{"type":"string","enum":["AWAITING_REVIEW","UNDER_REVIEW","ACCEPTED","DECLINED"]}}},"parties":{"type":"array","items":{"type":"object","required":["type"],"properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `OUTGOING_LENDER`]\n"},"proprietorMatchStatus":{"type":"array","items":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `NOT_REQUIRED`, `PARTY_NAME_UPDATED`]\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"representativeType":{"type":"string","pattern":"^(EXTERNAL_LAW_FIRM|PARTICIPANT)$","example":"EXTERNAL_LAW_FIRM","description":"Allowed values: [`EXTERNAL_LAW_FIRM`, `PARTICIPANT`]\n"},"sourceProprietorId":{"type":"string","format":"uuid"},"addresses":{"type":"array","items":{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"required":["postcode"],"type":"object","properties":{"addressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}}},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}}},"references":{"type":"array","items":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}}},"readyForApproval":{"type":"boolean","default":false,"description":"flag to indicate if the workspace is ready to be approved status."},"participants":{"type":"array","items":{"type":"object","required":["subscriberId","role"],"properties":{"participantId":{"type":"string","format":"uuid","readOnly":true},"subscriberId":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|INCOMING_LENDER_REPRESENTATIVE)$","description":"Allowed values: [`INCOMING_LENDER`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `INCOMING_LENDER_REPRESENTATIVE`]\n"}}}},"canBeUnapproved":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be unapproved."},"hardLocked":{"type":"boolean","default":false,"description":"workspace hardlocked status."},"isLocked":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be soft locked."},"canBeCancelled":{"type":"boolean","default":false,"description":"flag to indicate if the workspace can be cancelled."},"borrowersValidationStatus":{"type":"string","pattern":"^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$","description":"Allowed values: [`VALID`, `INVALID`, `PENDING`, `COUNT_INVALID`, `TYPE_INVALID`, `NOT_REQUIRED`, `UNSUPPORTED_TYPE`]\n"},"remarks":{"type":"object","required":["cancellationReason"],"properties":{"cancellationReason":{"type":"string","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)$","description":"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`]\n"},"cancellationNotesForOther":{"maxLength":100,"minLength":1,"type":"string","example":"Title complications outside PEXA scope"},"actionedAt":{"type":"string","example":"2024-03-14T09:48:59.698092Z"}}},"transferOfEquity":{"type":"boolean","default":false,"description":"flag to indicate if the workspace features transfer of equity"},"subscriberId":{"type":"string","format":"uuid","description":"Subscriber Id of workspace creator"}}},"WorkspaceStatus":{"type":"string","pattern":"^(CREATED|PREPARED|FUNDS_AUTHORISED|FUNDS_EXCHANGED|LODGED|REQUISITIONED|CLOSED|CANCELLED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `FUNDS_AUTHORISED`, `FUNDS_EXCHANGED`, `LODGED`, `REQUISITIONED`, `CLOSED`, `CANCELLED`]\n"},"TransactionType":{"type":"string","pattern":"^(REMORTGAGE|PURCHASE)$","description":"Transaction Type:\n * REMORTGAGE\n * PURCHASE\n"},"AuditDetailsDto":{"required":["status"],"type":"object","properties":{"enhancedDueDiligence":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACCEPTED","REFERRED","DECLINED"]}}},"status":{"type":"string","enum":["AWAITING_REVIEW","UNDER_REVIEW","ACCEPTED","DECLINED"]}}},"EnhancedDueDiligenceDto":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACCEPTED","REFERRED","DECLINED"]}}},"AuditStatus":{"type":"string","enum":["AWAITING_REVIEW","UNDER_REVIEW","ACCEPTED","DECLINED"]},"RiskAssessmentStatus":{"type":"string","enum":["ACCEPTED","REFERRED","DECLINED"]},"AddressDto":{"required":["postcode"],"type":"object","properties":{"addressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}},"SecurityAddressDto":{"required":["postcode"],"type":"object","properties":{"securityAddressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}},"ParticipantDto":{"type":"object","required":["subscriberId","role"],"properties":{"participantId":{"type":"string","format":"uuid","readOnly":true},"subscriberId":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|INCOMING_LENDER_REPRESENTATIVE)$","description":"Allowed values: [`INCOMING_LENDER`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `INCOMING_LENDER_REPRESENTATIVE`]\n"}}},"RemarksDto":{"type":"object","required":["cancellationReason"],"properties":{"cancellationReason":{"type":"string","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)$","description":"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`]\n"},"cancellationNotesForOther":{"maxLength":100,"minLength":1,"type":"string","example":"Title complications outside PEXA scope"},"actionedAt":{"type":"string","example":"2024-03-14T09:48:59.698092Z"}}},"CancellationReason":{"type":"string","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)$","description":"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`]\n"},"BorrowersValidationStatus":{"type":"string","pattern":"^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$","description":"Allowed values: [`VALID`, `INVALID`, `PENDING`, `COUNT_INVALID`, `TYPE_INVALID`, `NOT_REQUIRED`, `UNSUPPORTED_TYPE`]\n"},"ReferenceDto":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}},"RepresentativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"},"PartyDto":{"type":"object","required":["type"],"properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `OUTGOING_LENDER`]\n"},"proprietorMatchStatus":{"type":"array","items":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `NOT_REQUIRED`, `PARTY_NAME_UPDATED`]\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"representativeType":{"type":"string","pattern":"^(EXTERNAL_LAW_FIRM|PARTICIPANT)$","example":"EXTERNAL_LAW_FIRM","description":"Allowed values: [`EXTERNAL_LAW_FIRM`, `PARTICIPANT`]\n"},"sourceProprietorId":{"type":"string","format":"uuid"},"addresses":{"type":"array","items":{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"required":["postcode"],"type":"object","properties":{"addressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}}},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}},"PartyAddress":{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"required":["postcode"],"type":"object","properties":{"addressId":{"type":"string","format":"uuid","readOnly":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"PartyRole":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `OUTGOING_LENDER`]\n"},"BorrowerMatchStatus":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `NOT_REQUIRED`, `PARTY_NAME_UPDATED`]\n"},"RepresentativeType":{"type":"string","pattern":"^(EXTERNAL_LAW_FIRM|PARTICIPANT)$","example":"EXTERNAL_LAW_FIRM","description":"Allowed values: [`EXTERNAL_LAW_FIRM`, `PARTICIPANT`]\n"},"UpdatePartyRequest":{"type":"object","required":["type"],"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/UpdateIndividualPartyDetails","ORGANISATION":"#/components/schemas/UpdateOrganisationPartyDetails"}},"properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"nameChangeOnTitle":{"type":"boolean","description":"Flag to indicate whether the user has consented for name change on title."},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"partyDetails":{"oneOf":[{"type":"object","properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}},"additionalProperties":false},{"type":"object","properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}},"additionalProperties":false}]},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}},"title":"Update Party Request","description":"Request to update party"},"UpdateIndividualPartyDetails":{"type":"object","properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}},"additionalProperties":false},"UpdateOrganisationPartyDetails":{"type":"object","properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}},"additionalProperties":false},"TitleReconciliationResponse":{"type":"object","required":["parties","unmatchedProprietors"],"properties":{"parties":{"type":"array","description":"List of workspace parties with their proprietor match information","items":{"type":"object","required":["partyId","role","matchDetail","type","match"],"properties":{"partyId":{"type":"string","format":"uuid","description":"Unique identifier for the party"},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|INCOMING_PROPRIETOR)$","example":"BORROWER","description":"Role of the party in the workspace.\nAllowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `INCOMING_PROPRIETOR`]\n"},"match":{"type":"string","pattern":"^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$","example":"MATCH","description":"Match result between party and proprietor.\n\nAllowed values:\n[`MATCH`, `MISMATCH`, `PENDING`, `NOT_REQUIRED`]\n\n- MATCH: Party matches proprietor (or reconciliation completed)\n- MISMATCH: Party does not match proprietor\n- PENDING: Title has not been fetched yet\n- NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces)\n"},"matchDetail":{"type":"array","description":"List of match details for this party (e.g., NAME_MISMATCH, TYPE_MISMATCH)","items":{"type":"string","pattern":"^(NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH)$","example":"NAME_MISMATCH","description":"Match detail providing specific reason for match state.\n\nAllowed values:\n[`NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`]\n\n- NAME_MISMATCH: Names do not match\n- PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title\n- PARTY_NAME_UPDATED: Party name has been updated\n- TYPE_MISMATCH: Party type differs from proprietor type\n- REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"type":"object","description":"Party details - either individual or organisation","properties":{"forenames":{"type":"string","maxLength":90,"description":"Forenames for INDIVIDUAL type party","example":"James Thomas"},"surname":{"type":"string","maxLength":50,"description":"Surname for INDIVIDUAL type party","example":"Smith"},"organisationName":{"type":"string","maxLength":160,"description":"Organisation name for ORGANISATION type party","example":"Acme Ltd"},"registrationNumber":{"type":"string","maxLength":8,"description":"Companies House registration number for ORGANISATION type party","example":"12345678"},"organisationType":{"type":"string","description":"Type of organisation","example":"LIMITED_COMPANY"}}},"proprietorId":{"type":"string","format":"uuid","description":"ID of the matched proprietor from title, if any"}}}},"unmatchedProprietors":{"type":"array","description":"List of title proprietors not matched to any workspace party. Empty for Sale & Purchase workspaces.","items":{"type":"object","required":["proprietorId","type"],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"Unique identifier for the proprietor from title"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"proprietorDetails":{"type":"object","description":"Proprietor details - either individual or organisation","properties":{"forenames":{"type":"string","description":"Forenames for INDIVIDUAL type proprietor","example":"John"},"surname":{"type":"string","description":"Surname for INDIVIDUAL type proprietor","example":"Doe"},"organisationName":{"type":"string","description":"Organisation name for ORGANISATION type proprietor","example":"Corp Ltd"},"registrationNumber":{"type":"string","description":"Registration number for ORGANISATION type proprietor"}}}}}}}},"PartyMatchInfo":{"type":"object","required":["partyId","role","matchDetail","type","match"],"properties":{"partyId":{"type":"string","format":"uuid","description":"Unique identifier for the party"},"role":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|INCOMING_PROPRIETOR)$","example":"BORROWER","description":"Role of the party in the workspace.\nAllowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `INCOMING_PROPRIETOR`]\n"},"match":{"type":"string","pattern":"^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$","example":"MATCH","description":"Match result between party and proprietor.\n\nAllowed values:\n[`MATCH`, `MISMATCH`, `PENDING`, `NOT_REQUIRED`]\n\n- MATCH: Party matches proprietor (or reconciliation completed)\n- MISMATCH: Party does not match proprietor\n- PENDING: Title has not been fetched yet\n- NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces)\n"},"matchDetail":{"type":"array","description":"List of match details for this party (e.g., NAME_MISMATCH, TYPE_MISMATCH)","items":{"type":"string","pattern":"^(NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH)$","example":"NAME_MISMATCH","description":"Match detail providing specific reason for match state.\n\nAllowed values:\n[`NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`]\n\n- NAME_MISMATCH: Names do not match\n- PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title\n- PARTY_NAME_UPDATED: Party name has been updated\n- TYPE_MISMATCH: Party type differs from proprietor type\n- REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"type":"object","description":"Party details - either individual or organisation","properties":{"forenames":{"type":"string","maxLength":90,"description":"Forenames for INDIVIDUAL type party","example":"James Thomas"},"surname":{"type":"string","maxLength":50,"description":"Surname for INDIVIDUAL type party","example":"Smith"},"organisationName":{"type":"string","maxLength":160,"description":"Organisation name for ORGANISATION type party","example":"Acme Ltd"},"registrationNumber":{"type":"string","maxLength":8,"description":"Companies House registration number for ORGANISATION type party","example":"12345678"},"organisationType":{"type":"string","description":"Type of organisation","example":"LIMITED_COMPANY"}}},"proprietorId":{"type":"string","format":"uuid","description":"ID of the matched proprietor from title, if any"}}},"PartyDetailsDto":{"type":"object","description":"Party details - either individual or organisation","properties":{"forenames":{"type":"string","maxLength":90,"description":"Forenames for INDIVIDUAL type party","example":"James Thomas"},"surname":{"type":"string","maxLength":50,"description":"Surname for INDIVIDUAL type party","example":"Smith"},"organisationName":{"type":"string","maxLength":160,"description":"Organisation name for ORGANISATION type party","example":"Acme Ltd"},"registrationNumber":{"type":"string","maxLength":8,"description":"Companies House registration number for ORGANISATION type party","example":"12345678"},"organisationType":{"type":"string","description":"Type of organisation","example":"LIMITED_COMPANY"}}},"UnmatchedProprietorDto":{"type":"object","required":["proprietorId","type"],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"Unique identifier for the proprietor from title"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"proprietorDetails":{"type":"object","description":"Proprietor details - either individual or organisation","properties":{"forenames":{"type":"string","description":"Forenames for INDIVIDUAL type proprietor","example":"John"},"surname":{"type":"string","description":"Surname for INDIVIDUAL type proprietor","example":"Doe"},"organisationName":{"type":"string","description":"Organisation name for ORGANISATION type proprietor","example":"Corp Ltd"},"registrationNumber":{"type":"string","description":"Registration number for ORGANISATION type proprietor"}}}}},"ProprietorDetailsDto":{"type":"object","description":"Proprietor details - either individual or organisation","properties":{"forenames":{"type":"string","description":"Forenames for INDIVIDUAL type proprietor","example":"John"},"surname":{"type":"string","description":"Surname for INDIVIDUAL type proprietor","example":"Doe"},"organisationName":{"type":"string","description":"Organisation name for ORGANISATION type proprietor","example":"Corp Ltd"},"registrationNumber":{"type":"string","description":"Registration number for ORGANISATION type proprietor"}}},"MatchEnum":{"type":"string","pattern":"^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$","example":"MATCH","description":"Match result between party and proprietor.\n\nAllowed values:\n[`MATCH`, `MISMATCH`, `PENDING`, `NOT_REQUIRED`]\n\n- MATCH: Party matches proprietor (or reconciliation completed)\n- MISMATCH: Party does not match proprietor\n- PENDING: Title has not been fetched yet\n- NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces)\n"},"MatchDetailEnum":{"type":"string","pattern":"^(NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH)$","example":"NAME_MISMATCH","description":"Match detail providing specific reason for match state.\n\nAllowed values:\n[`NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`]\n\n- NAME_MISMATCH: Names do not match\n- PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title\n- PARTY_NAME_UPDATED: Party name has been updated\n- TYPE_MISMATCH: Party type differs from proprietor type\n- REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ\n"},"MatchStatusEnum":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PROPRIETOR_NAME_CHANGE_REQUIRED|PARTY_NAME_UPDATED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|BORROWER|BUYER|SELLER|INCOMING_PROPRIETOR|OUTGOING_PROPRIETOR)$","example":"NAME_MISMATCH","description":"Match status between party and proprietor.\n\nAllowed values:\n[`MATCH`, `NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `BORROWER`, `BUYER`, `SELLER`, `INCOMING_PROPRIETOR`, `OUTGOING_PROPRIETOR`]\n- MATCH: Party matches proprietor\n- NAME_MISMATCH: Names do not match\n- PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title\n- PARTY_NAME_UPDATED: Party name has been updated\n- TYPE_MISMATCH: Party type differs from proprietor type\n- REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ\n- BORROWER: Party is a borrower\n- BUYER: Party is a buyer (S&P workspace)\n- SELLER: Party is a seller (S&P workspace)\n- INCOMING_PROPRIETOR: Party marked as incoming proprietor\n- OUTGOING_PROPRIETOR: Party marked as outgoing proprietor\n\n@deprecated Use MatchDetailEnum instead. Role values will be removed in future versions.\n"},"PartyTypeEnum":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"PartyRoleEnum":{"type":"string","pattern":"^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|INCOMING_PROPRIETOR)$","example":"BORROWER","description":"Role of the party in the workspace.\nAllowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `INCOMING_PROPRIETOR`]\n"},"AddRepresentationRequest":{"type":"object","required":["partyId","representedBy"],"properties":{"partyId":{"type":"string","format":"uuid","description":"The unique identifier of the party"},"representedBy":{"type":"string","pattern":"^(PEXA_SUBSCRIBER_LAW_FIRM|EXTERNAL_LAW_FIRM|NOT_REPRESENTED)$","description":"Type of legal representation: * `PEXA_SUBSCRIBER_LAW_FIRM` - Represented by a PEXA subscriber law firm (subscriber ID extracted from JWT token) * `EXTERNAL_LAW_FIRM` - Represented by an external (non-PEXA subscriber) law firm * `NOT_REPRESENTED` - Not represented (requires verification of identity)\n"},"externalLawFirm":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"representationId":{"type":"string","format":"uuid","description":"Existing representation ID to reuse (for external law firms only)"},"referenceNumber":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","description":"Reference number for the representation (required for external law firms when not reusing)"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}},"UpdateRepresentationRequest":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"Updated external law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"ExternalLawFirmDto":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"RepresentationResponse":{"type":"object","properties":{"representationId":{"type":"string","format":"uuid","description":"Unique identifier for the representation"},"partyId":{"type":"string","format":"uuid","description":"The party identifier"},"representedBy":{"type":"string","description":"Type of representation"},"subscriberId":{"type":"string","format":"uuid","description":"PEXA subscriber ID (for PEXA subscriber representations)"},"externalLawFirm":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"referenceNumber":{"type":"string","description":"Reference number (for external law firms)"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}},"AddRepresentationAcknowledgement":{"type":"object","required":["workspaceId","partyId"],"properties":{"workspaceId":{"type":"string","format":"uuid","description":"The workspace ID"},"partyId":{"type":"string","format":"uuid","description":"The party ID"},"representationId":{"type":"string","format":"uuid","description":"Representation ID (for EXTERNAL_LAW_FIRM types only)"},"representedBy":{"type":"string","description":"Type of representation","enum":["EXTERNAL_LAW_FIRM","PEXA_SUBSCRIBER_LAW_FIRM","NOT_REPRESENTED"]},"subscriberId":{"type":"string","format":"uuid","description":"Subscriber ID (for PEXA_SUBSCRIBER_LAW_FIRM only)"},"externalLawFirm":{"description":"External law firm details (for NEW EXTERNAL_LAW_FIRM only)","type":"object","required":["name","address"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"External law firm name"},"address":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"verificationOfIdentity":{"type":"string","description":"Verification of identity method (for NOT_REPRESENTED only)"}}},"TitleReconciliationPatchRequest":{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}},"UpdatePartyNameRequest":{"type":"object","required":["partyId","type","partyDetails"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}}],"properties":{"partyId":{"type":"string","format":"uuid","description":"ID of the party to update (required for this action)","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"type":"object","additionalProperties":false,"description":"Party details for name update. Required fields depend on party type:\n- For INDIVIDUAL: forenames (string, required), surname (string, required)\n- For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)\n","properties":{"forenames":{"type":"string","minLength":1,"maxLength":100,"description":"Forenames of the individual party (required for INDIVIDUAL type only)","example":"John"},"surname":{"type":"string","minLength":1,"maxLength":100,"description":"Surname of the individual party (required for INDIVIDUAL type only)","example":"Doe"},"organisationName":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the organisation (required for ORGANISATION type only)","example":"Pexa Ltd"},"registrationNumber":{"type":"string","maxLength":20,"description":"Registration number of the organisation (optional for ORGANISATION type)","example":"12345678"}}}}},"SetAsIncomingProprietorRequest":{"type":"object","description":"Request to mark a party as an incoming proprietor.\nOnly requires partyId. Only INDIVIDUAL parties are supported.\n","required":["partyId"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}}],"properties":{"partyId":{"type":"string","format":"uuid","description":"ID of the party to mark as incoming proprietor (required for this action)","example":"123e4567-e89b-12d3-a456-426614174000"}}},"SetAsOutgoingProprietorRequest":{"type":"object","description":"Request to mark an unmatched proprietor as outgoing.\nOnly requires proprietorId - the titleStatus will be set to OUTGOING.\nThe response will include proprietor details from the Lodgement domain.\n","required":["proprietorId"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}}],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the unmatched proprietor to mark as outgoing (required for this action)","example":"987e6543-e21b-98c7-b654-321098765432"}}},"UpdateProprietorNameRequest":{"type":"object","required":["proprietorId","type","proprietorDetails"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}}],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the proprietor to update (required for this action)","example":"987e6543-e21b-98c7-b654-321098765432"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"proprietorDetails":{"type":"object","additionalProperties":false,"description":"Proprietor details for name update. Required fields depend on proprietor type:\n- For INDIVIDUAL: forenames (string, required), surname (string, required)\n- For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)\n","properties":{"forenames":{"type":"string","minLength":1,"maxLength":100,"description":"Forenames of the individual proprietor (required for INDIVIDUAL type only)","example":"James Thomas"},"surname":{"type":"string","minLength":1,"maxLength":100,"description":"Surname of the individual proprietor (required for INDIVIDUAL type only)","example":"Smith"},"organisationName":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the organisation (required for ORGANISATION type only)","example":"Pexa Ltd"},"registrationNumber":{"type":"string","maxLength":20,"description":"Registration number of the organisation (optional for ORGANISATION type)","example":"12345678"}}}}},"UpdateOutgoingProprietorNameRequest":{"type":"object","required":["proprietorId","type","proprietorDetails"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameRequest","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorRequest","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorRequest","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameRequest","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameRequest"}},"properties":{"action":{"type":"string","description":"The type of title reconciliation action to perform.\nAllowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]\n\n
\nUPDATE_PARTY_NAME\n\n**Required attributes**\n- `partyId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `partyDetails`\n\n**partyDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)\n
\n\n
\nSET_AS_INCOMING_PROPRIETOR\n\n**Required attributes**\n- `partyId`\n\nUse schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)\n
\n\n
\nSET_AS_OUTGOING_PROPRIETOR\n\n**Required attributes**\n- `proprietorId`\n\nUse schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)\n
\n\n
\nUPDATE_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)\n
\n\n
\nUPDATE_OUTGOING_PROPRIETOR_NAME\n\n**Required attributes**\n- `proprietorId`\n- `type` (`INDIVIDUAL` or `ORGANISATION`)\n- `proprietorDetails`\n\n**proprietorDetails by type**\n- `INDIVIDUAL`: `forenames`, `surname`\n- `ORGANISATION`: `organisationName`, `registrationNumber` (optional)\n\nUse schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)\n
\n"}}}],"description":"Request to update an OUTGOING role proprietor's name via orchestrated flow.\nThis action is for proprietors that have been marked as outgoing (via SET_AS_OUTGOING_PROPRIETOR).\nPCS will call getProprietors to find the linked workspace party, then update the party name.\n","properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the outgoing proprietor to update (required for this action)","example":"987e6543-e21b-98c7-b654-321098765432"},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Type of party or proprietor.\nAllowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"proprietorDetails":{"type":"object","additionalProperties":false,"description":"Proprietor details for name update. Required fields depend on proprietor type:\n- For INDIVIDUAL: forenames (string, required), surname (string, required)\n- For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)\n","properties":{"forenames":{"type":"string","minLength":1,"maxLength":100,"description":"Forenames of the individual proprietor (required for INDIVIDUAL type only)","example":"FN"},"surname":{"type":"string","minLength":1,"maxLength":100,"description":"Surname of the individual proprietor (required for INDIVIDUAL type only)","example":"LN"},"organisationName":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the organisation (required for ORGANISATION type only)","example":"Pexa Ltd"},"registrationNumber":{"type":"string","maxLength":20,"description":"Registration number of the organisation (optional for ORGANISATION type)","example":"12345678"}}}}},"TitleReconciliationPatchResponse":{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}},"UpdatePartyNameResponse":{"type":"object","required":["partyId","type"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}}],"properties":{"partyId":{"type":"string","format":"uuid","description":"ID of the party that was updated"},"type":{"type":"string","description":"Type of party that was updated"},"partyDetails":{"type":"object","description":"Updated party details (type-specific fields)","properties":{"forenames":{"type":"string","description":"Updated forenames (INDIVIDUAL only)"},"surname":{"type":"string","description":"Updated surname (INDIVIDUAL only)"},"organisationName":{"type":"string","description":"Updated organisation name (ORGANISATION only)"},"registrationNumber":{"type":"string","description":"Updated registration number (ORGANISATION only)"}}}}},"SetAsIncomingProprietorResponse":{"type":"object","required":["partyId","proprietorId"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}}],"properties":{"partyId":{"type":"string","format":"uuid","description":"ID of the party that was marked as incoming proprietor"},"proprietorId":{"type":"string","format":"uuid","description":"ID of the newly created incoming proprietor in lodgement case"},"titleStatus":{"type":"string","description":"Title status of the proprietor (always INCOMING for this action)"}}},"SetAsOutgoingProprietorResponse":{"type":"object","description":"Response after marking proprietor as outgoing.\nReturns the proprietor details from the Lodgement domain response.\nEither individualDetails or organisationDetails will be present based on proprietor type.\n","required":["proprietorId"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}}],"properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the proprietor that was marked as outgoing"},"titleStatus":{"type":"string","description":"Updated title status (always OUTGOING for this action)"},"individualDetails":{"type":"object","description":"Individual proprietor details (present when proprietor is INDIVIDUAL type)","properties":{"forenames":{"type":"string","description":"Forenames of the individual proprietor","example":"James Thomas"},"surname":{"type":"string","description":"Surname of the individual proprietor","example":"Smith"}}},"organisationDetails":{"type":"object","description":"Organisation proprietor details (present when proprietor is ORGANISATION type)","properties":{"organisationName":{"type":"string","description":"Name of the organisation","example":"Pexa Ltd"},"registrationNumber":{"type":"string","description":"Registration number of the organisation","example":"12345678"}}}}},"UpdateProprietorNameResponse":{"type":"object","required":["proprietorId","type"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}}],"description":"Response for UPDATE_PROPRIETOR_NAME action.\nReturns the updated proprietor details after the Lodgement domain updated the proprietor.\n","properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the proprietor whose name was updated"},"type":{"type":"string","description":"Type of proprietor whose name was updated (INDIVIDUAL or ORGANISATION)"},"proprietorDetails":{"type":"object","description":"Updated proprietor details (type-specific fields)","properties":{"forenames":{"type":"string","description":"Updated forenames (INDIVIDUAL only)"},"surname":{"type":"string","description":"Updated surname (INDIVIDUAL only)"},"organisationName":{"type":"string","description":"Updated organisation name (ORGANISATION only)"},"registrationNumber":{"type":"string","description":"Updated registration number (ORGANISATION only)"}}}}},"UpdateOutgoingProprietorNameResponse":{"type":"object","required":["proprietorId","type"],"allOf":[{"type":"object","required":["action"],"discriminator":{"propertyName":"action","mapping":{"UPDATE_PARTY_NAME":"#/components/schemas/UpdatePartyNameResponse","SET_AS_INCOMING_PROPRIETOR":"#/components/schemas/SetAsIncomingProprietorResponse","SET_AS_OUTGOING_PROPRIETOR":"#/components/schemas/SetAsOutgoingProprietorResponse","UPDATE_PROPRIETOR_NAME":"#/components/schemas/UpdateProprietorNameResponse","UPDATE_OUTGOING_PROPRIETOR_NAME":"#/components/schemas/UpdateOutgoingProprietorNameResponse"}},"description":"Response for title reconciliation actions","properties":{"action":{"type":"string","description":"The action that was performed"}}}],"description":"Response for UPDATE_OUTGOING_PROPRIETOR_NAME action.\nReturns the updated proprietor details after the workspace party was updated via orchestrated flow.\n","properties":{"proprietorId":{"type":"string","format":"uuid","description":"ID of the outgoing proprietor whose name was updated"},"type":{"type":"string","description":"Type of proprietor that was updated (INDIVIDUAL or ORGANISATION)"},"proprietorDetails":{"type":"object","description":"Updated proprietor details (transformed from party response)","properties":{"forenames":{"type":"string","description":"Updated forenames (INDIVIDUAL only)"},"surname":{"type":"string","description":"Updated surname (INDIVIDUAL only)"},"organisationName":{"type":"string","description":"Updated organisation name (ORGANISATION only)"},"registrationNumber":{"type":"string","description":"Updated registration number (ORGANISATION only)"}}}}},"X-Request-Correlation-Id":{"type":"string","description":"The unique identifier for the request"},"schemas-TransactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"Jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"Postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"},"schemas-SecurityAddressDto":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}},"PropertyDto":{"type":"object","required":["jurisdiction","securityAddress"],"properties":{"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"securityAddress":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"IndividualDetails":{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL)$","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},"CreateWorkspacePartyDto":{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]},"AddressType":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"schemas-PartyAddress":{"type":"object","description":"Party address is only applicable for Purchase workspace and should be provided for Organisation buyer party","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"OrganisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"RegistrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"OrganisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"},"OrganisationPartyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}},"OrganisationDetails":{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"^(ORGANISATION)$","description":"Party Type:\n * `ORGANISATION`\n"},"addresses":{"type":"array","items":{"type":"object","description":"Party address is only applicable for Purchase workspace and should be provided for Organisation buyer party","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"maxItems":1},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}},"Forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"Surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"IndividualPartyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},"schemas-ParticipantDto":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER_REPRESENTATIVE|INCOMING_LENDER)$","description":"Participant Role:\n * `INCOMING_LENDER_REPRESENTATIVE`\n * `INCOMING_LENDER`\n"}}},"CreateWorkspaceRequest":{"type":"object","required":["transactionType","reference","property","participants","parties"],"properties":{"transactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"property":{"type":"object","required":["jurisdiction","securityAddress"],"properties":{"jurisdiction":{"type":"string","pattern":"^(ENGLAND_WALES)$","example":"ENGLAND_WALES","description":"Jurisdiction:\n * `ENGLAND_WALES` - England/Wales\n"},"securityAddress":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"parties":{"type":"array","description":"*minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties* *maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties*\n","items":{"oneOf":[{"type":"object","required":["type","partyDetails"],"allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL)$","description":"Party Type:\n * `INDIVIDUAL`\n"},"partyDetails":{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}}},{"type":"object","allOf":[{"type":"object","discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualDetails","ORGANISATION":"#/components/schemas/OrganisationDetails"}},"properties":{"role":{"type":"string","pattern":"^(BORROWER|BUYER)$","description":"Party Role: Allowed values are BUYER for purchase workspace and BORROWER for remortgage workspace\n * `BORROWER`\n * `BUYER`\n"}},"required":["role"]}],"required":["type","partyDetails"],"properties":{"type":{"type":"string","pattern":"^(ORGANISATION)$","description":"Party Type:\n * `ORGANISATION`\n"},"addresses":{"type":"array","items":{"type":"object","description":"Party address is only applicable for Purchase workspace and should be provided for Organisation buyer party","required":["type","details"],"properties":{"type":{"type":"string","pattern":"^(REGISTERED_ADDRESS)$","description":"Address Type:\n * `REGISTERED_ADDRESS`\n"},"details":{"type":"object","required":["postcode"],"properties":{"name":{"maxLength":50,"minLength":0,"type":"string","example":"1 The House"},"number":{"maxLength":4,"minLength":0,"type":"string","example":"123a"},"flat":{"maxLength":30,"minLength":0,"type":"string","example":"Flat 32"},"street":{"maxLength":60,"minLength":0,"type":"string","example":"Huddersfield"},"town":{"maxLength":30,"minLength":0,"type":"string","example":"West Yorkshire"},"postcode":{"maxLength":8,"minLength":6,"type":"string","example":"M16 0RA","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}))$"}}}}},"maxItems":1},"partyDetails":{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}}}]}},"participants":{"type":"array","items":{"type":"object","required":["id","role"],"properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","pattern":"^(INCOMING_LENDER_REPRESENTATIVE|INCOMING_LENDER)$","description":"Participant Role:\n * `INCOMING_LENDER_REPRESENTATIVE`\n * `INCOMING_LENDER`\n"}}},"maxItems":1,"minItems":1}}},"X-API-Version":{"type":"string","description":"The API version that was used to process the request."},"CreateWorkspaceAcknowledgement":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string","maxLength":25,"minLength":1,"example":"109344235"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string","example":"PEXA210000012"}}},"Error":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"PrimaryKeyId":{"type":"string","format":"uuid"},"schemas-RepresentativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"},"schemas-ReferenceDto":{"type":"object","required":["referenceNumber","representativeRole"],"properties":{"referenceId":{"type":"string","format":"uuid","readOnly":true},"representativeId":{"type":"string","format":"uuid"},"referenceNumber":{"maxLength":25,"minLength":1,"type":"string","example":"123456"},"representativeRole":{"type":"string","pattern":"^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$","example":"BORROWER_REPRESENTATIVE","description":"Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`, `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`, `BUYER_REPRESENTATIVE`, `OUTGOING_PROPRIETOR_REPRESENTATIVE`]
Note - Representative role `WORKSPACE_LAW_FIRM` will be replaced with `INCOMING_LENDER_REPRESENTATIVE` soon\n"}}},"PartyType":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"PartyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"RepresentationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"VerificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"},"schemas-PartyRole":{"type":"string","pattern":"^(BORROWER|OUTGOING_PROPRIETOR)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `OUTGOING_PROPRIETOR`]\n"},"schemas-BorrowerMatchStatus":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `PARTY_NAME_UPDATED`]\n"},"schemas-PartyDto":{"type":"object","required":["type"],"properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"role":{"type":"string","pattern":"^(BORROWER|OUTGOING_PROPRIETOR)$","example":"BORROWER","description":"Allowed values: [`BORROWER`, `OUTGOING_PROPRIETOR`]\n"},"proprietorMatchStatus":{"type":"array","items":{"type":"string","pattern":"^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|PARTY_NAME_UPDATED)$","example":"NAME_MISMATCH","description":"Allowed values: [`MATCH`, `NAME_MISMATCH`, `PENDING`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`, `PARTY_NAME_UPDATED`]\n"}},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"partyDetails":{"oneOf":[{"type":"object","required":["forenames","surname"],"properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}},{"type":"object","required":["organisationName","registrationNumber","organisationType"],"properties":{"organisationName":{"maxLength":160,"minLength":1,"type":"string","example":"My Organisation","pattern":"^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\\d&@£$€¥#‘’'(){}<>!«»“”\"\\[\\]?*=%+\\s.,:\\/;\\\\-]+$"},"registrationNumber":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z0-9]+$","example":"ABCD1234"},"organisationType":{"maxLength":200,"minLength":1,"type":"string","pattern":"^(LIMITED_COMPANY)$","example":"LIMITED_COMPANY","description":"Organisation Type:\n * `LIMITED_COMPANY`\n"}}}]},"representationType":{"type":"string","pattern":"^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$","example":"NO_REPRESENTATION","description":"Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`, `SEPARATE_REPRESENTATION`]\n"},"representationId":{"type":"string","format":"uuid"},"sourceProprietorId":{"type":"string","format":"uuid"},"verificationOfIdentity":{"type":"string","pattern":"^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$","example":"LAW_FIRM_CERTIFIED","description":"Allowed values: [`LAW_FIRM_CERTIFIED`, `IDENTITY_EVIDENCE`]\n"}}}},"examples":{"CreateRemortgageWorkspaceRequestWithIndividualBorrower":{"value":{"transactionType":"REMORTGAGE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BORROWER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}},"CreateRemortgageWorkspaceRequestWithOrganisationBorrower":{"value":{"transactionType":"REMORTGAGE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BORROWER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}},"CreatePurchaseWorkspaceRequestWithIndividualBorrower":{"value":{"transactionType":"PURCHASE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BUYER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER"}]}},"CreatePurchaseWorkspaceRequestWithOrganisationBorrower":{"value":{"transactionType":"PURCHASE","reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BUYER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"},"addresses":[{"type":"REGISTERED_ADDRESS","details":{"flat":"1234","name":"Pexa Ltd.","number":"1234","postcode":"M16 7YY","street":"main","town":"new"}}]}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"INCOMING_LENDER_REPRESENTATIVE"}]}},"CreateWorkspaceRequestWithIndividualBorrower":{"value":{"reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"INDIVIDUAL","role":"BORROWER","partyDetails":{"forenames":"James","surname":"Smith"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"CONVEYANCER"}]}},"CreateWorkspaceRequestWithOrganisationBorrower":{"value":{"reference":"109344235","property":{"jurisdiction":"ENGLAND_WALES","securityAddress":{"name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"}},"parties":[{"type":"ORGANISATION","role":"BORROWER","partyDetails":{"organisationName":"James Smith","organisationType":"LIMITED_COMPANY","registrationNumber":"12345678"}}],"participants":[{"id":"6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd","role":"CONVEYANCER"}]}},"WorkspaceResponseWithIndividualBorrower":{"value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","workspaceReferenceId":"PEXA210000012","status":"CREATED","transactionType":"REMORTGAGE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-06-02T04:42:12.062Z","completionDate":"string","securityAddress":{"securityAddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"sourceProprietorId":"31036f14-12d0-4569-adef-3a57be06cbe1"}],"readyForApproval":false,"participants":[{"participantId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subscriberId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"INCOMING_LENDER_REPRESENTATIVE"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":false,"borrowersValidationStatus":"VALID","transferOfEquity":false},"summary":"Workspace with Individual borrower"},"WorkspaceResponseWithOrganisationBorrower":{"value":{"workspaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","workspaceReferenceId":"PEXA210000012","status":"CREATED","transactionType":"REMORTGAGE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-06-02T04:42:12.062Z","completionDate":"string","securityAddress":{"securityAddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire","postcode":"M16 0RA"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"0c8530b5-06d8-4c14-998f-35b42ba9d250"}],"readyForApproval":false,"participants":[{"participantId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subscriberId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"INCOMING_LENDER_REPRESENTATIVE"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":false,"borrowersValidationStatus":"VALID","transferOfEquity":false},"summary":"Workspace with Organisation Borrower"},"WorkspaceResponseWithIndividualBuyer":{"value":{"workspaceId":"14dbf34c-b094-46b4-a1c8-915b032acb8d","workspaceReferenceId":"PEXA230000182","status":"CREATED","transactionType":"PURCHASE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-10-17T08:06:27.45916Z","securityAddress":{"postcode":"M16 0RA","securityAddressId":"20296c1e-73cb-4927-8b59-b888469d2eba","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"type":"INDIVIDUAL","partyId":"98ae6866-e290-473b-95d1-6f3c1fe6ad7d","role":"BUYER","proprietorMatchStatus":["NOT_REQUIRED"],"partyDetails":{"forenames":"James Thomas","surname":"Smith"},"representationType":"DUAL_REPRESENTATION"}],"references":[{"representativeId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","referenceNumber":"109344235","representativeRole":"BUYER_REPRESENTATIVE","referenceId":"6335d6f5-b530-4814-ab05-61b5f7fa3284"}],"readyForApproval":false,"participants":[{"subscriberId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","role":"BUYER_REPRESENTATIVE","participantId":"7dc5c786-c3c2-488d-b8e3-538a2e737c55"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":true,"borrowersValidationStatus":"NOT_REQUIRED","transferOfEquity":false},"summary":"Workspace with Individual buyer"},"WorkspaceResponseWithOrganisationBuyer":{"value":{"workspaceId":"14dbf34c-b094-46b4-a1c8-915b032acb8d","workspaceReferenceId":"PEXA230000182","status":"CREATED","transactionType":"PURCHASE","reference":"109344235","jurisdiction":"ENGLAND_WALES","createdAt":"2023-10-17T08:06:27.45916Z","securityAddress":{"postcode":"M16 0RA","securityAddressId":"20296c1e-73cb-4927-8b59-b888469d2eba","name":"1 The House","number":"123a","flat":"Flat 32","street":"Huddersfield","town":"West Yorkshire"},"auditDetails":{"status":"UNDER_REVIEW","enhancedDueDiligence":{"id":"20296c1e-73cb-4927-8b59-b888469d2eba","status":"REFERRED"}},"parties":[{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BUYER","proprietorMatchStatus":["NOT_REQUIRED"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"123456","organisationType":"LIMITED_COMPANY"},"addresses":[{"type":"REGISTERED_ADDRESS","details":{"addressId":"5cfa07b0-5127-4637-bffd-b4b1d80020bf","name":"Pexa Ltd.","number":"1234","flat":"1234","street":"main","town":"new","postcode":"M16 7YY"}}],"representationType":"DUAL_REPRESENTATION"}],"references":[{"representativeId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","referenceNumber":"109344235","representativeRole":"BUYER_REPRESENTATIVE","referenceId":"6335d6f5-b530-4814-ab05-61b5f7fa3284"}],"readyForApproval":false,"participants":[{"subscriberId":"23329e28-b1c7-46b7-9d22-369f9f18e8d7","role":"BUYER_REPRESENTATIVE","participantId":"7dc5c786-c3c2-488d-b8e3-538a2e737c55"}],"canBeUnapproved":false,"hardLocked":false,"isLocked":false,"canBeCancelled":true,"borrowersValidationStatus":"NOT_REQUIRED","transferOfEquity":false},"summary":"Workspace with Organisation buyer"},"WorkspaceResponse400StatusDefaultErrorMessage":{"value":{"errors":[{"field":"workspaceId","message":"workspace-id has to be a UUID"}]}},"UpdateIndividualParty":{"value":{"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"}},"summary":"Individual Party"},"UpdateOrganisationParty":{"value":{"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"}},"summary":"Organisation Party"},"IndividualPartyResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"sourceProprietorId":"ab5ca64f-c5a5-4bda-a440-13a2c1316663"},"summary":"Individual Party"},"OrganisationPartyResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"c60ec4c1-1188-409c-88b1-9deb9e5bfce3"},"summary":"Organisation Party"},"OrganisationPartyConfirmRepresentationTypeResponse":{"value":{"partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","role":"BORROWER","proprietorMatchStatus":["MATCH"],"type":"ORGANISATION","representationType":"NO_REPRESENTATION","partyDetails":{"organisationName":"Pexa ltd.","registrationNumber":"12345678","organisationType":"LIMITED_COMPANY"},"sourceProprietorId":"3f51fdea-9738-4363-b344-de1a41d796f5"},"summary":"Organisation Party Confirm Representation Type"},"UpdatePartyResponse400StatusDefaultErrorMessage":{"value":{"errors":[{"message":"Party cannot be updated as the current workspace status is LODGED"},{"field":"party-id","message":"party-id has to be a UUID"}]}},"UpdatePartyNameRequest":{"summary":"Update party name to match proprietor (INDIVIDUAL)","value":{"action":"UPDATE_PARTY_NAME","partyId":"123e4567-e89b-12d3-a456-426614174000","type":"INDIVIDUAL","partyDetails":{"forenames":"John","surname":"Doe"}}},"UpdatePartyNameOrganisationRequest":{"summary":"Update party name to match proprietor (ORGANISATION)","value":{"action":"UPDATE_PARTY_NAME","partyId":"123e4567-e89b-12d3-a456-426614174000","type":"ORGANISATION","partyDetails":{"organisationName":"Pexa Ltd"}}},"SetAsIncomingProprietorRequest":{"summary":"Mark party as incoming proprietor","description":"Request to mark a party as incoming proprietor. Only partyId is required - PCS fetches party details from the workspace.","value":{"action":"SET_AS_INCOMING_PROPRIETOR","partyId":"123e4567-e89b-12d3-a456-426614174000"}},"SetAsOutgoingProprietorRequest":{"summary":"Mark proprietor as outgoing","value":{"action":"SET_AS_OUTGOING_PROPRIETOR","proprietorId":"987e6543-e21b-98c7-b654-321098765432"}},"UpdateProprietorNameRequest":{"summary":"Update proprietor name to match party (INDIVIDUAL)","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameOrganisationRequest":{"summary":"Update proprietor name to match party (ORGANISATION)","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"ORGANISATION","proprietorDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"UpdateOutgoingProprietorNameRequest":{"summary":"Update outgoing role proprietor name","description":"Request to update an outgoing proprietor's name. PCS will call getProprietors to find\nthe linked workspace party (via sourcePartyId), then update the workspace party name.\n","value":{"action":"UPDATE_OUTGOING_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"FN","surname":"LN"}}},"UpdatePartyNameIndividualResponse":{"summary":"Update Individual Party Name Response","description":"Response showing party with updated name details","value":{"action":"UPDATE_PARTY_NAME","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdatePartyNameOrganisationResponse":{"summary":"Update Organisation Party Name Response","description":"Response showing party with updated organisation details","value":{"action":"UPDATE_PARTY_NAME","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"ORGANISATION","partyDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"SetAsIncomingProprietorResponse":{"summary":"Set As Incoming Proprietor Response","description":"Response showing party marked as incoming proprietor with new proprietor ID created in lodgement case","value":{"action":"SET_AS_INCOMING_PROPRIETOR","partyId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","proprietorId":"7c8d9e0f-1234-5678-90ab-cdef12345678","titleStatus":"INCOMING"}},"SetAsOutgoingProprietorResponse":{"summary":"Set As Outgoing Proprietor Response","description":"Response showing proprietor marked with OUTGOING title status. Includes proprietor details from Lodgement domain.","value":{"action":"SET_AS_OUTGOING_PROPRIETOR","proprietorId":"ab5ca64f-c5a5-4bda-a440-13a2c1316663","titleStatus":"OUTGOING","individualDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameIndividualResponse":{"summary":"Update Individual Proprietor Name Response","description":"Response showing proprietor name updated via Lodgement domain","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"James Thomas","surname":"Smith"}}},"UpdateProprietorNameOrganisationResponse":{"summary":"Update Organisation Proprietor Name Response","description":"Response showing organisation proprietor details updated via Lodgement domain","value":{"action":"UPDATE_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"ORGANISATION","proprietorDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"UpdateOutgoingProprietorNameIndividualResponse":{"summary":"Update outgoing proprietor name response (INDIVIDUAL)","description":"Response showing outgoing proprietor name updated via workspace party update","value":{"action":"UPDATE_OUTGOING_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"INDIVIDUAL","proprietorDetails":{"forenames":"FN","surname":"LN"}}},"UpdateOutgoingProprietorNameOrganisationResponse":{"summary":"Update outgoing proprietor name response (ORGANISATION)","description":"Response showing outgoing proprietor name updated via workspace party update","value":{"action":"UPDATE_OUTGOING_PROPRIETOR_NAME","proprietorId":"987e6543-e21b-98c7-b654-321098765432","type":"ORGANISATION","proprietorDetails":{"organisationName":"Pexa Ltd","registrationNumber":"12345678"}}},"AddPEXASubscriberRepresentation":{"value":{"partyId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","representedBy":"PEXA_SUBSCRIBER_LAW_FIRM"},"summary":"Add PEXA Subscriber Law Firm Representation (subscriber ID extracted from JWT token)"},"AddExternalLawFirmRepresentation":{"value":{"partyId":"b2c3d4e5-f6a7-8901-2345-678901bcdefg","representedBy":"EXTERNAL_LAW_FIRM","externalLawFirm":{"name":"Smith & Partners LLP","address":{"number":"123","street":"High Street","town":"London","postcode":"SW1A 1AA"}},"referenceNumber":"EXT789012"},"summary":"Add External Law Firm Representation"},"AddNotRepresentedRepresentation":{"value":{"partyId":"c3d4e5f6-a7b8-9012-3456-789012cdefgh","representedBy":"NOT_REPRESENTED","verificationOfIdentity":"LAW_FIRM_CERTIFIED"},"summary":"Add Not Represented with Verification of Identity"},"ReuseExternalLawFirmRepresentation":{"value":{"partyId":"d4e5f6a7-b8c9-0123-4567-890123defghi","representedBy":"EXTERNAL_LAW_FIRM","representationId":"repr-ext-law-123"},"summary":"Reuse Existing External Law Firm Representation"},"UpdateExternalLawFirmRepresentation":{"value":{"name":"Updated Law Firm Ltd","address":{"street":"New Street","town":"Manchester","postcode":"M1 2AA"}},"summary":"Update External Law Firm Details"},"MatchedPartyResponse":{"summary":"Matched individual party","value":{"parties":[{"partyId":"c394dc94-64cd-444d-ba5f-376eaaff2c98","role":"BORROWER","match":true,"status":["MATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James Thomas","surname":"Smith"},"proprietorId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"unmatchedProprietors":[]}},"NameMismatchResponse":{"summary":"Party with name mismatch","value":{"parties":[{"partyId":"c394dc94-64cd-444d-ba5f-376eaaff2c98","role":"BORROWER","match":false,"status":["NAME_MISMATCH"],"type":"INDIVIDUAL","partyDetails":{"forenames":"James","surname":"Smith"},"proprietorId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"unmatchedProprietors":[{"proprietorId":"b2c3d4e5-f6a7-8901-bcde-f23456789012","proprietorType":"INDIVIDUAL","forenames":"John","surname":"Doe"}]}},"InternalServerErrorMessage":{"value":{"errors":[{"message":"Internal Server Error"}]}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://login.pexauk.co.uk/oauth/token","scopes":{"x-api:create:purchase_workspaces":"Permission to create purchase workspace","x-api:create:remortgage_workspaces":"Permission to create remortgage workspace","x-api:cancel:workspaces":"Permission to cancel the workspace","add:law_firm_reference":"add law firm reference","add:legal_representation_details":"add legal representation details","view:workspaces":"view workspace","create:title_change_request":"create title change request","edit:workspace_parties":"edit workspace parties","x-api:add:legal_representation_details":"Permission to add party representation","x-api:edit:external_law_firm_details":"Permission to update external law firm representation","create:workspaces":"Permission to create workspaces","edit:workspaces":"Permission to edit workspaces","edit:lodgement_proprietors":"Permission to edit proprietors linked to lodgement case","view:lodgement_proprietors":"Permission to view proprietors linked to lodgement case","add:workspace_participants":"Permission to add workspace participants","edit:external_law_firm_details":"Permission to edit external law firm details","edit:law_firm_reference":"Permission to edit law firm reference"}}}}},"parameters":{"X-Request-Correlation-Id":{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},"WorkspaceId":{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"ServiceUnavailable":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}},"x-audience-url":"https://app.pexauk.co.uk/api/v1/pexa-partner"} ```