---
title: "PartyItemV3"
url: "https://developer.pexa.co.uk/apis/lodgement-v3-v3/versions/36a70223-1b6a-4258-8121-37db0f9b4edb/schemas/PartyItemV3"
---

> Full API specification: https://developer.pexa.co.uk/apis/lodgement-v3-v3/versions/36a70223-1b6a-4258-8121-37db0f9b4edb.md

# PartyItemV3

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lodgement
  version: v3.0.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    PartyItemV3:
      type: object
      properties:
        partyId:
          type: string
          format: uuid
          readOnly: true
        type:
          type: string
          pattern: ^(INDIVIDUAL|ORGANISATION)$
          example: INDIVIDUAL
          description: |
            Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
        role:
          type: array
          items:
            type: string
            pattern: ^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$
            description: >
              Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`,
              `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]
            example: "[BORROWER]"
        partyDetails:
          type: object
          properties:
            type:
              type: string
              pattern: ^(INDIVIDUAL|ORGANISATION)$
              example: INDIVIDUAL
              description: |
                Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
          discriminator:
            propertyName: type
            mapping:
              INDIVIDUAL: "#/components/schemas/LodgementIndividualPartyDetailsV3"
              ORGANISATION: "#/components/schemas/LodgementOrganisationPartyDetailsV3"
```