Banking Reports

Generate asset and income reports based on bank data.

Example reports:


#The report object

Attributes
  • #
    idstring (uuid)

    Unique ID of the report object.

  • #
    userstring (uuid)
    ID of the user associated with the report.
  • #
    (Deprecated) reference_idstring (uuid)

    Report PDF identifier.

  • #
    (Deprecated) generated_atstring (datetime)

    Timestamp (ISO 8601) when the report was requested.

  • #
    created_atstring (datetime)

    Timestamp (ISO 8601) when the report was requested.

  • #
    typestring (enum)

    The type of report.

  • #
    statusstring (enum)

    Progress of report generation.

  • #
    file_urlstring

    Download link to the report PDF.
    — Requires Argyle authentication headers.

  • #
    json_urlstring

    Download link to the report in JSON.
    — Requires Argyle authentication headers.

  • #
    (Not used in banking reports) accountsarray of objects
  • #
    (Not used in banking reports) last_synced_atstring (datetime)
  • #
    external_idstring

    The external_id of the user, otherwise null.

  • #
    sourcestring
    The source of the report data.
  • #
    metadataobject
    Additional info.
Example
1{
2  "id": "49c3c3e6-cc4d-43de-8f5f-c98172e392dd",
3  "user": "01975b3b-5ba6-3ec1-2148-f595b6d92614",
4  "reference_id": "49c3c3e6-cc4d-43de-8f5f-c98172e392dd",
5  "generated_at": "2025-06-10T19:22:06.000Z",
6  "created_at": "2025-06-10T19:22:06.000Z",
7  "type": "voai",
8  "status": "generating",
9  "file_url": "www.argyle.com/storagename/pdf",
10  "json_url": "www.argyle.com/storagename/json",
11  "accounts": [],
12  "last_synced_at": null,
13  "external_id": null,
14  "source": "open-banking",
15  "metadata": {
16    "origin_report_id": "tqv5hve3rm6v"
17  }
18}

#Generate a banking report

post/v2/open-banking/reports/{type}

Generates a new banking report and returns a report object.

Path parameters
  • #
    typestring (enum)
    required

    The type of report to generate.

Request body
  • #
    userstring (uuid)
    required
    ID of the user.
  • #
    webhookstring (url)
    optional

    Webhook URL to receive report-related Connect Events.

  • #
    bank_accountsarray of strings
    optional

    List of bank account IDs to be included in the report.

  • #
    from_datestring (datetime)
    optional

    Restrict report to data from on or after this datetime (ISO 8601).

  • #
    report_custom_fieldsarray of objects
    optional

    Include up to 5 custom objects in the report metadata.
    — Often used for identifying information.

  • #
    labelstring
    Custom field name.
  • #
    valuestring
    Custom field value.
  • #
    shownboolean
    Show custom field on report PDF.
  • #
    income_stream_confidence_minimuminteger
    optional

    Limit income streams used in report to those above this confidence value.
    0-100 accepted.

    Only available for VOI and VOAI report types.

Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/open-banking/reports/voai \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6          "user": "01975b3b-5ba6-3ec1-2148-f595b6d92614",
7          "webhook": "https://your-webhook-backend.com",
8          "bank_accounts": ["8057637863"],
9          "from_date": "1970-01-19T17:30:50Z",
10          "report_custom_fields": [
11            {
12              "label": "loanID",
13              "value": "12345",
14              "shown": true
15            }
16          ],
17          "income_stream_confidence_minimum": 50
18      }'
Example Response
1{
2  "id": "cde25bb1-5cf4-4544-9df8-04212a781e1b",
3  "user": "01975b3b-5ba6-3ec1-2148-f595b6d92614",
4  "reference_id": "cde25bb1-5cf4-4544-9df8-04212a781e1b",
5  "generated_at": "2025-06-10T20:39:35.000Z",
6  "created_at": "2025-06-10T20:39:35.000Z",
7  "type": "voai",
8  "status": "generating",
9  "file_url": "www.argyle.com/storagename/pdf",
10  "json_url": "www.argyle.com/storagename/json",
11  "accounts": [],
12  "last_synced_at": null,
13  "external_id": null,
14  "source": "open-banking",
15  "metadata": {
16    "origin_report_id": "5u6fx59dnw4b",
17    "bank_accounts_requested": [
18      "8057637863"
19    ],
20    "from_date": "1970-01-19T17:30:50.000Z",
21    "report_custom_fields": [
22      {
23        "label": "loanID",
24        "value": "12345",
25        "shown": true
26      }
27    ],
28    "income_stream_confidence_minimum": 50
29  }
30}
Updating Argyle status...
© 2025 Argyle Systems Inc.argyle.com