---
title: "ReferenceDto"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77/schemas/ReferenceDto"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77.md

# ReferenceDto

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1.3.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    ReferenceDto:
      type: object
      required:
        - referenceNumber
        - representativeRole
      properties:
        referenceId:
          type: string
          format: uuid
          readOnly: true
        representativeId:
          type: string
          format: uuid
        referenceNumber:
          maxLength: 25
          minLength: 1
          type: string
          example: "123456"
        representativeRole:
          type: string
          pattern: ^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$
          example: BORROWER_REPRESENTATIVE
          description: >
            Representative role: [`BORROWER_REPRESENTATIVE`, `INCOMING_LENDER`,
            `INCOMING_LENDER_REPRESENTATIVE`, `WORKSPACE_LAW_FIRM`,
            `BUYER_REPRESENTATIVE`, `SELLER_REPRESENTATIVE`,
            `OUTGOING_PROPRIETOR_REPRESENTATIVE`] <br> Note - Representative
            role `WORKSPACE_LAW_FIRM` will be replaced with
            `INCOMING_LENDER_REPRESENTATIVE` soon
```