Statement Insights Guide

This endpoint triggers and starts the process of analysing all transactions that are already linked to a connected bank account.

To initiate the endpoint, send a GET request to the following endpoint:

GET https://api.withmono.com/v2/accounts/{id}/statement/insights

Request Path Parameter

• id (required): This field expects the id of a connected bank account linked from mono connect

cURL Sample Request

curl --request GET \
  --url https://api.withmono.com/v2/accounts/{id}/statement/insights \
  --header 'mono-sec-key: string' \
  --header 'accept: application/json'

Request Headers

Include the following header in your request for authentication:

• mono-sec-key (required): Your Mono secret key.

Success Response

If the initiation request is successful, you will receive the following API response:

{
    "status": "processing",
    "message": "Statement insights is currently being processed, you will receive a webhook when insight is ready",
    "timestamp": "2024-11-19T10:34:37.535Z",
    "data": {
        "jobId": "673c69bd98d8df63d9934de8",
        "jobStatus": "processing"
    }
}

Please note that once the API request above is successful, our system generates an insight report and sends you a webhook notification confirming completion.

Tracking Job Progress with the Job ID

A unique job ID is generated to track the progress of each job through the system. This job ID, returned in the API response, serves as an identifier for the specific data processing task, enabling real-time monitoring of its status.

The initial API response includes the job ID along with the current status, such as "processing." As the job progresses, its status is updated accordingly. Users can retrieve the latest status at any time by querying the dedicated tracking endpoint here with the job ID.

Sample Webhook Response

{
    "event": "mono.events.statement_insights",
    "data": {
      "account": "67405d074b87be75af8f8358",
      "status": "available",
      "message": "Statement insights for 67405d074b87be75af8f8358 is ready",
      "action": "Make a call to the account insights endpoint to get insights"
    }
}

With the above webhook mono.events.statement_insights received, you can proceed to call the insights records endpoint to query the statement insight report at a later time in the next section.