---
title: "Party"
url: "https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac/schemas/Party"
---

> Full API specification: https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac.md

# Party

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lender Instruction
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    Party:
      type: object
      discriminator:
        propertyName: type
        mapping:
          INDIVIDUAL: "#/components/schemas/IndividualParty"
          ORGANISATION: "#/components/schemas/OrganisationParty"
      properties:
        role:
          type: string
          pattern: ^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$
          description: >
            Allowed Values: [`BORROWER`, `BUYER`, `INTRODUCER`,
            `OUTGOING_LENDER`]
        addresses:
          type: array
          items:
            type: object
            required:
              - type
              - details
            properties:
              type:
                type: string
                pattern: ^(REGISTERED_ADDRESS)$
                description: |
                  Allowed values: [ `REGISTERED_ADDRESS`]
                example: REGISTERED_ADDRESS
              details:
                type: object
                required:
                  - postcode
                properties:
                  name:
                    maxLength: 50
                    minLength: 0
                    type: string
                    description: Building name
                    example: 1 The House
                  number:
                    maxLength: 4
                    minLength: 0
                    type: string
                    description: House/building number
                    example: 123a
                  flat:
                    maxLength: 30
                    minLength: 0
                    type: string
                    description: Flat/apartment number
                    example: Flat 32
                  street:
                    maxLength: 60
                    minLength: 0
                    type: string
                    description: Street name
                    example: Huddersfield
                  town:
                    maxLength: 30
                    minLength: 0
                    type: string
                    description: Town/city
                    example: West Yorkshire
                  county:
                    type: string
                    description: County name (required for OCE verification)
                    example: Greater London
                  postcode:
                    maxLength: 8
                    minLength: 6
                    type: string
                    example: M16 0RA
                    pattern: ^(([Gg][Ii][Rr]
                      0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$
                  locality:
                    type: string
                    description: Locality
                    example: Kensington
          description: Address information for the party
      required:
        - role
```