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

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

# OrganisationDetails

## 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:
    OrganisationDetails:
      type: object
      allOf:
        - type: object
          discriminator:
            propertyName: type
            mapping:
              INDIVIDUAL: "#/components/schemas/IndividualDetails"
              ORGANISATION: "#/components/schemas/OrganisationDetails"
          properties:
            role:
              type: string
              pattern: ^(BORROWER|BUYER)$
              description: >
                Party Role: Allowed values are BUYER for purchase workspace and
                BORROWER for remortgage workspace
                 * `BORROWER`
                 * `BUYER`
          required:
            - role
      required:
        - type
        - partyDetails
      properties:
        type:
          type: string
          pattern: ^(ORGANISATION)$
          description: |
            Party Type:
             * `ORGANISATION`
        addresses:
          type: array
          items:
            type: object
            description: Party address is only applicable for Purchase workspace and should
              be provided for Organisation buyer party
            required:
              - type
              - details
            properties:
              type:
                type: string
                pattern: ^(REGISTERED_ADDRESS)$
                description: |
                  Address Type:
                   * `REGISTERED_ADDRESS`
              details:
                type: object
                required:
                  - postcode
                properties:
                  name:
                    maxLength: 50
                    minLength: 0
                    type: string
                    example: 1 The House
                  number:
                    maxLength: 4
                    minLength: 0
                    type: string
                    example: 123a
                  flat:
                    maxLength: 30
                    minLength: 0
                    type: string
                    example: Flat 32
                  street:
                    maxLength: 60
                    minLength: 0
                    type: string
                    example: Huddersfield
                  town:
                    maxLength: 30
                    minLength: 0
                    type: string
                    example: West Yorkshire
                  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}))$
          maxItems: 1
        partyDetails:
          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`
```