Akahu PDFs API

openapi: 3.2.0
info:
  title: Akahu One-Off REST PDFs API
  description: Retrieve a one-off snapshot of a user's account data
  version: 1.0.0
servers:
- url: https://api.oneoff.akahu.io/v1
tags:
- name: PDFs
paths:
  /pdfs/exports/{code}:
    get:
      tags:
      - PDFs
      summary: Get PDF Transaction Exports
      security:
      - app_auth: []
      parameters:
      - $ref: '#/components/parameters/Code'
      - $ref: '#/components/parameters/ContentType'
      description: Get a list of PDF transaction exports for accounts that the user has shared with your application.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PdfExport'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
      operationId: getPdfsExportsByCode
      x-operation-id-source: derived
  /pdfs/statements/{code}:
    get:
      tags:
      - PDFs
      summary: Get PDF Statements
      security:
      - app_auth: []
      parameters:
      - $ref: '#/components/parameters/Code'
      - $ref: '#/components/parameters/ContentType'
      description: Get a list of PDF statements for accounts that the user has shared with your application.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PdfStatement'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
      operationId: getPdfsStatementsByCode
      x-operation-id-source: derived
components:
  schemas:
    PdfExport:
      type: object
      properties:
        _account:
          type: string
          description: The Account ID for which this export was produced.
          example: oneoff_acc_1111111111111111111111111
        description:
          type: string
          description: If available, how this document is described by the bank.
          example: 2022-Jan-01_Personal
        meta:
          type: object
          description: Additional metadata concerning this document.
          additionalProperties: true
        period:
          type: object
          description: The period that this PDF export covers.
          properties:
            start:
              type: string
              format: date-time
              description: Formatted as an ISO 8601 timestamp.
            end:
              type: string
              format: date-time
              description: Formatted as an ISO 8601 timestamp.
        uri:
          type: string
          description: A short-lived URI that can be used to access the PDF file retrieved from the bank. Each request to this endpoint generates a new URI with a new expiry.
        expires_at:
          type: string
          description: When the PDF URI expires. Each request to this endpoint generates a new URI with a new expiry. After expiry this URI will no longer be accessible. Formatted as an ISO 8601 timestamp.
          format: date-time
    PdfStatement:
      type: object
      properties:
        _accounts:
          type: array
          description: The Account IDs described by this statement. In most cases this will only be one account, but in the case of Kiwibank, one statement is produced per account holder.
          items:
            type: string
            example: oneoff_acc_1111111111111111111111111
        description:
          type: string
          description: If available, how this document is described by the bank.
          example: 2022-Jan-01_Personal
        meta:
          type: object
          description: Additional metadata concerning this document.
          additionalProperties: true
        period:
          type: object
          description: The period that this PDF covers.
          properties:
            start:
              type: string
              format: date-time
              description: Formatted as an ISO 8601 timestamp.
            end:
              type: string
              format: date-time
              description: Formatted as an ISO 8601 timestamp.
        uri:
          type: string
          description: A short-lived URI that can be used to access the PDF file retrieved from the bank. Each request to this endpoint generates a new URI with a new expiry.
        expires_at:
          type: string
          description: When the PDF URI expires. Each request to this endpoint generates a new URI with a new expiry. After expiry this URI will no longer be accessible. Formatted as an ISO 8601 timestamp.
          format: date-time
  parameters:
    Code:
      name: code
      in: path
      required: true
      description: The one-off authorization code, provided to your application by redirection to your `redirect_uri` upon the user's successful completion of the authorization flow.
      example: id_1111111111111111111111111
      schema:
        type: string
    ContentType:
      name: Content-Type
      in: header
      schema:
        type: string
      example: application/json
  responses:
    '400':
      description: Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Invalid Content-Type
    '500':
      description: An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Something went wrong
    '403':
      description: You are not allowed to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Forbidden
    '401':
      description: You are not authorised to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Permission Denied
  securitySchemes:
    app_auth:
      type: http
      scheme: basic
      description: 'HTTP Basic Auth with the username being your **App ID Token** and the password being your **App Secret**.

        > `Basic {app_token}:{app_secret}`


        This must be included in all requests to the one-off API.'
x-provenance:
  method: searched
  source: https://developers.akahu.nz/reference
  harvested: '2026-10-26'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.akahu.nz/reference/get_accounts-code.md
  - https://developers.akahu.nz/reference/get_parties-code.md
  - https://developers.akahu.nz/reference/get_pdfs-exports-code.md
  - https://developers.akahu.nz/reference/get_pdfs-statements-code.md
  - https://developers.akahu.nz/reference/get_status-code.md
  - https://developers.akahu.nz/reference/get_transactions-code.md
  - https://developers.akahu.nz/reference/post_identity-code-verify-name.md
  merge:
    pages: 7
    deduped: 42
    conflicts_kept_first: 0