{
  "opencollection": "1.0.0",
  "info": {
    "name": "PEXA Exchange API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "HealthCheck",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Health Check",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/health"
          },
          "docs": "This API verifies whether the application is up and running.\n\n Scopes:\n<i>au_pub_cert_pexa_healthcheck_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_healthcheck_api_v2_read</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Landtitle",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Land Title Registry Verification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/landRegistry/titleStatus",
            "params": [
              {
                "name": "jurisdiction",
                "value": "",
                "type": "query",
                "description": "Refer to [Jurisdiction](../../docs/guides/reference-data/#_jurisdiction_data) for valid values"
              },
              {
                "name": "landTitleReference",
                "value": "",
                "type": "query",
                "description": "Land title reference (see [Land title reference format](../../docs/resources/#_land_title_reference_format) for valid formatting)"
              }
            ]
          },
          "docs": "This API verifies whether the land title reference is 'in use' in other workspaces and whether the land title is eligible for electronic lodgement.\n\n Scopes:\n<i>au_pub_cert_pexa_landtitle_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_landtitle_api_v2_read</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Conversation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send a message to an existing conversation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/subscriber/conversation/:conversationId/message",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "role"
              }
            ]
          },
          "docs": "This API allows you to send a message to an existing conversation thread.\n\n Scopes:\n<i>au_pub_cert_pexa_conversation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieve Unread Conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/subscriber/conversations",
            "params": [
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              }
            ]
          },
          "docs": "This API retrieves a list of unread conversations.\n\n Scopes:\n<i>au_pub_cert_pexa_conversation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Mark as Read the Conversation for a specific Subscriber and Role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v2/subscriber/conversations/:conversationId/markAsRead",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "role"
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              }
            ]
          },
          "docs": "This API allows to update/mark as read the conversation for a specific conversation id, subscriber id and role.\n\n Scopes:\n<i>au_pub_cert_pexa_conversation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieve Conversations List for a Workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/:workspaceId/conversations",
            "params": [
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "role"
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "path",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API retrieves a list of conversations for a specific workspace.\n\n Scopes:\n<i>au_pub_cert_pexa_conversation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_read</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Invitation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Respond to invitation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v2/subscriber/invitation"
          },
          "docs": "This API allows a subscriber (invitee) to respond to an invitation or a subscriber (invitor) to withdraw an invitation\n\n Scopes:\n<i>au_pub_cert_pexa_invitation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieve outstanding invitations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/subscriber/invitations",
            "params": [
              {
                "name": "lastInviteId",
                "value": "",
                "type": "query",
                "description": "Last Invite Id. Field is optional. When provided, only invitations received after this invite id will be returned."
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "Subscriber Id of the entity calling the API. Field is optional."
              },
              {
                "name": "workgroupId",
                "value": "",
                "type": "query",
                "description": "Workgroup Id. Field is optional. When provided, only invitations matching the workgroup defaults will be returned. The Workgroup Id must match a workgroup that is associated to the subscriber."
              }
            ]
          },
          "docs": "This API provides details of outstanding invitations.\n\n Scopes:\n<i>au_pub_cert_pexa_invitation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Create workspace Invitation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/workspace/invitation"
          },
          "docs": "This API allows a user to create and send an invitation to another subscriber.\n\n Scopes:\n<i>au_pub_cert_pexa_invitation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_write</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Subscriber",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Workgroups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v3/subscriber/workgroups",
            "params": [
              {
                "name": "subscriberId",
                "value": "",
                "type": "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"
              }
            ]
          },
          "docs": "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)"
        },
        {
          "info": {
            "name": "Search Subscriber",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v4/subscriber",
            "params": [
              {
                "name": "searchSubscriberId",
                "value": "",
                "type": "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"
              },
              {
                "name": "subscriberName",
                "value": "",
                "type": "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"
              }
            ]
          },
          "docs": "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)"
        },
        {
          "info": {
            "name": "Retrieves Notifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v4/subscriber/notifications",
            "params": [
              {
                "name": "categoryList",
                "value": "",
                "type": "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."
              },
              {
                "name": "lastEventId",
                "value": "",
                "type": "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. "
              },
              {
                "name": "lastEventTimestamp",
                "value": "",
                "type": "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.  "
              },
              {
                "name": "maxRecords",
                "value": "",
                "type": "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. "
              },
              {
                "name": "severity",
                "value": "",
                "type": "query",
                "description": "The notification severity the results will return.  \nIf not provided, PEXA will return all notification severity types."
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "The PEXA internal reference for the subscriber. &lt;br&gt; Maximum 19 characters"
              }
            ]
          },
          "docs": "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)"
        }
      ]
    },
    {
      "info": {
        "name": "User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves user profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v3/user"
          },
          "docs": "This API will return user profile which is belong to logged in user.\n\n Scopes:\n<i>au_pub_cert_pexa_user_api_v3_read</i> (non-prod)\n<i>au_pub_pexa_user_api_v3_read</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Workspace",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Initiate Workspace Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v4/workspace"
          },
          "docs": "This API allows you to update data within a workspace.\n\n Scopes:\n<i>au_pub_cert_pexa_workspace_api_v4_write</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v4_write</i> (prod)"
        },
        {
          "info": {
            "name": "Manages Transfer Duty Data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v4/workspace/duty"
          },
          "docs": "This API allows you to add or edit stamp duty within an existing workspace that contains a transfer document.\n\n Scopes:\n<i>au_pub_cert_pexa_workspace_api_v4_write</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v4_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieves workspace summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v5/workspace",
            "params": [
              {
                "name": "lastEventId",
                "value": "",
                "type": "query",
                "description": "lastEventId"
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "subscriberRole",
                "value": "",
                "type": "query",
                "description": "subscriberRole"
              },
              {
                "name": "subset",
                "value": "",
                "type": "query",
                "description": "subset"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "query",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API provides a summary of the workspace details.\n\n Scopes:\n<i>au_pub_cert_pexa_workspace_api_v5_read</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v5_read</i> (prod)"
        },
        {
          "info": {
            "name": "Initiate Workspace Creation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v5/workspace"
          },
          "docs": "This API allows a user to create a new workspace.\n\n Scopes:\n<i>au_pub_cert_pexa_workspace_api_v5_write</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v5_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieve workspaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v6/subscriber/workspaces",
            "params": [
              {
                "name": "jurisdiction",
                "value": "",
                "type": "query",
                "description": "jurisdiction"
              },
              {
                "name": "settlementDateTime",
                "value": "",
                "type": "query",
                "description": "settlementDateTime"
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "workgroupId",
                "value": "",
                "type": "query",
                "description": "workgroupId"
              },
              {
                "name": "workspaceLastActivityFrom",
                "value": "",
                "type": "query",
                "description": "workspaceLastActivityFrom"
              },
              {
                "name": "workspaceRole",
                "value": "",
                "type": "query",
                "description": "workspaceRole"
              },
              {
                "name": "workspaceStatus",
                "value": "",
                "type": "query",
                "description": "workspaceStatus"
              }
            ]
          },
          "docs": "This API retrieves a list of the workspaces that a user can access. \n\n \n[See details](../../docs/definitions/retrieve_workspaces/) to learn more about this API.\n\n Scopes:\n<i>au_pub_cert_pexa_workspace_api_v6_read</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v6_read</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Document",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Lodged PEXA Workspace Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/documents",
            "params": [
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "subscriberRole",
                "value": "",
                "type": "query",
                "description": "subscriberRole"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "query",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API retrieves the workspace documents that have been signed and lodged by the subscriber.\n\n Scopes:\n<i>au_pub_cert_pexa_documents_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_documents_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Creates Discharge Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/workspace/documents/dischargeMortgage"
          },
          "docs": "The create discharge document API provides the ability to create a discharge document in the workspace.\n\n Scopes:\n<i>au_pub_cert_pexa_documents_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_documents_api_v2_write</i> (prod)"
        }
      ]
    },
    {
      "info": {
        "name": "Settlement",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves settlement statement",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/financial",
            "params": [
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "subscriberRole",
                "value": "",
                "type": "query",
                "description": "subscriberRole"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "query",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API retrieves the financial settlement statement containing financial line items that belong to the subscriber.\n\n Scopes:\n<i>au_pub_cert_pexa_financial_settlement_schedule_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_financial_settlement_schedule_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Upload Financial Settlement Line Items",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/workspace/financial"
          },
          "docs": "This API allows you to create a settlement schedule and add financial settlement line items to the settlement schedule.\n\n Scopes:\n<i>au_pub_cert_pexa_financial_settlement_schedule_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_financial_settlement_schedule_api_v2_write</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieves Settlement Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/settlement",
            "params": [
              {
                "name": "jurisdiction",
                "value": "",
                "type": "query",
                "description": "Used if wanting to find out the available settlement times prior to creating a workspace in a certain jurisdiction.<br/>This must not be provided if workspaceId is provided.<br/>If workspaceId is not provided, this field is mandatory."
              },
              {
                "name": "settlementDate",
                "value": "",
                "type": "query",
                "description": "All available times will be retrieved for the settlement date provided."
              },
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "The PEXA internal reference for the subscriber initiating the API service call. <br/> Maximum 19 characters"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "query",
                "description": "PEXA workspace number.<br/>Used if wanting to find out the available settlement times for an existing created workspace.<br/>This must not be provided if jurisdiction is also provided.<br/>If jurisdiction is not provided, this field is mandatory.<br/>Maximum 13 characters"
              }
            ]
          },
          "docs": "This API provides a list of settlement times for a given date.\n\n Scopes:\n<i>au_pub_cert_pexa_settlement_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Maintain Settlement Date and Time",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v2/workspace/settlement"
          },
          "docs": "This API allows you to manage the settlement date and time within a workspace.\n\n Scopes:\n<i>au_pub_cert_pexa_settlement_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_write</i> (prod)"
        },
        {
          "info": {
            "name": "Generate the Settlement Completion Record",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/settlementCompletionRecord",
            "params": [
              {
                "name": "subscriberId",
                "value": "",
                "type": "query",
                "description": "subscriberId"
              },
              {
                "name": "subscriberRole",
                "value": "",
                "type": "query",
                "description": "subscriberRole"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "query",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API generates the settlement completion record for a completed workspace.\n\n \n [See details](../../docs/definitions/retrieve_settlement_completion_record/) to learn more about this API.\n\n Scopes:\n<i>au_pub_cert_pexa_settlementcompletionrecord_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlementcompletionrecord_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Retrieve Balance due to effect Settlement",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/workspace/:workspaceId/settlement/balanceDueToEffectSettlement",
            "params": [
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "role"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "path",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API allows you to retrieve the balance amount due to the vendor that is likely to effect the settlement.  \n\n Scopes:\n<i>au_pub_cert_pexa_settlement_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_read</i> (prod)"
        },
        {
          "info": {
            "name": "Add/Update/Agree Balance due to effect Settlement",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v2/workspace/:workspaceId/settlement/balanceDueToEffectSettlement",
            "params": [
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "role"
              },
              {
                "name": "workspaceId",
                "value": "",
                "type": "path",
                "description": "workspaceId"
              }
            ]
          },
          "docs": "This API allows you to set the balance amount due to the vendor that is likely to effect the settlement.  \n\n \n[See details](../../docs/definitions/set_balanceduetoeffect_settlement/) to learn more about this API.\n\n Scopes:\n<i>au_pub_cert_pexa_settlement_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_write</i> (prod)"
        }
      ]
    }
  ],
  "bundled": true
}