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

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

# schemas-PartyDto

## 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:
    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`]
        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`]
        type:
          type: string
          pattern: ^(INDIVIDUAL|ORGANISATION)$
          example: INDIVIDUAL
          description: |
            Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
        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:
                     * `LIMITED_COMPANY`
        representationType:
          type: string
          pattern: ^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$
          example: NO_REPRESENTATION
          description: >
            Allowed values: [`NO_REPRESENTATION`, `DUAL_REPRESENTATION`,
            `SEPARATE_REPRESENTATION`]
        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`]
```