Create a User Bank Income Insights Report
curl --request POST \
--url https://api.example.com/v1/users/{user_id}/income_insights/reports/import requests
url = "https://api.example.com/v1/users/{user_id}/income_insights/reports/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/users/{user_id}/income_insights/reports/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/users/{user_id}/income_insights/reports/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/income_insights/reports/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyIncome Insights
Create a User Bank Income Insights Report
Creates a bank income insights report for a specified user
POST
/
v1
/
users
/
{user_id}
/
income_insights
/
reports
/
Create a User Bank Income Insights Report
curl --request POST \
--url https://api.example.com/v1/users/{user_id}/income_insights/reports/import requests
url = "https://api.example.com/v1/users/{user_id}/income_insights/reports/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/users/{user_id}/income_insights/reports/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/users/{user_id}/income_insights/reports/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/income_insights/reports/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyOverview
This endpoint creates a bank income insights report for the user as part of the Bank Integration verification method, enabling analysis of income patterns derived from bank account data.Authentication
This endpoint requires API credentials:- ClientID (Header)
- AccessKey (Header)
Path Parameters
string
required
Unique identifier for the user.
Response
The endpoint returns a success response (HTTP 201) upon successful report creation.Error Responses
| Status Code | Error Code | Description |
|---|---|---|
| 400 | incorrect_parameters | Invalid or missing request parameters |
| 401 | authentication_failed | Authentication credentials invalid or missing |
| 403 | not_authenticated | Insufficient permissions |
Users must be authenticated and provisioned before creating reports. The report creation is asynchronous; check the report status separately for completion details.