List Bank Statements by External ID
curl --request GET \
--url https://api.deepidv.com/v1/financial/externalId/{externalId}import requests
url = "https://api.deepidv.com/v1/financial/externalId/{externalId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.deepidv.com/v1/financial/externalId/{externalId}', 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.deepidv.com/v1/financial/externalId/{externalId}",
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.deepidv.com/v1/financial/externalId/{externalId}"
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.deepidv.com/v1/financial/externalId/{externalId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/financial/externalId/{externalId}")
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_body{
"bankStatements": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
"status": "COMPLETED",
"type": "request",
"Config": {
"period": "6"
},
"createdAt": "2026-02-15T14:30:00.000Z",
"updatedAt": "2026-02-15T15:00:00.000Z"
}
],
"nextToken": null
}
Financial
List Bank Statements by External ID
List bank statement requests by your external reference ID
GET
/
v1
/
financial
/
externalId
/
{externalId}
List Bank Statements by External ID
curl --request GET \
--url https://api.deepidv.com/v1/financial/externalId/{externalId}import requests
url = "https://api.deepidv.com/v1/financial/externalId/{externalId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.deepidv.com/v1/financial/externalId/{externalId}', 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.deepidv.com/v1/financial/externalId/{externalId}",
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.deepidv.com/v1/financial/externalId/{externalId}"
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.deepidv.com/v1/financial/externalId/{externalId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/financial/externalId/{externalId}")
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_body{
"bankStatements": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
"status": "COMPLETED",
"type": "request",
"Config": {
"period": "6"
},
"createdAt": "2026-02-15T14:30:00.000Z",
"updatedAt": "2026-02-15T15:00:00.000Z"
}
],
"nextToken": null
}
GET /v1/financial/externalId/{externalId}
Request
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
externalId | string | Yes | Your external reference ID |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
nextToken | string | No | Pagination token from a previous response |
Example request
curl -X GET "https://api.deepidv.com/v1/financial/externalId/loan-app-12345" \
-H "x-api-key: YOUR_API_KEY"
const response = await fetch(
"https://api.deepidv.com/v1/financial/externalId/loan-app-12345",
{
headers: { "x-api-key": "YOUR_API_KEY" },
}
);
const data = await response.json();
import requests
response = requests.get(
"https://api.deepidv.com/v1/financial/externalId/loan-app-12345",
headers={"x-api-key": "YOUR_API_KEY"},
)
Response
200 — Success
| Field | Type | Description |
|---|---|---|
bankStatements | array | Array of bank statement summary objects |
nextToken | string | null | Pagination token to fetch the next page. null when no more results |
Bank statement summary object
| Field | Type | Description |
|---|---|---|
id | string | Unique bank statement identifier |
organizationId | string | Organization that owns this request |
userId | string | User ID of the applicant |
senderUserId | string | User ID of the person who created the request |
status | string | PENDING, IN_PROGRESS, FLINKS_IN_PROGRESS, or COMPLETED |
type | string | request or upload |
Config | object | Request configuration (e.g. { "period": "6" }) |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last-updated timestamp |
Error responses
| Status | Description |
|---|---|
400 Bad Request | Invalid external ID or query parameters |
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Bank statements belong to a different organization |
404 Not Found | No bank statements found with the given external ID |
429 Too Many Requests | Rate limit exceeded |
{
"bankStatements": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
"status": "COMPLETED",
"type": "request",
"Config": {
"period": "6"
},
"createdAt": "2026-02-15T14:30:00.000Z",
"updatedAt": "2026-02-15T15:00:00.000Z"
}
],
"nextToken": null
}
⌘I