---
updatedAt: 2026-04-22T22:43:25.000Z
agentTools:
  projectIndex: https://developers.akahu.nz/llms.txt
---

# Get PDF Transaction Exports

Get a list of PDF transaction exports for accounts that the user has shared with your application.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Akahu One-Off REST 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"
    }
  ],
  "components": {
    "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"
      }
    },
    "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**.\n> `Basic {app_token}:{app_secret}`\n\nThis must be included in all requests to the one-off API."
      }
    },
    "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"
                }
              }
            }
          }
        }
      },
      "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"
                }
              }
            }
          }
        }
      },
      "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"
                }
              }
            }
          }
        }
      },
      "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"
                }
              }
            }
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "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"
          }
        }
      }
    }
  }
}
```