Get a financial report by jobId

get/financial-report/{jobId}

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/financial-report/{jobId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:connections

Path parameters

jobIdstring required

A unique identifier for the job

Query parameters

withPdf'1' | '0'

Should the response include a url to download the report pdf

Response

The response for getting a report

status'DONE' | 'RUNNING'

The status of the report

urlstring

A url to download the report PDF. Send only when withPdf = 1

Changes

No recorded changes to this operation across all 1 revision of this API.