BankingReport

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-banking-report-schema.json",
  "title": "BankingReport",
  "description": "Report object.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-open-banking-api-openapi.yml#/components/schemas/BankingReport",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the report object."
    },
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the user associated with the report."
    },
    "reference_id": {
      "type": "string",
      "format": "uuid",
      "deprecated": true,
      "description": "Report PDF identifier."
    },
    "generated_at": {
      "type": "string",
      "format": "date-time",
      "deprecated": true,
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested."
    },
    "type": {
      "type": "string",
      "enum": [
        "voa",
        "voi",
        "voai"
      ],
      "description": "The type of report.\n\n- `voa` - Verification of Assets\n- `voi` - Verification of Income\n- `voai` - Verification of Assets and Income\n"
    },
    "status": {
      "type": "string",
      "enum": [
        "generating",
        "generated"
      ],
      "description": "Progress of report generation.\n\n- `generating` - The report is being generated.\n- `generated` - The report is ready to download.\n"
    },
    "file_url": {
      "type": "string",
      "description": "Download link to the report PDF. Requires [Argyle authentication headers](/api-guide/overview#authentication)."
    },
    "json_url": {
      "type": "string",
      "description": "Download link to the report in JSON. Requires [Argyle authentication headers](/api-guide/overview#authentication)."
    },
    "accounts": {
      "type": "array",
      "description": "Not used in banking reports.",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "last_synced_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Not used in banking reports."
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The [`external_id`](/api-reference/users#object-external_id) of the user, otherwise `null`."
    },
    "source": {
      "type": "string",
      "description": "The source of the report data."
    },
    "metadata": {
      "type": "object",
      "description": "Additional info."
    }
  }
}