openapi: 3.0.1
info:
  x-metadata:
    apiId: NowInfinity Partner v1
    tags:
      - NowInfinity Partner
  title: Documents
  version: '1.0'
  description: >-
    - Retrieve summary information for a document.

    - List and download the files generated for a document.

    - Query documents under the account using OData.



    <div class="env-panel" data-component-name="EnvPanel"><div
    class="env-panel__header">Servers</div><div class="env-panel__body"><div
    class="env-row"><div class="env-name">Partner Integration Environment
    (Sandbox)</div><div class="env-url-row"><span
    class="env-url">https://partnerapi.nowinfinity-test.com.au/v1</span><button
    type="button" class="copy-btn"
    data-copy="https://partnerapi.nowinfinity-test.com.au/v1"
    aria-label="Copy"><svg viewBox="0 0 16 16" fill="none"
    xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path
    fill-rule="evenodd" clip-rule="evenodd" d="M5.16667 2.66667C5.16667 2.57462
    5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667
    2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129
    10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667
    4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667
    2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12
    11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395
    14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771
    1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391
    1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667
    4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118
    13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5
    2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5
    13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423
    2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333
    5.33333 11.8333H9.5Z" fill="currentColor"/></svg></button></div></div><div
    class="env-row"><div class="env-name">Production Environment</div><div
    class="env-url-row"><span
    class="env-url">https://partnerapi.nowinfinity.com.au/v1</span><button
    type="button" class="copy-btn"
    data-copy="https://partnerapi.nowinfinity.com.au/v1" aria-label="Copy"><svg
    viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"
    aria-hidden="true"><path fill-rule="evenodd" clip-rule="evenodd" d="M5.16667
    2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667
    2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12
    10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667
    10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5
    5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667
    11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395
    10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725
    14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5
    13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958
    2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775
    9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333
    13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199
    2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882
    5.21548C2.58007 5.18423 2.62246 5.16667 2.66667
    5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z"
    fill="currentColor"/></svg></button></div></div></div></div>
tags:
  - name: Documents
    description: |
      Documents held under the account, including their ASIC and signing status.
  - name: Document files
    description: >
      The generated files attached to a document. Files exist only once the
      document

      has been processed.
servers:
  - url: https://partnerapi.nowinfinity-test.com.au/v1
    description: Partner Integration Environment (Sandbox)
  - url: https://partnerapi.nowinfinity.com.au/v1
    description: Production Environment
paths:
  /documents/{documentId}:
    get:
      tags:
        - Documents
      summary: Document details
      description: |
        Returns summary information for the specified document.
      operationId: GetDocument
      parameters:
        - $ref: '#/components/parameters/documentIdParam'
      responses:
        '200':
          description: Success (Ok)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentInfo'
        '404':
          description: A document with the specified Id cannot be found.
      security:
        - NowInfinity_oAuth:
            - api1
  /documents/{documentId}/files:
    get:
      tags:
        - Document files
      summary: Document files
      description: |
        Returns the list of files generated for the specified document.
      operationId: GetDocumentFiles
      parameters:
        - $ref: '#/components/parameters/documentIdParam'
      responses:
        '200':
          description: Success (Ok)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentFile'
        '202':
          description: >-
            Files are still being generated for the specified document. Retry
            the request later.
        '204':
          description: >-
            Files have not been generated because the specified document is
            still in draft state.
        '404':
          description: A document with the specified Id cannot be found.
      security:
        - NowInfinity_oAuth:
            - api1
  /documents/{documentId}/files/{filename}:
    get:
      tags:
        - Document files
      summary: Document file
      description: >
        Returns a single file generated for the specified document.


        Specify `zip` as the filename to retrieve all files for the document as
        one archive.
      operationId: GetDocumentFile
      parameters:
        - $ref: '#/components/parameters/documentIdParam'
        - name: filename
          in: path
          required: true
          description: >-
            The name of the file to return, or `zip` to retrieve all files as a
            single archive.
          schema:
            type: string
          example: change-of-registered-office.pdf
      responses:
        '200':
          description: Success (Ok)
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: >-
            A document with the specified Id cannot be found, or no file with
            the specified name exists for the document.
      security:
        - NowInfinity_oAuth:
            - api1
  /documents:
    get:
      tags:
        - Documents
      summary: Documents
      description: |
        OData endpoint to query active documents under the account.
      parameters:
        - $ref: '#/components/parameters/expandParam'
        - $ref: '#/components/parameters/filterParam'
        - $ref: '#/components/parameters/selectParam'
        - $ref: '#/components/parameters/orderbyParam'
        - $ref: '#/components/parameters/topParam'
        - $ref: '#/components/parameters/skipParam'
        - $ref: '#/components/parameters/countParam'
      operationId: QueryDocuments
      responses:
        '200':
          description: Success (Ok)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentInfo'
      security:
        - NowInfinity_oAuth:
            - api1
components:
  parameters:
    documentIdParam:
      name: documentId
      in: path
      required: true
      description: Unique id of the document.
      schema:
        type: string
        format: uuid
      example: c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34
    expandParam:
      name: $expand
      in: query
      required: false
      description: Expands related entities inline.
      schema:
        type: string
      example: Trustee
    filterParam:
      name: $filter
      in: query
      required: false
      description: Filters the results, based on a Boolean condition.
      schema:
        type: string
      example: Status eq 'Active'
    selectParam:
      name: $select
      in: query
      required: false
      description: Selects which properties to include in the response.
      schema:
        type: string
      example: Name,ABN,Status
    orderbyParam:
      name: $orderby
      in: query
      required: false
      description: Sorts the results.
      schema:
        type: string
      example: CreatedDate desc
    topParam:
      name: $top
      in: query
      required: false
      description: Returns only the first n results.
      schema:
        type: integer
        format: int32
      example: 25
    skipParam:
      name: $skip
      in: query
      required: false
      description: Skips the first n results.
      schema:
        type: integer
        format: int32
      example: 0
    countParam:
      name: $count
      in: query
      required: false
      description: Includes a count of the matching results in the response.
      schema:
        type: boolean
      example: true
  schemas:
    DocumentFile:
      description: A file generated for a document.
      type: object
      properties:
        FileName:
          type: string
          example: change-of-registered-office.pdf
        CreatedOn:
          type: string
          format: date-time
          example: '2026-07-16T23:05:44Z'
        Links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    DocumentInfo:
      description: Summary information for a document held against the account.
      type: object
      properties:
        DocumentId:
          type: string
          format: uuid
          example: c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34
        DocumentName:
          type: string
          example: Change of registered office
        ReferenceNumber:
          type: string
          example: NI-484A1-004822
        AccountId:
          type: string
          format: uuid
          example: 2d81c6f0-9a34-4e57-b0c2-6f1e8d3a5b47
        ContactId:
          type: string
          format: uuid
          example: 9e5b3d81-7c26-4a09-8f14-0b7d2e6c9a58
        CreatedOn:
          type: string
          format: date-time
          example: '2026-07-14T02:31:08Z'
        LastModifiedOn:
          type: string
          format: date-time
          example: '2026-07-16T23:05:44Z'
        FormName:
          type: string
          example: ASIC Form 484
        FormTypeCode:
          type: string
          example: '484'
        DocumentStatus:
          type: string
          enum:
            - Signed
            - WaitingForSignature
            - Draft
            - AwaitingPayment
            - Processing
            - ASICRejected
            - SeeASICStatus
            - Delivered
            - ASICCorrectionRequested
            - AwaitingScorpio
          example: Delivered
        SigningStatus:
          type: string
          enum:
            - Sent
            - Rejected
            - Completed
          example: Completed
        LegalReviewStatus:
          type: string
          enum:
            - Draft
            - StrategyMeeting
            - DocumentsReview
            - ReviewMeeting
            - DocumentFinalisation
            - ClientSigning
            - Complete
            - Pending
            - InformationRequested
            - CorrectionRequested
            - PendingFinalReview
            - Cancelled
            - Approved
          example: Complete
        AsicStatus:
          type: string
          enum:
            - None
            - WaitingForSignature
            - Pending
            - Transmitted
            - Lodged
            - ValidationError
            - OnHold
            - Rejected
            - Registered
            - AdminProcessing
            - Signed
            - FutureLodgement
          example: Lodged
        AsicDocumentNumber:
          type: string
          example: 7EAB12345
        AsicTraceNumber:
          type: string
          example: '048812345678'
        RelatedCompanyId:
          type: string
          format: uuid
          example: 8f3c1b52-0d47-4a19-9c88-2ee6b7a14d90
        RelatedCompanyName:
          type: string
          example: Harbourview Holdings Pty Ltd
        RelatedTrustId:
          type: string
          format: uuid
          example: 6a0e4b73-1d58-4c92-a37f-5e8b1c0d92a6
        RelatedTrustName:
          type: string
          example: Nguyen Family Trust
        RelatedSmsfFundId:
          type: string
          format: uuid
          example: b3f7d201-8e46-4a15-9c73-2d0a6f4e8b19
        RelatedSmsfFundName:
          type: string
          example: Nguyen Family Superannuation Fund
        Links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      description: A related action or resource available for this record.
      type: object
      properties:
        Rel:
          type: string
          example: documents
        Href:
          type: string
          example: /companies/123456789/documents
        Action:
          type: string
          example: GET
        MediaType:
          type: string
          example: application/json
  securitySchemes:
    NowInfinity_oAuth:
      type: oauth2
      description: NowInfinity uses OAuth2 for authentication and authorisation.
      flows:
        implicit:
          authorizationUrl: https://auth.nowinfinity-test.com.au/connect/authorize
          scopes:
            api1: Web API access
            reporting: Reporting
