openapi: 3.2.0
info:
  title: Pexa Title Search API
  version: 1.0.2
  contact:
    name: PEXA Plus team
    email: pexaplussupport@pexa.com.au
  description: 'Operations tagged TitleSearch across 2 of this provider''s published API definitions: pexa-plus-marketplace-b2b-api-oas300-openapi.yaml, pexa-plus-marketplace-b2b-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://plus.pexa.com.au/api/plus/v1
  description: Product server
tags:
- name: TitleSearch
paths:
  /title-search:
    post:
      tags:
      - TitleSearch
      summary: Create title search
      description: Creates a title search given a land title reference and a jurisdiction
      operationId: createTitleSearch
      parameters:
      - $ref: '#/components/parameters/SubscriberId'
      requestBody:
        description: Create title search request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TitleSearch'
            examples:
              Create_Title_Search:
                value:
                  landTitleReference: 100/789171
                  jurisdiction: NSW
              Create_Title_Search_With_Reference:
                value:
                  landTitleReference: 100/789171
                  jurisdiction: NSW
                  reference: XYZ-APPLICATION
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TitleSearch'
              examples:
                Create_Title_Search:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    landTitleReference: 100/789171
                    jurisdiction: NSW
                Create_Title_Search_With_Reference:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    landTitleReference: 100/789171
                    jurisdiction: NSW
                    reference: XYZ-APPLICATION
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: Unauthorised
        '403':
          description: Forbidden
        '405':
          description: Method not allowed
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://plus.pexa.com.au/api/plus/v1
      description: Product server
  /title-search/{titleSearchId}:
    get:
      tags:
      - TitleSearch
      summary: Retrieve title search by id
      description: Retrieve title search related to a requested id
      operationId: retrieveTitleSearch
      parameters:
      - $ref: '#/components/parameters/SubscriberId'
      - $ref: '#/components/parameters/TitleSearchIdPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TitleSearch'
              examples:
                Non_ReadyToRetrieve_Title_Search:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    landTitleReference: 100/789171
                    jurisdiction: NSW
                    reference: XYZ-APPLICATION
                    status: PENDING
                ReadyToRetrieve_Title_Search:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    landTitleReference: 11/111
                    jurisdiction: NSW
                    reference: XYZ-APPLICATION
                    status: COMPLETE
                    landTitle:
                      orderReceivedDateTime: '2022-06-09T14:12:40.833+10:00'
                      orderCompletedDateTime: '2022-06-09T15:12:40.833+10:00'
                      enquiryId: 220609-LT0AM-0003U
                      landTitleData: {}
                      contentType: application/pdf
                      lotPlan:
                        landType: LOT
                        lotNumber: '1'
                        planNumber: '1'
                        planType: STRATA PLAN
                        text: '

                          '
                      planDetails: ''
                      relatedProducts:
                      - classification: Plan Image
                        dealingNumber: '1'
                        documentType: SP
                        itemName: '1'
                        itemType: SP
                        searchKey: '1'
                      vendorDetails:
                      - 'ESTATE: LEASEHOLD ESTATE CREATED BY REDACTED'
                      - ''
                      - ABC PTY LIMITED
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: Unauthorised
        '403':
          description: Forbidden
        '404':
          $ref: '#/components/responses/NotFoundError'
        '405':
          description: Method not allowed
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://plus.pexa.com.au/api/plus/v1
      description: Product server
  /title-search/{titleSearchId}/documents:
    get:
      tags:
      - TitleSearch
      summary: Retrieve title search documents by id
      description: Retrieve title search documents related to a requested id
      operationId: retrieveTitleSearchDocuments
      parameters:
      - $ref: '#/components/parameters/SubscriberId'
      - $ref: '#/components/parameters/TitleSearchIdPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TitleSearchDocuments'
              examples:
                Non_ReadyToRetrieve_Title_Search_Document:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    documents:
                    - status: processing
                ReadyToRetrieve_Title_Search_Document:
                  value:
                    id: d290f1ee-6c54-4b01-90e6-d701748f0851
                    documents:
                    - downloadLink: http://mock-api-server:8080/pdf/dummy.pdf
                      status: available
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: Unauthorised
        '403':
          description: Forbidden
        '404':
          $ref: '#/components/responses/NotFoundError'
        '405':
          description: Method not allowed
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://plus.pexa.com.au/api/plus/v1
      description: Product server
components:
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: '500001'
              message: An internal error has occurred
    NotFoundError:
      description: Not found error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: '404001'
              message: Invalid title search ID
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: PL.TITSE.001
              message: The land title reference provided is invalid for the jurisdiction.
              field: landTitleReference
  schemas:
    TitleSearchDocuments:
      description: Title search documents
      type: object
      properties:
        id:
          description: Identifier of the title search order
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        documents:
          description: Documents related to the title search order
          type: array
          items:
            description: Document related to the title search order
            type: object
            properties:
              downloadLink:
                description: Link to download the document related to the title search order
                type: string
                example: http://mock-api-server:8080/pdf/dummy.pdf
              status:
                description: Status of the document related to the title search order
                type: string
                example: processing
    TitleSearch:
      description: Title search
      type: object
      required:
      - landTitleReference
      - jurisdiction
      properties:
        id:
          description: Identifier of the title search order
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        landTitleReference:
          description: Land title reference
          type: string
          example: 100/789171
        jurisdiction:
          description: State of the property for the given land title reference
          type: string
          example: NSW
        reference:
          description: Matter reference
          type: string
          example: XYZ-APPLICATION
        status:
          description: Status of the title search
          type: string
          readOnly: true
          example: PENDING
        landTitle:
          description: Land Title attributes
          type: object
          properties:
            orderReceivedDateTime:
              description: Date order received at 3rd party provider
              type: string
              example: '2022-06-09T14:12:40.833+10:00'
            orderCompletedDateTime:
              description: Date order completed at 3rd party provider
              type: string
              example: '2022-06-09T15:12:40.833+10:00'
            enquiryId:
              description: ID for this enquiry with the 3rd party provider
              type: string
              example: 220609-LT0AM-0003U
            landTitleData:
              description: Json payload representing the land title data from the 3rd party provider
              type: object
            contentType:
              description: Content type
              type: string
              example: application/pdf
            lotPlan:
              description: Lot plan
              type: object
              properties:
                landType:
                  description: Land type
                  type: string
                  example: LOT
                lotNumber:
                  description: Lot number
                  type: string
                  example: '1'
                planNumber:
                  description: Plan number
                  type: string
                  example: '1'
                planType:
                  description: Plan type
                  type: string
                  example: STRATA PLAN
                text:
                  description: Text
                  type: string
                  example: \n
            planDetails:
              description: Plan details
              type: string
              example: TBC...
            relatedProducts:
              description: Related products
              type: array
              items:
                description: Related product
                type: object
                properties:
                  classification:
                    description: Classification
                    type: string
                    example: Plan Image
                  dealingNumber:
                    description: Dealing number
                    type: string
                    example: '1'
                  documentType:
                    description: Document type
                    type: string
                    example: SP
                  itemName:
                    description: Item name
                    type: string
                    example: '1'
                  itemType:
                    description: Item type
                    type: string
                    example: SP
                  searchKey:
                    description: Search key
                    type: string
                    example: '1'
            vendorDetails:
              description: Vendor details
              type: array
              items:
                description: Vendor details
                type: string
                example: 'ESTATE: LEASEHOLD ESTATE CREATED BY AA123 EXPIRES 1/2/2022'
              minItems: 1
    Error:
      description: Detailed error related to the API
      type: object
      properties:
        code:
          description: The error code
          type: string
          example: PL.TITSE.001
        message:
          description: Human-readable description of the error for debugging purposes
          type: string
          example: The land title reference provided is invalid for the jurisdiction.
        field:
          description: Name of the field provided in the original request (if any) that the error pertains to
          type: string
          example: landTitleReference
    Errors:
      description: List of errors related to the API
      type: object
      properties:
        errors:
          description: Errors returned by the service
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Error'
  parameters:
    TitleSearchIdPath:
      description: Title search id
      in: path
      name: titleSearchId
      required: true
      schema:
        type: string
        format: uuid
        example: d290f1ee-6c54-4b01-90e6-d701748f0851
    SubscriberId:
      description: Subscriber id
      in: header
      name: X-Pexa-Subscriber-ID
      required: true
      schema:
        type: integer
        example: 12345
x-refined-from:
- pexa-plus-marketplace-b2b-api-oas300-openapi.yaml
- pexa-plus-marketplace-b2b-api-openapi.yaml