---
title: "PartyMatchInfo"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42/schemas/PartyMatchInfo"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42.md

# PartyMatchInfo

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    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.

            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
```