---
title: "PartyItem"
url: "https://developer.pexa.co.uk/apis/lodgement-v2-v2/versions/533c1263-195b-449f-a7da-afa5f3211cc2/schemas/PartyItem"
---

> Full API specification: https://developer.pexa.co.uk/apis/lodgement-v2-v2/versions/533c1263-195b-449f-a7da-afa5f3211cc2.md

# PartyItem

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lodgement
  version: v2
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    PartyItem:
      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: string
          pattern: ^(INCOMING_LENDER|BORROWER)$
          description: |
            Allowed values: [`INCOMING_LENDER`, `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/LodgementOrganisationPartyDetails"
              ORGANISATION: "#/components/schemas/LodgementIndividualPartyDetails"
```
