Skip to main content
POST
Generate a banking report

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

type
enum<string>
required

The type of report to generate.

Available options:
voa,
voi,
voai

Body

application/json
user
string<uuid>
required

ID of the user.

webhook
string<uri>

Webhook URL to receive report-related Connect Events.

bank_accounts
string[]

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

from_date
string<date-time>

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

  • VOAI reports - controls the length of asset history
  • VOA reports - controls the length of asset history
  • VOI reports - controls the length of income history
income_from_date
string<date-time>

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

  • VOAI reports - controls the length of income history
  • Does not apply to VOA or VOI reports.
report_custom_fields
object[]

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

Maximum array length: 5
income_stream_confidence_minimum
integer

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

Only available for VOI and VOAI report types.

Required range: 0 <= x <= 100

Response

200 - application/json

Report object.

id
string<uuid>

Unique ID of the report object.

user
string<uuid>

ID of the user associated with the report.

reference_id
string<uuid>
deprecated

Report PDF identifier.

generated_at
string<date-time>
deprecated

Timestamp (ISO 8601) when the report was requested.

created_at
string<date-time>

Timestamp (ISO 8601) when the report was requested.

type
enum<string>

The type of report.

  • voa - Verification of Assets
  • voi - Verification of Income
  • voai - Verification of Assets and Income
Available options:
voa,
voi,
voai
status
enum<string>

Progress of report generation.

  • generating - The report is being generated.
  • generated - The report is ready to download.
Available options:
generating,
generated
file_url
string

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

json_url
string

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

accounts
object[]

Not used in banking reports.

last_synced_at
string<date-time> | null

Not used in banking reports.

external_id
string | null

The external_id of the user, otherwise null.

source
string

The source of the report data.

metadata
object

Additional info.