--- title: "Get Title Reconciliation Status" url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42/operations/getTitleReconciliation" --- > Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42.md # Get Title Reconciliation Status `GET` `/partner/api/platformconnect/v1/workspaces/{workspace_id}/title-reconciliation` Operation ID: `getTitleReconciliation` This API retrieves the party-proprietor match status for a workspace. ## Path parameters - `workspace_id` (string, uuid, required) - Workspace id ## Header parameters - `X-Request-Correlation-Id` (string, optional) ## Responses - `200` - OK - `400` - BAD REQUEST - `401` - UNAUTHORIZED - `403` - FORBIDDEN - `404` - NOT FOUND - `500` - INTERNAL SERVER ERROR - `503` - SERVICE UNAVAILABLE ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Workspace version: v1 servers: - url: https://api.pexa.co.uk description: API Gateway URL paths: /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. 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. Allowed values: [`BORROWER`, `BUYER`, `SELLER`, `OUTGOING_PROPRIETOR`, `INCOMING_PROPRIETOR`] match: type: string pattern: ^(MATCH|MISMATCH|PENDING|NOT_REQUIRED)$ example: MATCH description: > Match result between party and proprietor. Allowed values: [`MATCH`, `MISMATCH`, `PENDING`, `NOT_REQUIRED`] - MATCH: Party matches proprietor (or reconciliation completed) - MISMATCH: Party does not match proprietor - PENDING: Title has not been fetched yet - NOT_REQUIRED: Reconciliation not required (e.g., BUYER/SELLER in S&P workspaces) 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. Allowed values: [`NAME_MISMATCH`, `PROPRIETOR_NAME_CHANGE_REQUIRED`, `PARTY_NAME_UPDATED`, `TYPE_MISMATCH`, `REGISTRATION_NUMBER_MISMATCH`] - NAME_MISMATCH: Names do not match - PROPRIETOR_NAME_CHANGE_REQUIRED: Name change needed on title - PARTY_NAME_UPDATED: Party name has been updated - TYPE_MISMATCH: Party type differs from proprietor type - REGISTRATION_NUMBER_MISMATCH: Organisation registration numbers differ type: type: string pattern: ^(INDIVIDUAL|ORGANISATION)$ example: INDIVIDUAL description: | Type of party or proprietor. Allowed values: [`INDIVIDUAL`, `ORGANISATION`] 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. Allowed values: [`INDIVIDUAL`, `ORGANISATION`] 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 security: - oauth2: - x-api:view:title_reconciliation - view:workspaces - view:lodgement_proprietors components: 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 ```