PEXA Subscriber API

openapi: 3.2.0
info:
  title: Pexa Subscriber API
  version: '1.0'
  description: 'Operations tagged Subscriber across 2 of this provider''s published API definitions: pexa-exchange-api-legacy-swagger.json, pexa-exchange-api-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost/
tags:
- name: Subscriber
paths:
  /v1/subscriber/workgroups:
    get:
      tags:
      - Subscriber
      summary: Retrieve Workgroups
      description: "This API retrieves PEXA workgroups and workgroup user assignments.  \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip)."
      operationId: retrieveworkgroups
      parameters:
      - name: subscriberId
        in: query
        description: "The PEXA internal reference for the subscriber initiating the API service call.  \nNote: Subscriber Id is not required for any subscribers using token based authentication (OAuth, SAML etc.).  \nFor mutual SSL authentication, the Subscriber Id must be provided.  \nMaximum 19 characters"
        required: false
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /v2/subscriber:
    get:
      tags:
      - Subscriber
      summary: Search Subscriber
      description: The Subscriber API gives you the ability to search for active subscribers registered in PEXA.
      operationId: subscribersearch
      parameters:
      - name: searchSubscriberId
        in: query
        description: "Subscriber's internal PEXA identifier  \nThis must not be provided if subscriberName is also provided.  \nIf subscriberName is not provided, this field is mandatory.  \nMaximum 19 characters"
        required: true
        allowEmptyValue: false
        x-example: '208'
        schema:
          type: string
      - name: subscriberName
        in: query
        description: "Subscriber organisation name  \nThis must not be provided if searchSubscriberId is provided.  \nIf searchSubscriberId is not provided, this field is mandatory.  \nMust be at least 3 characters  \nMaximum 255 characters"
        required: true
        allowEmptyValue: false
        x-example: XYZ Bank
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._2.SubscriberSearchResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /v2/subscriber/notifications:
    get:
      tags:
      - Subscriber
      summary: Retrieves Notifications
      description: "This API retrieves a list of notifications a subscriber can access. \n \n\n[See details](../../docs/definitions/retrieve_notifications/) to learn more about this API."
      operationId: retrieveNotificationsV2UsingGET
      parameters:
      - name: categoryList
        in: query
        description: "The notification category the results will return. Each value must be separated with a comma (,) with no spaces.  \nIf not provided, PEXA will return all notification category types."
        required: false
        allowEmptyValue: false
        x-example: Document
        schema:
          type: string
      - name: lastEventId
        in: query
        description: "The PEXA internal reference for the event. This value must match the last Event Id which was provided in the previous notification response from PEXA.  \nNote: If a Last Event Id has yet to be obtained, the value must be 0.  \nIf the Last Event ID value does not correspond to the Last Event Timestamp recorded in PEXA, an exception will be returned.  \nMaximum 19 characters. "
        required: false
        allowEmptyValue: false
        x-example: '1213'
        schema:
          type: string
      - name: lastEventTimestamp
        in: query
        description: "The timestamp of the last event previously retrieved which the results will be filtered from (in UTC).  \nNote: The Last Event Timestamp is used in conjunction with the Last Event ID for retrieving notifications.  \nThe Last Event Timestamp value in the request should match the Last Event Timestamp value which was provided in the previous notification response from PEXA.  \nIf the Last Event Timestamp value does not correspond to the Last Event Id recorded in PEXA, an exception will be returned.  "
        required: false
        allowEmptyValue: false
        x-example: '2018-11-18T02:30:20.283Z'
        schema:
          type: string
      - name: maxRecords
        in: query
        description: "Used to specify the maximum number of notification records to be returned in a single service call.  \nPEXA will set an internal threshold for a maximum number of records to be returned.  \nIf the PEXA threshold is less than the max number of records provided, PEXA will return its threshold number of records (with the More Data flag set to indicate there are more notification records where applicable).  \nIf no value is provided, the PEXA threshold will be used as the default number for notification records to be received. If a value is provided, it must be greater than 0. "
        required: false
        allowEmptyValue: false
        x-example: '2'
        schema:
          type: string
      - name: severity
        in: query
        description: "The notification severity the results will return.  \nIf not provided, PEXA will return all notification severity types."
        required: false
        allowEmptyValue: false
        x-example: Error
        schema:
          type: string
      - name: subscriberId
        in: query
        description: The PEXA internal reference for the subscriber. <br> Maximum 19 characters
        required: false
        allowEmptyValue: false
        x-example: '208'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._2.RetrieveNotificationsResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /v3/subscriber/workgroups:
    get:
      tags:
      - Subscriber
      summary: Retrieve Workgroups
      description: "This API retrieves PEXA workgroups and workgroup user assignments.\n\n Scopes:\n<i>au_pub_cert_pexa_subscriber_api_v3_read</i> (non-prod)\n<i>au_pub_pexa_subscriber_api_v3_read</i> (prod)"
      operationId: retrieveworkgroups
      parameters:
      - name: subscriberId
        in: query
        description: "The PEXA internal reference for the subscriber initiating the API service call.  \nNote: Subscriber Id is optional for subscribers using token based authentication (OAuth 2.0 authorization code or client credentials flow).  \nMaximum 19 characters"
        required: false
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /v4/subscriber:
    get:
      tags:
      - Subscriber
      summary: Search Subscriber
      description: "The Subscriber API gives you the ability to search for active subscribers registered in PEXA.\n\n Scopes:\n<i>au_pub_cert_pexa_subscriber_api_v4_read</i> (non-prod)\n<i>au_pub_pexa_subscriber_api_v4_read</i> (prod)"
      operationId: subscribersearch
      parameters:
      - name: searchSubscriberId
        in: query
        description: "Subscriber's internal PEXA identifier  \nThis must not be provided if subscriberName is also provided.  \nIf subscriberName is not provided, this field is mandatory.  \nMaximum 19 characters"
        required: true
        allowEmptyValue: false
        x-example: '208'
        schema:
          type: string
      - name: subscriberName
        in: query
        description: "Subscriber organisation name  \nThis must not be provided if searchSubscriberId is provided.  \nIf searchSubscriberId is not provided, this field is mandatory.  \nMust be at least 3 characters  \nMaximum 255 characters"
        required: true
        allowEmptyValue: false
        x-example: XYZ Bank
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._2.SubscriberSearchResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /v4/subscriber/notifications:
    get:
      tags:
      - Subscriber
      summary: Retrieves Notifications
      description: "This API retrieves a list of notifications a subscriber can access. \n \n\n[See details](../../docs/definitions/retrieve_notifications/) to learn more about this API.\n\n Scopes:\n<i>au_pub_cert_pexa_subscriber_api_v4_read</i> (non-prod)\n<i>au_pub_pexa_subscriber_api_v4_read</i> (prod)"
      operationId: retrieveNotificationsV2UsingGET
      parameters:
      - name: categoryList
        in: query
        description: "The notification category the results will return. Each value must be separated with a comma (,) with no spaces.  \nIf not provided, PEXA will return all notification category types."
        required: false
        allowEmptyValue: false
        x-example: Document
        schema:
          type: string
      - name: lastEventId
        in: query
        description: "The PEXA internal reference for the event. This value must match the last Event Id which was provided in the previous notification response from PEXA.  \nNote: If a Last Event Id has yet to be obtained, the value must be 0.  \nIf the Last Event ID value does not correspond to the Last Event Timestamp recorded in PEXA, an exception will be returned.  \nMaximum 19 characters. "
        required: false
        allowEmptyValue: false
        x-example: '1213'
        schema:
          type: string
      - name: lastEventTimestamp
        in: query
        description: "The timestamp of the last event previously retrieved which the results will be filtered from (in UTC).  \nNote: The Last Event Timestamp is used in conjunction with the Last Event ID for retrieving notifications.  \nThe Last Event Timestamp value in the request should match the Last Event Timestamp value which was provided in the previous notification response from PEXA.  \nIf the Last Event Timestamp value does not correspond to the Last Event Id recorded in PEXA, an exception will be returned.  "
        required: false
        allowEmptyValue: false
        x-example: '2018-11-18T02:30:20.283Z'
        schema:
          type: string
      - name: maxRecords
        in: query
        description: "Used to specify the maximum number of notification records to be returned in a single service call.  \nPEXA will set an internal threshold for a maximum number of records to be returned.  \nIf the PEXA threshold is less than the max number of records provided, PEXA will return its threshold number of records (with the More Data flag set to indicate there are more notification records where applicable).  \nIf no value is provided, the PEXA threshold will be used as the default number for notification records to be received. If a value is provided, it must be greater than 0. "
        required: false
        allowEmptyValue: false
        x-example: '2'
        schema:
          type: string
      - name: severity
        in: query
        description: "The notification severity the results will return.  \nIf not provided, PEXA will return all notification severity types."
        required: false
        allowEmptyValue: false
        x-example: Error
        schema:
          type: string
      - name: subscriberId
        in: query
        description: The PEXA internal reference for the subscriber. &lt;br&gt; Maximum 19 characters
        required: false
        allowEmptyValue: false
        x-example: '208'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._2.RetrieveNotificationsResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    au.net.pexa.api.schema._2.NotificationDocumentDetailsType:
      type: object
      properties:
        documentType:
          type: string
          xml:
            name: DocumentType
            attribute: false
            wrapped: false
        status:
          type: string
          xml:
            name: Status
            attribute: false
            wrapped: false
        documentId:
          type: string
          example: 664
          xml:
            name: DocumentId
            attribute: false
            wrapped: false
          description: ' The PEXA internal document identifier. <br> Maximum 19 characters'
      title: au.net.pexa.api.schema._2.NotificationDocumentDetailsType
      xml:
        name: Document
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.AssignedUsers:
      type: object
      properties:
        usernames:
          type: array
          example: xyz.bank@bank.com.au
          xml:
            name: Username
            attribute: false
            wrapped: false
          description: User's email address <br> Maximum 100 characters
          items:
            type: string
      title: au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.AssignedUsers
      xml:
        name: AssignedUsers
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationDetailsType:
      type: object
      properties:
        financialLineItem:
          xml:
            name: FinancialLineItem
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationFinancialLineItemType'
        invitation:
          xml:
            name: Invitation
            attribute: false
            wrapped: false
          description: ' Notification details related to invitations.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationDetailsType'
        landTitle:
          xml:
            name: LandTitle
            attribute: false
            wrapped: false
          description: ' Notification details related to the land title references in the workspace.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationLandTitleDetailsType'
        party:
          xml:
            name: Party
            attribute: false
            wrapped: false
          description: ' Notification details related to the party details in the workspace.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationPartyDetailsType'
        document:
          xml:
            name: Document
            attribute: false
            wrapped: false
          description: ' Notification details related to the documents in the workspace.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationDocumentDetailsType'
        settlementSchedule:
          xml:
            name: SettlementSchedule
            attribute: false
            wrapped: false
          description: ' Notification details related to the settlement schedule in the workspace.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationSettlementScheduleDetailsType'
        workspaceStatus:
          type: string
          xml:
            name: WorkspaceStatus
            attribute: false
            wrapped: false
          description: ' Notification detail related to the workspace status. '
        settlement:
          xml:
            name: Settlement
            attribute: false
            wrapped: false
          description: Notification details related to settlement.
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationSettlementDetailsType'
        lodgement:
          xml:
            name: Lodgement
            attribute: false
            wrapped: false
          description: ' Notification details related to lodgement. '
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationLodgementDetailsType'
        participant:
          xml:
            name: Participant
            attribute: false
            wrapped: false
          description: ' Notification details related to participants in the workspace. '
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationParticipantDetailsType'
        conversation:
          xml:
            name: Conversation
            attribute: false
            wrapped: false
          description: ' Notification details related to conversations in the workspace. '
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationConversationDetailsType'
      title: au.net.pexa.api.schema._2.NotificationDetailsType
      xml:
        name: Details
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.PartyNameDetailsType:
      type: object
      properties:
        businessDetails:
          xml:
            name: BusinessDetails
            attribute: false
            wrapped: false
          description: ' The organisation details of the party. <br> Must be provided if the party is an organisation.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.BusinessType'
        fullName:
          xml:
            name: FullName
            attribute: false
            wrapped: false
          description: ' The structured full name of the party. <br> Must be provided if the party is an individual.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.FullNameType'
      title: au.net.pexa.api.schema._2.PartyNameDetailsType
      xml:
        name: PartyName
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationInvitationResponseDetailsType:
      type: object
      properties:
        inviteId:
          type: string
          example: 654
          xml:
            name: InviteId
            attribute: false
            wrapped: false
          description: ' The PEXA internal reference for the invitation.<br> Maximum 19 characters'
        subscriberId:
          type: string
          example: 208
          xml:
            name: SubscriberId
            attribute: false
            wrapped: false
          description: The PEXA internal reference for the subscriber who was invited to participate in the workspace. <br> For forwarded invitations, this will be the subscriber id of the subscriber who has received and actioned the forwarded invitation. <br>  Maximum 19 characters
        subscriberName:
          type: string
          example: XYZ bank
          xml:
            name: SubscriberName
            attribute: false
            wrapped: false
          description: ' The subscribers PEXA organisation name<br> Maximum 255 characters '
        workspaceRole:
          type: string
          example: Incoming Mortgagee
          xml:
            name: WorkspaceRole
            attribute: false
            wrapped: false
          description: ' The workspace role the subscriber user has been invited to participate in. '
        responseReason:
          type: string
          example: Additional documents required
          xml:
            name: ResponseReason
            attribute: false
            wrapped: false
          description: ' The subscribers response reason. '
        additionalText:
          type: string
          example: More information
          xml:
            name: AdditionalText
            attribute: false
            wrapped: false
          description: Additional text entered by the invited subscriber. <br> Must be provided if the response reason is Other. <br>  Maximum 250 characters
      title: au.net.pexa.api.schema._2.NotificationInvitationResponseDetailsType
      xml:
        name: Response
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationTypeKeyValue:
      type: object
      properties:
        key:
          type: string
          xml:
            name: Key
            attribute: false
            wrapped: false
        value:
          type: string
          xml:
            name: Value
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._2.NotificationTypeKeyValue
      xml:
        name: Type
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationFinancialLineItemType:
      type: object
      properties:
        amount:
          type: number
          xml:
            name: Amount
            attribute: false
            wrapped: false
        category:
          type: string
          xml:
            name: Category
            attribute: false
            wrapped: false
        owningSubscriberId:
          type: string
          xml:
            name: OwningSubscriberId
            attribute: false
            wrapped: false
        owningSubscriberName:
          type: string
          xml:
            name: OwningSubscriberName
            attribute: false
            wrapped: false
        type:
          type: string
          xml:
            name: Type
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._2.NotificationFinancialLineItemType
      xml:
        name: FinancialLineItem
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType:
      type: object
      properties:
        administrativeActionTimestamp:
          type: string
          format: date-time
          xml:
            name: AdministrativeActionTimestamp
            attribute: false
            wrapped: false
        administrativeActionType:
          type: string
          xml:
            name: AdministrativeActionType
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType
      xml:
        name: notificationAdministrativeActionReferenceDetailsType
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting:
      type: object
      properties:
        parties:
          type: array
          xml:
            name: Party
            attribute: false
            wrapped: false
          items:
            $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresentingPartyType'
      title: au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting
      xml:
        name: Representing
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationInvitationOutstandingDetailsType:
      type: object
      properties:
        inviteId:
          type: string
          example: 123
          xml:
            name: InviteId
            attribute: false
            wrapped: false
          description: ' The PEXA internal reference for the invitation.<br>  Maximum 19 characters'
        forwardedBy:
          type: string
          example: XYZ Bank
          xml:
            name: ForwardedBy
            attribute: false
            wrapped: false
          description: ' If the invitation has been forwarded by a panel master, this must be provided with the panel master subscribers organisation name.<br> Alternately, if the invitation has been forwarded by another subscriber (via the Forward to another Subscriber invitation response) then this will be the subscribers organisation name.  <br>  Maximum 255 characters'
        timestamp:
          type: string
          format: date-time
          example: '2018-11-18T02:30:20.283Z'
          xml:
            name: Timestamp
            attribute: false
            wrapped: false
          description: The date and time the invitation was created (in UTC).
        jurisdiction:
          type: string
          example: VIC
          xml:
            name: Jurisdiction
            attribute: false
            wrapped: false
          description: The jurisdiction of the workspace.
        workspaceRole:
          type: string
          example: Incoming Mortgagee
          xml:
            name: WorkspaceRole
            attribute: false
            wrapped: false
          description: ' The workspace role the subscriber user has been invited to participate in. '
        settlementDate:
          type: string
          format: date-time
          example: '2018-11-18T02:30:20.283Z'
          xml:
            name: SettlementDate
            attribute: false
            wrapped: false
          description: The date and time of settlement if the workspace is marked as requiring financial settlement (in UTC). Must be provided if financial settlement required unless in the scenario where a workspace has been created with a parent title and no settlement date/time has been set by the participant yet.
        expressRefinance:
          type: string
          example: 'Yes'
          xml:
            name: ExpressRefinance
            attribute: false
            wrapped: false
          description: ' A flag used to specify whether the invitation is for a workspace that is marked as an express refinance. <br> Maximum 3 characters'
        landTitleDetails:
          xml:
            name: LandTitleDetails
            attribute: false
            wrapped: false
          description: ' Provided if the land titles are not marked as parent land titles.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleType'
        partyDetails:
          xml:
            name: PartyDetails
            attribute: false
            wrapped: false
          description: ' For Principal Subscribers, this will provide the party details of all Proprietor(s) on Title and/or Incoming Proprietor(s) within the workspace at the time the invitation is sent.<br>  If land title data has not been retrieved in the workspace at the time the invitation is sent, no Proprietor on Title details will be provided.<br> Similarly, if the Proprietor on Title party is of an Indeterminate party type at the time the invitation is sent, no Proprietor on Title party details will be provided.<br> For Representative Subscribers, if available, this will provide the details of the party that the invited subscriber user will be representing upon joining the workspace.'
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyType'
        inviterSubscriberDetails:
          xml:
            name: InviterSubscriberDetails
            attribute: false
            wrapped: false
          description: Details of the subscriber who has initiated the invite
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsType'
      title: au.net.pexa.api.schema._2.NotificationInvitationOutstandingDetailsType
      xml:
        name: Outstanding
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.GivenNameOrderType:
      type: object
      properties:
        order:
          type: integer
          xml:
            name: order
            attribute: true
            wrapped: false
        value:
          type: string
      title: au.net.pexa.api.schema._2.GivenNameOrderType
      xml:
        name: GivenName
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationTitleActivityCheck:
      type: object
      properties:
        administrativeActionReferences:
          type: array
          xml:
            name: AdministrativeActionReference
            attribute: false
            wrapped: false
          items:
            $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType'
        documentReferences:
          type: array
          xml:
            name: DocumentReference
            attribute: false
            wrapped: false
          description: A document that has been lodged or registered against the Land Title in question within the period in question
          items:
            $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationDocumentReferenceDetailsType'
      title: au.net.pexa.api.schema._2.NotificationTitleActivityCheck
      xml:
        name: TitleActivityCheck
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsType:
      type: object
      properties:
        subscriberId:
          type: string
          example: 208
          xml:
            name: SubscriberId
            attribute: false
            wrapped: false
          description: ' The PEXA internal reference for the inviter subscriber. <br>Maximum 19 characters'
        subscriberType:
          type: string
          example: Financial Institution
          xml:
            name: SubscriberType
            attribute: false
            wrapped: false
          description: The type of subscriber the inviter is registered as within PEXA.
        subscriberName:
          type: string
          example: XYZ Bank
          xml:
            name: SubscriberName
            attribute: false
            wrapped: false
          description: ' The subscriber who has initiated the invite.<br> Maximum 255 characters'
        subscriberWorkspaceRole:
          type: string
          example: Incoming Mortgagee
          xml:
            name: SubscriberWorkspaceRole
            attribute: false
            wrapped: false
          description: ' The workspace role of the subscriber who has initiated the invite.<br>  If Inviter subscriber is acting in multiple roles, the primary role will be provided'
        representing:
          xml:
            name: Representing
            attribute: false
            wrapped: false
          description: Details of any party(s) the inviter subscriber is representing at the time the invitation is sent.<br> If the subscriber type of the Inviter Subscriber is Financial Institution, no representation details will be provided in the invitation. <br>  Alternatively, if the subscriber type of the Inviter Subscriber is not Financial Institution and the subscriber is not representing any party(s) at the time the invitation is sent, no representation details will be provided in the invitation.<br>If the Inviter subscriber is representing a Proprietor on Title party who is an Indeterminate party type at the time the invitation is sent, no representing party details will be provided.
          $ref: '#/components/schemas/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting'
        notes:
          type: string
          example: Additional notes
          xml:
            name: Notes
            attribute: false
            wrapped: false
          description: ' Notes entered in by the subscriber who initiated the invite.<br>  Any forwarding notes which may have been provided by the Subscriber who has forwarded the invitation will appear here.<br>May contain line feeds  Maximum 160 characters'
      tit

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/openapi/pexa-subscriber-api-openapi.yml