Retrieve a User Bank Income Insights Report
curl --request GET \
--url https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/import requests
url = "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyIncome Insights
Retrieve a User Bank Income Insights Report
Retrieves a bank income insights report for a specific user
GET
/
v1
/
users
/
{user_id}
/
income_insights
/
reports
/
{report_id}
/
Retrieve a User Bank Income Insights Report
curl --request GET \
--url https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/import requests
url = "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/income_insights/reports/{report_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyOverview
This endpoint retrieves a bank income insights report for a specific user as part of the Bank Integration verification method. The report provides analyzed financial data based on bank account information.Authentication
This endpoint requires API credentials:- ClientID (Header)
- AccessKey (Header)
Path Parameters
string
required
The unique identifier for the user.
string
required
The unique identifier for the specific report.
Response
The endpoint returns report data in JSON format containing analyzed income insights from connected bank accounts.Error Responses
| Status Code | Description |
|---|---|
| 401 | Unauthorized - Authentication failed or invalid token |
| 403 | Forbidden - User is not authenticated or lacks permissions |
| 404 | Not Found - The specified user or report does not exist |