BMO Account Transaction Images API

openapi: 3.2.0
info:
  title: Image Retrieval Account Transaction Images API
  x-ibm-name: image-retrieval
  version: 4.5.0
  description: The Image Retrieval API lets you retrieve the latest images of paid and deposited cheques as well as other deposit items for the U.S. and Canada. It involves calling a summary of your accounts, which will return account IDs you can then use to search for and retrieve available images.
  x-audience: company-internal
  x-api-id: 757bb3e9-a7cc-429b-ad5b-97108158c0e6
  x-bmo-api-type: internal-api
  x-bmo-api-provider-id: 26777
  x-bmoservicedomain-name: Commercial-sb
  x-api-specification-compliant: true
  x-ibm-summary: ''
servers:
- url: https://sandbox-open-api.bmo.com/open-banking/commercial-sb
security:
- OAuth:
  - ItemImage
  x-api-key: []
tags:
- name: AccountTransactionImages
paths:
  /accounts/transaction-images-accounts:
    get:
      x-dataclassification-code: Confidential
      tags:
      - AccountTransactionImages
      summary: Search for Accounts
      description: 'Get a list of all your accounts as a starting point for more specific requests. This call will return account IDs that are set up for the "Cheque Imaging" (CA) or the "Check Imaging" (U.S.) service. '
      operationId: Search for Accounts
      parameters:
      - name: x-fapi-customer-last-logged-time
        in: header
        required: false
        description: The time when the Payment Services User last logged in with the Third Party Provider
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - name: x-api-key
        in: header
        required: false
        description: A Unique key to call service. Used as Application Catalogue Id.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        required: false
        description: An RFC 4122 UID used  to consolidate multiple requests e.g. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid. If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
        schema:
          type: string
      - name: x-client-id
        in: header
        required: false
        description: Client Id generated during Third Party Provider application registration.
        schema:
          type: string
      - name: x-fapi-customer-user-agent
        in: header
        required: false
        description: The header indicates the user-agent that the PSU is using. The API client may populate this field with the User-Agent header string if browser is being used. If the mobile app is being used then the x-fapi-customer-user-agent content must be different from browser based user-agent strings.
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        description: An Authorization Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      responses:
        '200':
          description: A valid success response and headers to be returned.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Accounts'
        '400':
          description: Bad request fault to be returned in case of validation issues.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '404':
          description: 404 to be returned when service not available or resource not found.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '500':
          description: 500 to be returned for server side errors.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '503':
          description: Server error to be returned when service is temporarily unavailable.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '504':
          description: Error to be returned when downstream systems takes longer than specified time to respond.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
  /accounts/{accountId}/transaction-images/get:
    post:
      x-dataclassification-code: Confidential
      tags:
      - AccountTransactionImages
      summary: Search for Images
      description: Get a list of available images that match your search. You can search by account number, date range, amount and item type. You can get up to 1000 results at once. Then pick the images you want to download in TIFF format.
      operationId: Search for Images
      parameters:
      - name: accountId
        in: path
        required: true
        description: a pseudonymized representation of the account number
        schema:
          type: string
      - name: x-fapi-customer-last-logged-time
        in: header
        required: false
        description: The time when the Payment Services User last logged in with the Third Party Provider
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - name: x-api-key
        in: header
        required: false
        description: A Unique key to call service. Used as Application Catalogue Id.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        required: false
        description: An RFC 4122 UID used  to consolidate multiple requests e.g. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid. If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
        schema:
          type: string
      - name: x-client-id
        in: header
        required: false
        description: Client Id generated during Third Party Provider application registration.
        schema:
          type: string
      - name: x-fapi-customer-user-agent
        in: header
        required: false
        description: The header indicates the user-agent that the PSU is using. The API client may populate this field with the User-Agent header string if browser is being used. If the mobile app is being used then the x-fapi-customer-user-agent content must be different from browser based user-agent strings.
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        description: An Authorization Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      responses:
        '200':
          description: A valid success response and headers to be returned.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/searchTransactionImageSuccessResult'
        '400':
          description: Bad request fault to be returned in case of validation issues.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '404':
          description: 404 to be returned when service not available or resource not found.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '500':
          description: 500 to be returned for server side errors.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '503':
          description: Server error to be returned when service is temporarily unavailable.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '504':
          description: Error to be returned when downstream systems takes longer than specified time to respond.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/searchTransactionImagesRequest'
        required: true
  /accounts/{accountId}/transaction-images/{imageId}:
    get:
      x-dataclassification-code: Confidential
      tags:
      - AccountTransactionImages
      summary: Retrieve Images
      description: 'Send us the index number of the cheque you want to retrieve. As per FDX standard, each API call can retrieve one cheque which includes front and back images in TIFF format. '
      operationId: Retrieve Images
      parameters:
      - name: accountId
        in: path
        required: true
        description: a pseudonymized representation of the account number
        schema:
          type: string
      - name: imageId
        in: path
        required: true
        description: an identifier used to retrieve a specific transaction image
        schema:
          type: string
      - name: x-fapi-customer-last-logged-time
        in: header
        required: false
        description: The time when the Payment Services User last logged in with the Third Party Provider
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - name: x-api-key
        in: header
        required: false
        description: A Unique key to call service. Used as Application Catalogue Id.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        required: false
        description: An RFC 4122 UID used  to consolidate multiple requests e.g. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid. If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
        schema:
          type: string
      - name: x-client-id
        in: header
        required: false
        description: Client Id generated during Third Party Provider application registration.
        schema:
          type: string
      - name: x-fapi-customer-user-agent
        in: header
        required: false
        description: The header indicates the user-agent that the PSU is using. The API client may populate this field with the User-Agent header string if browser is being used. If the mobile app is being used then the x-fapi-customer-user-agent content must be different from browser based user-agent strings.
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        description: An Authorization Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      responses:
        '200':
          description: A valid success response and headers to be returned.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTransactionImageSuccessResult'
        '400':
          description: Bad request fault to be returned in case of validation issues.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '404':
          description: 404 to be returned when service not available or resource not found.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '500':
          description: 500 to be returned for server side errors.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '503':
          description: Server error to be returned when service is temporarily unavailable.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
        '504':
          description: Error to be returned when downstream systems takes longer than specified time to respond.
          headers:
            x-request-id:
              description: An RFC 4122 UID, correlates HTTP requests between a client and server. Uniquely identifies each API call.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An RFC 4122 UID used  to consolidate multiple requests for ex. in a particular session of the customer/employee. Multiple requests  with unique  x-request-id’s might have common  x-fapi-interactionid.If the is no need to link multiple API calls then the x-fapi-interaction-id values is the same as x-request-id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/problem'
components:
  schemas:
    problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type.  When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          default: about:blank
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized); example: Service Unavailable

            '
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
    DepositTransaction:
      title: DepositTransaction Entity
      description: Deposit Transaction will have following fields in FiAttributes - Posted, Pending, ValueDate
      allOf:
      - $ref: '#/components/schemas/Transaction'
      - type: object
        properties:
          transactionType:
            $ref: '#/components/schemas/DepositTransactionType'
          payee:
            maxLength: 255
            type: string
            description: Payee name
          checkNumber:
            type: integer
            description: Check Number
    OtherSecurity:
      title: OtherSecurity Entity
      type: object
      properties:
        typeDescription:
          type: string
          description: Description of Other Security
    DepositTransactionType:
      title: DepositTransaction Type
      type: string
      description: CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL. BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT
      enum:
      - ADJUSTMENT
      - ATMDEPOSIT
      - ATMWITHDRAWAL
      - BILLPAYMENT
      - CHECK
      - DEPOSIT
      - DIRECTDEPOSIT
      - DIVIDEND
      - FEE INTEREST
      - POSCREDIT
      - POSDEBIT
      - TRANSFER
      - WITHDRAWAL
    Error:
      title: Error Entity
      type: object
      properties:
        code:
          type: string
          description: Long term persistent identifier which can be used to trace error condition back to log information
        message:
          type: string
          description: End user displayable information which might help the customer diagnose an error
      description: An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account.
    LineItem:
      title: LineItem Entity
      type: object
      properties:
        description:
          type: string
          description: The description of the line item
        amount:
          type: number
          description: The amount of money attributable to this line item
        checkNumber:
          type: integer
          description: Check number
        memo:
          maxLength: 255
          type: string
          description: Secondary item description
        reference:
          type: string
          description: A reference number
        imageIds:
          type: array
          description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
          items:
            type: string
        links:
          type: object
          properties:
            image:
              type: array
              description: Array of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt
              items:
                $ref: '#/components/schemas/HateoasLink'
    imageSearch:
      type: object
      properties:
        itemSequenceNumber:
          type: string
          description: Item sequence number
        checkNumber:
          type: string
          description: Item Check number
        serialNumber:
          type: string
          description: Item Serial number
        itemAmount:
          type: string
        itemDate:
          type: string
          description: Item date or segment date
        routingTransitNumber:
          type: string
          description: Routing transit number (RTN) associated with account number at owning institution
        itemIndicator:
          type: string
          description: Indicate the type of item image - ‘paid’, ‘deposited’, ‘deposit’
        paidDate:
          type: string
        depositedDate:
          type: string
        processedDate:
          type: string
        imageId:
          type: string
          description: Image Id
        depositedItemAccountNumber:
          type: string
          description: deposited Item Account Number
        imageSiteId:
          type: string
          description: Image site spefific document Id
    InsuranceAccount:
      title: InsuranceAccount Entity
      allOf:
      - $ref: '#/components/schemas/Account'
      - type: object
        properties:
          accountCategory:
            type: string
            enum:
            - DEPOSIT_ACCOUNT
            - INVESTMENT_ACCOUNT
            - LOAN_ACCOUNT
            - LOC_ACCOUNT
            - INSURANCE_ACCOUNT
          policyPremium:
            type: number
            description: The amount of the user's premium
          policyPremiumTerm:
            type: string
            enum:
            - MONTHLY
            - ANNUAL
          policyStartDate:
            type: string
          policyEndDate:
            type: string
          policyCoverageAmount:
            type: number
            description: Total amount of money the user is insured for
          transactions:
            type: array
            items:
              $ref: '#/components/schemas/InsuranceTransaction'
          bills:
            type: array
            items:
              $ref: '#/components/schemas/Bills'
    ContentTypes:
      title: Content Types
      type: string
      description: Types of document formats. (Suggested)
      example: application/json
      enum:
      - application/pdf
      - image/gif
      - image/jpeg
      - image/tiff
      - image/png
      - application/json
    Currency:
      title: Currency Entity
      type: object
      properties:
        currencyRate:
          type: number
          description: Currency rate between original and converted currency
        currencyCode:
          $ref: '#/components/schemas/Iso4217Code'
        originalCurrencyCode:
          $ref: '#/components/schemas/Iso4217Code'
      description: Currency information if it is different from Account entity
    InvestmentTransaction:
      title: InvestmentTransaction Entity
      description: Investment Transaction will have following fields in FiAttributes - Posted, IssueDate, MaturityDate, InterestRate, OriginalAmount, CurrentValue, Disposition
      allOf:
      - $ref: '#/components/schemas/Transaction'
      - type: object
        properties:
          transactionType:
            $ref: '#/components/schemas/InvestmentTransactionType'
          shares:
            type: number
            description: Required for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.
          faceValue:
            type: number
            description: Cash value for bonds
          price:
            type: number
            description: Unit purchase price
          securityId:
            type: string
            description: Unique identifier of security
          securityIdType:
            $ref: '#/components/schemas/SecurityIdType'
          securityType:
            $ref: '#/components/schemas/SecurityType'
          symbol:
            type: string
            description: Ticker symbol
          markup:
            type: number
            description: Portion of unit price that is attributed to the dealer markup
          commission:
            type: number
            description: Tr

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