import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().syncTransactions("11111111-2222-3333-4444-555555555555");
System.out.println(result);
<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->syncTransactions('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.SyncTransactionsAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().syncTransactions("11111111-2222-3333-4444-555555555555");
System.out.println(result);
<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->syncTransactions('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.SyncTransactionsAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));
Didit’s Sync Transactions endpoint returns what changed in a connection’s transactions since a cursor: added, modified and removed.
An empty cursor returns everything with reset: true.
Store next_cursor only after a response with has_more: false.
See Continuous bank feed for accounting.
Authorizations
x-api-key
string
header
required
Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.
Path Parameters
id
string<uuid>
required
The connection id.
Query Parameters
cursor
string
The next_cursor you stored. Empty or omitted starts from the beginning.
limit
integer
default:100
Page size, 1 to 500. Default 100.
Required range: 1 <= x <= 500
page_token
string
Continues the same read while has_more is true.
Response
A page of changes.
Changes of a connection's transactions since a cursor. An empty cursor returns every current transaction as added. All pages of one read reflect the same snapshot; changes that arrive meanwhile come in the next read.
added
object[]
required
Transactions to add. On a first read (no cursor, or after reset) this is every transaction the connection had when the read started, each exactly once and in its current state, even if a sync runs while you page. In later reads it holds the transactions that are new since your cursor, and the booked transaction that replaces a pending one.
Show child attributes
modified
object[]
required
Transactions that changed since your cursor, in their current state. Apply each as an upsert by id: a transaction you already received while paging the first read comes again here if it changed meanwhile, and a bank correction arrives here too.
Show child attributes
removed
object[]
required
Transactions that no longer exist, with a reason. Ignore an id you do not have: a transaction that was removed while you paged a first read was still delivered once as added and arrives here in the next read.
Show child attributes
has_more
boolean
required
true while there are more pages. Store next_cursor only after a response with has_more: false; if paging fails midway, restart from the cursor you had stored.
next_page_token
string | null
required
Continues this read while has_more is true.
next_cursor
string | null
required
The durable checkpoint of the feed, returned only on the last page. Opaque and bound to the application, environment and connection. Replayable for 90 days. On a first read it marks the moment the read started, so what changed meanwhile arrives in the next read.
reset
boolean
required
true on every bootstrap, which is every read from an empty cursor: replace your copy with the result instead of adding to it.
Last modified on November 22, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Didit Docs","description":"The best way to integrate identity and fraud checks into your app. One API, four product lines (KYC · KYB · Transaction Monitoring · Wallet Screening), 220+ countries, 14,000+ documents, sub-2s inference, $10 free credit/month.","colors":{"primary":"#2567FF","light":"#90B1FF","dark":"#1B4FE0"},"logo":{"light":"https://mintcdn.com/didit-0f962782/dCzNNoYCusBNdK3I/logo/didit.svg?fit=max\u0026auto=format\u0026n=dCzNNoYCusBNdK3I\u0026q=85\u0026s=9f162fb8295fa1fd9300a24b293ce0b7","dark":"https://mintcdn.com/didit-0f962782/TefoKXCbZA_GIK5a/logo/didit-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=TefoKXCbZA_GIK5a\u0026q=85\u0026s=c8c541689c814ca6a2c873cf6185a3a7","href":"https://docs.didit.me"},"favicon":"https://mintcdn.com/didit-0f962782/t6r0B-WdGMU5mSS-/favicon.ico?fit=max\u0026auto=format\u0026n=t6r0B-WdGMU5mSS-\u0026q=85\u0026s=b291917b960ebe959ae3b1aa233eafa8","api":{"examples":{"prefill":true},"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://verification.didit.me"}},"background":{"color":{"light":"#FFFFFF","dark":"#1A1A1A"}},"navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Sign in","href":"https://business.didit.me"}},"footer":{"socials":{"x":"https://x.com/didit","github":"https://github.com/didit-protocol","linkedin":"https://linkedin.com/company/91001155","website":"https://didit.me"}},"search":{"prompt":"Search Didit docs..."},"seo":{"metatags":{"twitter:site":"@didit","theme-color":"#2567FF","apple-mobile-web-app-title":"Didit Docs"},"organization":{"id":"https://didit.me/#organization","name":"Didit","legalName":"Didit Protocol","url":"https://didit.me","logo":"https://didit.me/logos/primary-horizontal-light.png","sameAs":["https://www.linkedin.com/company/91001155","https://www.youtube.com/@getdidit","https://github.com/didit-protocol","https://x.com/didit"]},"indexing":"navigable"},"fonts":{"heading":{"family":"Inter","weight":500},"body":{"family":"Inter","weight":400}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"This page moved or never existed. [Back to docs](/)"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"light","background":"https://mintcdn.com/didit-0f962782/Xkecx-xLq1K2abHK/images/og-thumbnail-backplate.png?fit=max\u0026auto=format\u0026n=Xkecx-xLq1K2abHK\u0026q=85\u0026s=c699fa252554b2ac8d4c631e209a1473","fonts":{"family":"Inter"}},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":""},{"language":"es","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Soporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sesión","href":"https://business.didit.me"}},"href":"es"},{"language":"pt-BR","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Entrar","href":"https://business.didit.me"}},"href":"pt-br"},{"language":"ja","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"サポート"},{"icon":"signal","href":"https://status.didit.me","label":"ステータス"}],"primary":{"type":"button","label":"サインイン","href":"https://business.didit.me"}},"href":"ja"},{"language":"de","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Anmelden","href":"https://business.didit.me"}},"href":"de"},{"language":"fr","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Assistance"},{"icon":"signal","href":"https://status.didit.me","label":"Statut"}],"primary":{"type":"button","label":"Se connecter","href":"https://business.didit.me"}},"href":"fr"},{"language":"it","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Supporto"},{"icon":"signal","href":"https://status.didit.me","label":"Stato"}],"primary":{"type":"button","label":"Accedi","href":"https://business.didit.me"}},"href":"it"},{"language":"pt","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sessão","href":"https://business.didit.me"}},"href":"pt"},{"language":"ca","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suport"},{"icon":"signal","href":"https://status.didit.me","label":"Estat"}],"primary":{"type":"button","label":"Inicia la sessió","href":"https://business.didit.me"}},"href":"ca"},{"language":"id","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Dukungan"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Masuk","href":"https://business.didit.me"}},"href":"id"},{"language":"ru","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Поддержка"},{"icon":"signal","href":"https://status.didit.me","label":"Статус"}],"primary":{"type":"button","label":"Вход","href":"https://business.didit.me"}},"href":"ru"},{"language":"ko","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"지원"},{"icon":"signal","href":"https://status.didit.me","label":"상태"}],"primary":{"type":"button","label":"로그인","href":"https://business.didit.me"}},"href":"ko"},{"language":"zh","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"支持"},{"icon":"signal","href":"https://status.didit.me","label":"状态"}],"primary":{"type":"button","label":"登录","href":"https://business.didit.me"}},"href":"zh"},{"language":"ar","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"الدعم"},{"icon":"signal","href":"https://status.didit.me","label":"الحالة"}],"primary":{"type":"button","label":"تسجيل الدخول","href":"https://business.didit.me"}},"href":"ar"},{"language":"hi","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"सहायता"},{"icon":"signal","href":"https://status.didit.me","label":"स्थिति"}],"primary":{"type":"button","label":"साइन इन करें","href":"https://business.didit.me"}},"href":"hi"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"didit-0f962782","hasAudioNarration":false,"actualSubdomain":"didit-0f962782","customDomains":["docs.didit.me"],"gitSource":{"type":"github","owner":"didit-protocol","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b03560b429c2eb6eb1ae558","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"ar","tag":"مرجع API","count":450},{"language":"ca","tag":"Referència de l'API","count":450},{"language":"de","tag":"API-Referenz","count":450},{"language":"es","tag":"Referencia de la API","count":450},{"language":"fr","tag":"Référence API","count":450},{"language":"hi","tag":"API संदर्भ","count":450},{"language":"id","tag":"Referensi API","count":450},{"language":"it","tag":"Riferimento API","count":450},{"language":"ja","tag":"APIリファレンス","count":450},{"language":"ko","tag":"API 레퍼런스","count":450},{"language":"pt-BR","tag":"Referência da API","count":450},{"language":"pt","tag":"Referência da API","count":450},{"language":"ru","tag":"Справочник API","count":450},{"language":"zh","tag":"API 参考","count":450},{"language":"en","tag":"API Reference","count":442},{"language":"en","tag":"Database Validation","count":118},{"language":"ar","tag":"التحقق من قواعد البيانات","count":118},{"language":"ca","tag":"Validació en bases de dades","count":118},{"language":"de","tag":"Datenbankvalidierung","count":118},{"language":"es","tag":"Validación de base de datos","count":118},{"language":"fr","tag":"Validation en base de données","count":118},{"language":"hi","tag":"डेटाबेस सत्यापन","count":118},{"language":"id","tag":"Validasi Database","count":118},{"language":"it","tag":"Validazione su database","count":118},{"language":"ja","tag":"データベース検証","count":118},{"language":"ko","tag":"데이터베이스 검증","count":118},{"language":"pt-BR","tag":"Validação de banco de dados","count":118},{"language":"pt","tag":"Validação de base de dados","count":118},{"language":"ru","tag":"Проверка по базам данных","count":118},{"language":"zh","tag":"数据库核验","count":118},{"language":"ko","tag":"인증","count":106},{"language":"ca","tag":"Primers passos","count":103},{"language":"de","tag":"Erste Schritte","count":103},{"language":"es","tag":"Primeros pasos","count":103},{"language":"ja","tag":"はじめに","count":103},{"language":"ko","tag":"시작하기","count":103},{"language":"pt-BR","tag":"Primeiros passos","count":103},{"language":"ru","tag":"Начало работы","count":103},{"language":"en","tag":"Get Started","count":87},{"language":"en","tag":"User Verification","count":87},{"language":"ar","tag":"ابدأ الآن","count":87},{"language":"ar","tag":"التحقق من المستخدمين","count":87},{"language":"ca","tag":"Verificació d'usuaris","count":87},{"language":"de","tag":"Benutzerverifizierung","count":87},{"language":"es","tag":"Verificación de usuarios","count":87},{"language":"fr","tag":"Commencer","count":87},{"language":"fr","tag":"Vérification des utilisateurs","count":87},{"language":"hi","tag":"शुरू करें","count":87},{"language":"hi","tag":"उपयोगकर्ता सत्यापन","count":87},{"language":"id","tag":"Mulai","count":87},{"language":"id","tag":"Verifikasi Pengguna","count":87},{"language":"it","tag":"Inizia","count":87},{"language":"it","tag":"Verifica degli utenti","count":87},{"language":"ja","tag":"ユーザー認証","count":87},{"language":"ko","tag":"사용자 인증","count":87},{"language":"pt-BR","tag":"Verificação de usuários","count":87},{"language":"pt","tag":"Começar","count":87},{"language":"pt","tag":"Verificação de utilizadores","count":87},{"language":"ru","tag":"Проверка пользователей","count":87},{"language":"zh","tag":"快速开始","count":87},{"language":"zh","tag":"用户验证","count":87},{"language":"en","tag":"Verification","count":61},{"language":"ar","tag":"التحقق","count":61},{"language":"ca","tag":"Verificació","count":61},{"language":"de","tag":"Verifizierung","count":61},{"language":"es","tag":"Verificación","count":61},{"language":"fr","tag":"Vérification","count":61},{"language":"hi","tag":"सत्यापन","count":61},{"language":"id","tag":"Verifikasi","count":61},{"language":"it","tag":"Verifica","count":61},{"language":"ja","tag":"検証","count":61},{"language":"pt-BR","tag":"Verificação","count":61},{"language":"pt","tag":"Verificação","count":61},{"language":"ru","tag":"Верификация","count":61},{"language":"zh","tag":"验证","count":61},{"language":"en","tag":"Travel Rule","count":58},{"language":"ar","tag":"Travel Rule","count":58},{"language":"ca","tag":"Travel Rule","count":58},{"language":"de","tag":"Travel Rule","count":58},{"language":"es","tag":"Travel Rule","count":58},{"language":"fr","tag":"Travel Rule","count":58},{"language":"hi","tag":"Travel Rule","count":58},{"language":"id","tag":"Travel Rule","count":58},{"language":"it","tag":"Travel Rule","count":58},{"language":"ja","tag":"トラベルルール","count":58},{"language":"ko","tag":"Travel Rule","count":58},{"language":"pt-BR","tag":"Travel Rule","count":58},{"language":"pt","tag":"Travel Rule","count":58},{"language":"ru","tag":"Travel Rule","count":58},{"language":"zh","tag":"Travel Rule","count":58},{"language":"en","tag":"Integrate / SDKs","count":49},{"language":"ar","tag":"التكامل / SDKs","count":49},{"language":"ca","tag":"Integració / SDK","count":49},{"language":"de","tag":"Integrieren / SDKs","count":49},{"language":"es","tag":"Integración / SDKs","count":49},{"language":"fr","tag":"Intégrer / SDK","count":49},{"language":"hi","tag":"इंटीग्रेट करें / SDK","count":49},{"language":"id","tag":"Integrasi / SDK","count":49},{"language":"it","tag":"Integrazione / SDK","count":49},{"language":"ja","tag":"連携 / SDK","count":49},{"language":"ko","tag":"연동 / SDK","count":49},{"language":"pt-BR","tag":"Integração / SDKs","count":49},{"language":"pt","tag":"Integrar / SDKs","count":49},{"language":"ru","tag":"Интеграция / SDK","count":49},{"language":"zh","tag":"集成 / SDK","count":49},{"language":"en","tag":"Authentication","count":45},{"language":"ar","tag":"المصادقة","count":45},{"language":"ca","tag":"Autenticació","count":45},{"language":"de","tag":"Authentifizierung","count":45},{"language":"es","tag":"Autenticación","count":45},{"language":"fr","tag":"Authentification","count":45},{"language":"hi","tag":"प्रमाणीकरण","count":45},{"language":"id","tag":"Autentikasi","count":45},{"language":"it","tag":"Autenticazione","count":45},{"language":"ja","tag":"認証","count":45},{"language":"pt-BR","tag":"Autenticação","count":45},{"language":"pt","tag":"Autenticação","count":45},{"language":"ru","tag":"Аутентификация","count":45},{"language":"zh","tag":"身份认证","count":45},{"language":"pt-BR","tag":"Recursos","count":38},{"language":"en","tag":"Bank Verification","count":37},{"language":"ar","tag":"التحقق من الحساب البنكي","count":37},{"language":"ca","tag":"Verificació bancària","count":37},{"language":"de","tag":"Bankverifizierung","count":37},{"language":"es","tag":"Verificación bancaria","count":37},{"language":"fr","tag":"Vérification bancaire","count":37},{"language":"hi","tag":"बैंक सत्यापन","count":37},{"language":"id","tag":"Verifikasi Bank","count":37},{"language":"it","tag":"Verifica bancaria","count":37},{"language":"ja","tag":"銀行口座認証","count":37},{"language":"ko","tag":"은행 계좌 인증","count":37},{"language":"pt-BR","tag":"Verificação bancária","count":37},{"language":"pt","tag":"Verificação bancária","count":37},{"language":"ru","tag":"Проверка банковского счёта","count":37},{"language":"zh","tag":"银行验证","count":37},{"language":"en","tag":"Digital ID wallets","count":35},{"language":"ar","tag":"محافظ الهوية الرقمية","count":35},{"language":"ca","tag":"Carteres d'identitat digital","count":35},{"language":"de","tag":"Digitale ID-Wallets","count":35},{"language":"es","tag":"Wallets de identidad digital","count":35},{"language":"fr","tag":"Portefeuilles d'identité numérique","count":35},{"language":"hi","tag":"डिजिटल ID वॉलेट","count":35},{"language":"id","tag":"Dompet ID Digital","count":35},{"language":"it","tag":"Wallet di identità digitale","count":35},{"language":"ja","tag":"デジタルIDウォレット","count":35},{"language":"ko","tag":"디지털 신분증 지갑","count":35},{"language":"ko","tag":"사용자 인증 및 기업 확인","count":35},{"language":"pt","tag":"Carteiras de identidade digital","count":35},{"language":"ru","tag":"Цифровые ID-кошельки","count":35},{"language":"zh","tag":"数字身份钱包","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"update-worker-routing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/didit-0f962782/714dd91730ddd114/style.css"}]}
{"page":{"pagePath":"standalone-apis/bank-transactions-sync","slug":"/standalone-apis/bank-transactions-sync","pageMetadata":{"title":"Bank Transactions Change Feed API: Added, Modified, Removed","sidebarTitle":"Transactions change feed","keywords":["bank transactions change feed api","sync transactions (change feed)","bank data API","open banking API","Didit"],"description":"Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.","openapi":"openapi-25.json GET /v3/bank/connections/{id}/transactions/sync/","href":"/standalone-apis/bank-transactions-sync"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Didit’s Sync Transactions endpoint returns what changed in a connection’s transactions since a cursor: added, modified and removed.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Didit’s Sync Transactions endpoint returns what changed in a connection’s transactions since a cursor: `,_jsx(_components.code,{children:`added`}),`, `,_jsx(_components.code,{children:`modified`}),` and `,_jsx(_components.code,{children:`removed`}),`.\nAn empty cursor returns everything with `,_jsx(_components.code,{children:`reset: true`}),`.\nStore `,_jsx(_components.code,{children:`next_cursor`}),` only after a response with `,_jsx(_components.code,{children:`has_more: false`}),`.\nSee `,_jsx(_components.a,{href:`/use-cases/bank-data-for-accounting`,children:`Continuous bank feed for accounting`}),`.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Bank Transactions Change Feed API: Added, Modified, Removed","sidebarTitle":"Transactions change feed","keywords":["bank transactions change feed api","sync transactions (change feed)","bank data API","open banking API","Didit"],"description":"Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.","openapi":"openapi-25.json GET /v3/bank/connections/{id}/transactions/sync/","href":"/standalone-apis/bank-transactions-sync"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/didit-0f962782/c0e2b20b5285ec45/snippets/data/database-validation-coverage.js","/_mintlify/custom/didit-0f962782/4ac7d3c2a19a354d/database-validation-playground.js"],"openApiReferenceData":{"operation":{"summary":"Sync transactions (change feed)","description":"Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.","operationId":"syncBankTransactions","tags":["Bank Data"],"x-didit-sdk":{"resource":"bank","method":"sync_transactions","auth":"api_key","server":true},"security":["e8342fc8-ee58-4990-9dd1-ff01f6cad823"],"parameters":["fec78dbc-7ba2-4edf-8e9d-b484ad0633d1","664e49fd-717b-4b9d-acda-262b66275dae","8844ab4d-10ce-465b-9e57-16dcdf906717","f9f4aa9c-982f-4d60-b967-6ff98c742e60"],"responses":{"200":"e6f23ea9-a33a-48cc-a8e7-f1d72486f40e","400":"0ca6c595-2a5a-4c86-9214-947aa676dd7a","401":"5aa00d48-1fa7-43ef-9d81-f3570acbd440","403":"2ca73bb6-6656-4065-b48d-86c6366233e9","404":"45d11060-cf77-4747-a63c-86b2c134c99a","409":"46d8537f-7d6f-46ff-8e21-6debc2962a21","410":"b057d3be-9062-4548-9bdf-ac96f51973ca","429":"eaa89b92-ded6-47a0-8d9a-fc35fecbecdc","500":"56e6dc26-049b-4c9a-81ff-37d8ecf14e3a"},"x-codeSamples":[{"lang":"curl","label":"curl","source":"curl 'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/transactions/sync/?cursor=cur_01HZX9K4M2W7B3T8' \\\n -H 'x-api-key: YOUR_API_KEY'"},{"lang":"python","label":"Python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.bank.sync_transactions(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)"},{"lang":"javascript","label":"Node.js","source":"import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.bank.syncTransactions(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);"},{"lang":"go","label":"Go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.SyncTransactions(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankSyncTransactionsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"lang":"java","label":"Java","source":"import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.bank().syncTransactions(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);"},{"lang":"php","label":"PHP","source":"\u003c?php\n\nrequire 'vendor/autoload.php';\n\nuse Didit\\DiditClient;\n\n// Reads DIDIT_API_KEY.\n$didit = new DiditClient();\n\n$result = $didit->bank->syncTransactions('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());"},{"lang":"ruby","label":"Ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.bank.sync_transactions(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h"},{"lang":"csharp","label":".NET","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Bank.SyncTransactionsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"method":"get","type":"path","servers":["7f67315f-7c19-4348-bb1c-4fa317815f70"],"path":"/v3/bank/connections/{id}/transactions/sync/","baseUrlOptions":["https://verification.didit.me"],"title":"Sync transactions (change feed)","codeSamples":[{"label":"curl","lang":"curl","source":"curl 'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/transactions/sync/?cursor=cur_01HZX9K4M2W7B3T8' \\\n -H 'x-api-key: YOUR_API_KEY'"},{"label":"Python","lang":"python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.bank.sync_transactions(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)"},{"label":"Node.js","lang":"javascript","source":"import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.bank.syncTransactions(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);"},{"label":"Go","lang":"go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.SyncTransactions(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankSyncTransactionsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"label":"Java","lang":"java","source":"import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.bank().syncTransactions(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);"},{"label":"PHP","lang":"php","source":"\u003c?php\n\nrequire 'vendor/autoload.php';\n\nuse Didit\\DiditClient;\n\n// Reads DIDIT_API_KEY.\n$didit = new DiditClient();\n\n$result = $didit->bank->syncTransactions('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());"},{"label":"Ruby","lang":"ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.bank.sync_transactions(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h"},{"label":".NET","lang":"csharp","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Bank.SyncTransactionsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"fec78dbc-7ba2-4edf-8e9d-b484ad0633d1":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The connection id.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"The connection id."},"664e49fd-717b-4b9d-acda-262b66275dae":{"name":"cursor","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"The `next_cursor` you stored. Empty or omitted starts from the beginning.","uniqueKey":"","typeLabel":"string"},"description":"The `next_cursor` you stored. Empty or omitted starts from the beginning."},"8844ab4d-10ce-465b-9e57-16dcdf906717":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":500,"isRequired":false,"description":"Page size, 1 to 500. Default 100.","uniqueKey":"","typeLabel":"integer"},"description":"Page size, 1 to 500. Default 100."},"f9f4aa9c-982f-4d60-b967-6ff98c742e60":{"name":"page_token","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Continues the same read while `has_more` is `true`.","uniqueKey":"","typeLabel":"string"},"description":"Continues the same read while `has_more` is `true`."}},"responses":{"e6f23ea9-a33a-48cc-a8e7-f1d72486f40e":{"description":"A page of changes.","content":{"application/json":{"schema":{"type":"object","description":"Changes of a connection's transactions since a cursor. An empty cursor returns every current transaction as `added`. All pages of one read reflect the same snapshot; changes that arrive meanwhile come in the next read.","properties":{"added":{"type":"array","items":{"type":"object","description":"One movement of an account. Any field the bank does not send is `null`; the institution capabilities list which fields a bank is known to send.","properties":{"id":{"type":"string","description":"Didit's id, opaque and stored at first sight. The same movement keeps its id across reads, syncs and renewals. `identity_quality` says how strong that guarantee is.","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"account_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["booked","pending"],"description":"A pending transaction has its own id. When the bank books it, the booked transaction carries `pending_id` where the bank links them, and the pending one appears in `removed` with `reason: pending_booked`.","isRequired":true,"uniqueKey":"added.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"pending_id":{"oneOf":[{"type":"string","description":"The pending transaction this one replaced. Set only when the bank links them, never guessed.","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].pending_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The pending transaction this one replaced. Set only when the bank links them, never guessed.","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].pending_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].pending_id","typeLabel":"string\u003cuuid> | null"},"reverses_id":{"oneOf":[{"type":"string","description":"The transaction this one reverses, when the bank links them. A reversal is a new transaction.","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].reverses_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The transaction this one reverses, when the bank links them. A reversal is a new transaction.","format":"uuid","isRequired":true,"uniqueKey":"added.items.[INDEX].reverses_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].reverses_id","typeLabel":"string\u003cuuid> | null"},"booking_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].booking_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].booking_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].booking_date","typeLabel":"string\u003cdate> | null"},"value_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].value_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].value_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].value_date","typeLabel":"string\u003cdate> | null"},"transaction_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].transaction_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].transaction_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].transaction_date","typeLabel":"string\u003cdate> | null"},"effective_date":{"type":"string","description":"The date the date filters use, as the bank reports it in its own time zone with nothing converted: for a booked transaction its booking date, else its value date, else the date it was first seen; for a pending one its transaction date, else the date it was first seen.","format":"date","isRequired":true,"uniqueKey":"added.items.[INDEX].effective_date","typeLabel":"string\u003cdate>"},"amount":{"type":"string","description":"Signed amount as a decimal string. Negative is money out.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"added.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code.","isRequired":true,"uniqueKey":"added.items.[INDEX].currency","typeLabel":"string"},"direction":{"type":"string","enum":["credit","debit"],"description":"Repeats the sign of `amount`.","isRequired":true,"uniqueKey":"added.items.[INDEX].direction","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].description","typeLabel":"string | null"},"counterparty":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.name","typeLabel":"string | null"},"iban":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.iban.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.iban.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.iban","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.bic.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.bic.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty.bic","typeLabel":"string | null"}},"required":["name","iban","bic"],"isRequired":true,"uniqueKey":"added.items.[INDEX].counterparty","typeLabel":"object"},"remittance":{"type":"object","properties":{"unstructured":{"type":"array","items":{"type":"string","uniqueKey":"added.items.[INDEX].remittance.unstructured.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.unstructured","typeLabel":"string[]"},"structured":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.structured.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.structured.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.structured","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.reference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].remittance.reference","typeLabel":"string | null"}},"required":["unstructured","structured","reference"],"isRequired":true,"uniqueKey":"added.items.[INDEX].remittance","typeLabel":"object"},"bank_transaction_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].bank_transaction_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].bank_transaction_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].bank_transaction_code","typeLabel":"string | null"},"bank_reference":{"oneOf":[{"type":"string","description":"The bank's immutable entry reference where it provides one. `null` otherwise, never invented.","isRequired":true,"uniqueKey":"added.items.[INDEX].bank_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The bank's immutable entry reference where it provides one. `null` otherwise, never invented.","isRequired":true,"uniqueKey":"added.items.[INDEX].bank_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].bank_reference","typeLabel":"string | null"},"identity_quality":{"type":"string","enum":["bank_reference","route_id","derived"],"description":"How `id` was matched. `bank_reference` and `route_id` are stable. `derived` is matched by content: it is stable while the bank keeps reporting the entry unchanged, and a correction by the bank can then appear as one `removed` and one `added`.","isRequired":true,"uniqueKey":"added.items.[INDEX].identity_quality","typeLabel":"enum\u003cstring>"},"end_to_end_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].end_to_end_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].end_to_end_id","typeLabel":"string | null"},"mandate_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].mandate_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].mandate_id","typeLabel":"string | null"},"creditor_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].creditor_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].creditor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].creditor_id","typeLabel":"string | null"},"merchant_category_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"added.items.[INDEX].merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"added.items.[INDEX].merchant_category_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].merchant_category_code","typeLabel":"string | null"},"exchange":{"oneOf":[{"type":"object","description":"Currency exchange details where the bank gives them.","properties":{"source_amount":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_amount.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_amount","typeLabel":"string | null"},"source_currency":{"oneOf":[{"type":"string","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_currency.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"added.items.[INDEX].exchange.oneOf.0.source_currency","typeLabel":"string | null"},"rate":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.rate.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"added.items.[INDEX].exchange.oneOf.0.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"added.items.[INDEX].exchange.oneOf.0.rate","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"added.items.[INDEX].exchange.oneOf.0","typeLabel":"object"},{"type":"null","description":"Currency exchange details where the bank gives them.","properties":{"source_amount":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$"}]},"source_currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"rate":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$"}]}},"isRequired":true,"uniqueKey":"added.items.[INDEX].exchange.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].exchange","typeLabel":"object | null"},"balance_after":{"oneOf":[{"type":"string","description":"Balance after the transaction where the bank gives it.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"added.items.[INDEX].balance_after.oneOf.0","typeLabel":"string"},{"type":"null","description":"Balance after the transaction where the bank gives it.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"added.items.[INDEX].balance_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].balance_after","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","description":"Didit's own category, when one applies.","isRequired":true,"uniqueKey":"added.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Didit's own category, when one applies.","isRequired":true,"uniqueKey":"added.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"added.items.[INDEX].category","typeLabel":"string | null"},"first_seen_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"added.items.[INDEX].first_seen_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"added.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","account_id","status","pending_id","reverses_id","booking_date","value_date","transaction_date","effective_date","amount","currency","direction","description","counterparty","remittance","bank_transaction_code","bank_reference","identity_quality","end_to_end_id","mandate_id","creditor_id","merchant_category_code","exchange","balance_after","category","first_seen_at","updated_at"],"uniqueKey":"added.items.[INDEX]","typeLabel":"object"},"description":"Transactions to add. On a first read (no cursor, or after `reset`) this is every transaction the connection had when the read started, each exactly once and in its current state, even if a sync runs while you page. In later reads it holds the transactions that are new since your cursor, and the booked transaction that replaces a pending one.","isRequired":true,"uniqueKey":"added","typeLabel":"object[]"},"modified":{"type":"array","items":{"type":"object","description":"One movement of an account. Any field the bank does not send is `null`; the institution capabilities list which fields a bank is known to send.","properties":{"id":{"type":"string","description":"Didit's id, opaque and stored at first sight. The same movement keeps its id across reads, syncs and renewals. `identity_quality` says how strong that guarantee is.","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"account_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["booked","pending"],"description":"A pending transaction has its own id. When the bank books it, the booked transaction carries `pending_id` where the bank links them, and the pending one appears in `removed` with `reason: pending_booked`.","isRequired":true,"uniqueKey":"modified.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"pending_id":{"oneOf":[{"type":"string","description":"The pending transaction this one replaced. Set only when the bank links them, never guessed.","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].pending_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The pending transaction this one replaced. Set only when the bank links them, never guessed.","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].pending_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].pending_id","typeLabel":"string\u003cuuid> | null"},"reverses_id":{"oneOf":[{"type":"string","description":"The transaction this one reverses, when the bank links them. A reversal is a new transaction.","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].reverses_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The transaction this one reverses, when the bank links them. A reversal is a new transaction.","format":"uuid","isRequired":true,"uniqueKey":"modified.items.[INDEX].reverses_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].reverses_id","typeLabel":"string\u003cuuid> | null"},"booking_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].booking_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].booking_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].booking_date","typeLabel":"string\u003cdate> | null"},"value_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].value_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].value_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].value_date","typeLabel":"string\u003cdate> | null"},"transaction_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].transaction_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].transaction_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].transaction_date","typeLabel":"string\u003cdate> | null"},"effective_date":{"type":"string","description":"The date the date filters use, as the bank reports it in its own time zone with nothing converted: for a booked transaction its booking date, else its value date, else the date it was first seen; for a pending one its transaction date, else the date it was first seen.","format":"date","isRequired":true,"uniqueKey":"modified.items.[INDEX].effective_date","typeLabel":"string\u003cdate>"},"amount":{"type":"string","description":"Signed amount as a decimal string. Negative is money out.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"modified.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code.","isRequired":true,"uniqueKey":"modified.items.[INDEX].currency","typeLabel":"string"},"direction":{"type":"string","enum":["credit","debit"],"description":"Repeats the sign of `amount`.","isRequired":true,"uniqueKey":"modified.items.[INDEX].direction","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].description","typeLabel":"string | null"},"counterparty":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.name","typeLabel":"string | null"},"iban":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.iban.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.iban.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.iban","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.bic.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.bic.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty.bic","typeLabel":"string | null"}},"required":["name","iban","bic"],"isRequired":true,"uniqueKey":"modified.items.[INDEX].counterparty","typeLabel":"object"},"remittance":{"type":"object","properties":{"unstructured":{"type":"array","items":{"type":"string","uniqueKey":"modified.items.[INDEX].remittance.unstructured.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.unstructured","typeLabel":"string[]"},"structured":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.structured.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.structured.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.structured","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.reference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance.reference","typeLabel":"string | null"}},"required":["unstructured","structured","reference"],"isRequired":true,"uniqueKey":"modified.items.[INDEX].remittance","typeLabel":"object"},"bank_transaction_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_transaction_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_transaction_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_transaction_code","typeLabel":"string | null"},"bank_reference":{"oneOf":[{"type":"string","description":"The bank's immutable entry reference where it provides one. `null` otherwise, never invented.","isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The bank's immutable entry reference where it provides one. `null` otherwise, never invented.","isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].bank_reference","typeLabel":"string | null"},"identity_quality":{"type":"string","enum":["bank_reference","route_id","derived"],"description":"How `id` was matched. `bank_reference` and `route_id` are stable. `derived` is matched by content: it is stable while the bank keeps reporting the entry unchanged, and a correction by the bank can then appear as one `removed` and one `added`.","isRequired":true,"uniqueKey":"modified.items.[INDEX].identity_quality","typeLabel":"enum\u003cstring>"},"end_to_end_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].end_to_end_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].end_to_end_id","typeLabel":"string | null"},"mandate_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].mandate_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].mandate_id","typeLabel":"string | null"},"creditor_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].creditor_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].creditor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].creditor_id","typeLabel":"string | null"},"merchant_category_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"modified.items.[INDEX].merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"modified.items.[INDEX].merchant_category_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].merchant_category_code","typeLabel":"string | null"},"exchange":{"oneOf":[{"type":"object","description":"Currency exchange details where the bank gives them.","properties":{"source_amount":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_amount.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_amount","typeLabel":"string | null"},"source_currency":{"oneOf":[{"type":"string","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_currency.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.source_currency","typeLabel":"string | null"},"rate":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.rate.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$","uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"modified.items.[INDEX].exchange.oneOf.0.rate","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"modified.items.[INDEX].exchange.oneOf.0","typeLabel":"object"},{"type":"null","description":"Currency exchange details where the bank gives them.","properties":{"source_amount":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$"}]},"source_currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"rate":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?$"}]}},"isRequired":true,"uniqueKey":"modified.items.[INDEX].exchange.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].exchange","typeLabel":"object | null"},"balance_after":{"oneOf":[{"type":"string","description":"Balance after the transaction where the bank gives it.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"modified.items.[INDEX].balance_after.oneOf.0","typeLabel":"string"},{"type":"null","description":"Balance after the transaction where the bank gives it.","pattern":"^-?\\d+(\\.\\d+)?$","isRequired":true,"uniqueKey":"modified.items.[INDEX].balance_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].balance_after","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","description":"Didit's own category, when one applies.","isRequired":true,"uniqueKey":"modified.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Didit's own category, when one applies.","isRequired":true,"uniqueKey":"modified.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"modified.items.[INDEX].category","typeLabel":"string | null"},"first_seen_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"modified.items.[INDEX].first_seen_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"modified.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","account_id","status","pending_id","reverses_id","booking_date","value_date","transaction_date","effective_date","amount","currency","direction","description","counterparty","remittance","bank_transaction_code","bank_reference","identity_quality","end_to_end_id","mandate_id","creditor_id","merchant_category_code","exchange","balance_after","category","first_seen_at","updated_at"],"uniqueKey":"modified.items.[INDEX]","typeLabel":"object"},"description":"Transactions that changed since your cursor, in their current state. Apply each as an upsert by `id`: a transaction you already received while paging the first read comes again here if it changed meanwhile, and a bank correction arrives here too.","isRequired":true,"uniqueKey":"modified","typeLabel":"object[]"},"removed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the transaction that is no longer current.","format":"uuid","isRequired":true,"uniqueKey":"removed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","enum":["pending_booked","pending_expired","bank_removed","access_removed"],"description":"`pending_booked`: the bank booked it, and the booked transaction is in `added`. `pending_expired`: a pending transaction the bank stopped reporting. `bank_removed`: the bank removed it. `access_removed`: the account left the consent.","isRequired":true,"uniqueKey":"removed.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"required":["id","reason"],"uniqueKey":"removed.items.[INDEX]","typeLabel":"object"},"description":"Transactions that no longer exist, with a `reason`. Ignore an `id` you do not have: a transaction that was removed while you paged a first read was still delivered once as `added` and arrives here in the next read.","isRequired":true,"uniqueKey":"removed","typeLabel":"object[]"},"has_more":{"type":"boolean","description":"`true` while there are more pages. Store `next_cursor` only after a response with `has_more: false`; if paging fails midway, restart from the cursor you had stored.","isRequired":true,"uniqueKey":"has_more","typeLabel":"boolean"},"next_page_token":{"oneOf":[{"type":"string","description":"Continues this read while `has_more` is `true`.","isRequired":true,"uniqueKey":"next_page_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Continues this read while `has_more` is `true`.","isRequired":true,"uniqueKey":"next_page_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_page_token","typeLabel":"string | null"},"next_cursor":{"oneOf":[{"type":"string","description":"The durable checkpoint of the feed, returned only on the last page. Opaque and bound to the application, environment and connection. Replayable for 90 days. On a first read it marks the moment the read started, so what changed meanwhile arrives in the next read.","isRequired":true,"uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"The durable checkpoint of the feed, returned only on the last page. Opaque and bound to the application, environment and connection. Replayable for 90 days. On a first read it marks the moment the read started, so what changed meanwhile arrives in the next read.","isRequired":true,"uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_cursor","typeLabel":"string | null"},"reset":{"type":"boolean","description":"`true` on every bootstrap, which is every read from an empty cursor: replace your copy with the result instead of adding to it.","isRequired":true,"uniqueKey":"reset","typeLabel":"boolean"}},"required":["added","modified","removed","has_more","next_page_token","next_cursor","reset"],"uniqueKey":"","typeLabel":"object"},"examples":{"Changes":{"title":"Changes","summary":"A pending transaction booked, and a new one added","value":{"added":[{"id":"8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963","account_id":"a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10","status":"booked","pending_id":null,"reverses_id":null,"booking_date":"2026-11-19","value_date":"2026-11-20","transaction_date":null,"effective_date":"2026-11-19","amount":"-1210.00","currency":"EUR","direction":"debit","description":"RECIBO SEGURIDAD SOCIAL","counterparty":{"name":"ENTIDAD PUBLICA DE EJEMPLO","iban":"ES0000000000000000005766","bic":null},"remittance":{"unstructured":["RECIBO SEGURIDAD SOCIAL 10/2026"],"structured":null,"reference":"0028123456789"},"bank_transaction_code":"PMNT-RDDT-ESDD","bank_reference":"2026111900012345","identity_quality":"bank_reference","end_to_end_id":"NOTPROVIDED","mandate_id":"ES-SS-000123","creditor_id":"ES00ZZZ00000000","merchant_category_code":null,"exchange":null,"balance_after":"18250.34","category":"taxes_and_social_security","first_seen_at":"2026-11-20T06:00:12Z","updated_at":"2026-11-20T06:00:12Z"}],"modified":[],"removed":[{"id":"e5b1f8a3-0d47-4c92-a6e0-7f3c2d9b1845","reason":"pending_booked"}],"has_more":false,"next_page_token":null,"next_cursor":"cur_01HZX9K4M2W7B3T8","reset":false}},"Bootstrap":{"title":"Bootstrap","summary":"Read from an empty cursor","value":{"added":[{"id":"8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963","account_id":"a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10","status":"booked","pending_id":null,"reverses_id":null,"booking_date":"2026-11-19","value_date":"2026-11-20","transaction_date":null,"effective_date":"2026-11-19","amount":"-1210.00","currency":"EUR","direction":"debit","description":"RECIBO SEGURIDAD SOCIAL","counterparty":{"name":"ENTIDAD PUBLICA DE EJEMPLO","iban":"ES0000000000000000005766","bic":null},"remittance":{"unstructured":["RECIBO SEGURIDAD SOCIAL 10/2026"],"structured":null,"reference":"0028123456789"},"bank_transaction_code":"PMNT-RDDT-ESDD","bank_reference":"2026111900012345","identity_quality":"bank_reference","end_to_end_id":"NOTPROVIDED","mandate_id":"ES-SS-000123","creditor_id":"ES00ZZZ00000000","merchant_category_code":null,"exchange":null,"balance_after":"18250.34","category":"taxes_and_social_security","first_seen_at":"2026-11-20T06:00:12Z","updated_at":"2026-11-20T06:00:12Z"},{"id":"2c9e7a05-6b14-4d38-8f2a-b3d51e0c9a67","account_id":"a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10","status":"booked","pending_id":null,"reverses_id":null,"booking_date":"2026-11-18","value_date":"2026-11-18","transaction_date":null,"effective_date":"2026-11-18","amount":"3450.00","currency":"EUR","direction":"credit","description":"TRANSFERENCIA FACTURA 2026-0418","counterparty":{"name":"CLIENTE DE EJEMPLO SL","iban":"ES0000000000000000007891","bic":null},"remittance":{"unstructured":["FRA 2026-0418"],"structured":null,"reference":null},"bank_transaction_code":"PMNT-RCDT-ESCT","bank_reference":"2026111800009876","identity_quality":"bank_reference","end_to_end_id":"2026-0418","mandate_id":null,"creditor_id":null,"merchant_category_code":null,"exchange":null,"balance_after":"19460.34","category":"income","first_seen_at":"2026-11-19T06:00:10Z","updated_at":"2026-11-19T06:00:10Z"}],"modified":[],"removed":[],"has_more":false,"next_page_token":null,"next_cursor":"cur_01HZX9K4M2W7B3T8","reset":true}}},"exampleType":"examples"}},"headers":{"Cache-Control":{"description":"`no-store`.","schema":{"type":"string"}}},"exampleType":"examples"},"0ca6c595-2a5a-4c86-9214-947aa676dd7a":{"description":"The cursor or page token is not valid, or a parameter is out of range. `field` names it.","content":{"application/json":{"schema":{"type":"object","description":"Error body of every Bank data operation. Every field is always present.","properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"}},"required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid cursor":{"title":"Invalid cursor","summary":"Invalid cursor","value":{"code":"invalid_cursor","message":"The cursor or page token is not valid.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"cursor","next_action":null,"retry_after":null}},"Token for another read":{"title":"Token for another read","summary":"Token for another read","value":{"code":"page_token_mismatch","message":"The page token belongs to a different read. Restart with the same filters.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"page_token","next_action":null,"retry_after":null}},"Invalid request":{"title":"Invalid request","summary":"Invalid request","value":{"code":"invalid_request","message":"The request is not valid.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"limit","next_action":null,"retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"},"5aa00d48-1fa7-43ef-9d81-f3570acbd440":{"description":"Unauthorized","content":{"application/json":{"examples":{"Invalid API Key":{"title":"Invalid API Key","summary":"Invalid API Key","value":{"detail":"Invalid API Key."}}},"exampleType":"examples"}},"exampleType":"examples"},"2ca73bb6-6656-4065-b48d-86c6366233e9":{"description":"The API key does not carry the Bank data permission (`bank-data`), or, for raw bank data in a live application, the application setting \"Bank data in the API\" is off. Bank data is not part of full access: a full-access key, a key restricted to other resources and a request authenticated without an API key (client credentials, on raw data) are all refused with this body, so create a key and grant it explicitly. The refusal comes before any lookup, so it says nothing about whether an object exists.","content":{"application/json":{"schema":{"type":"object","description":"Error body of every Bank data operation. Every field is always present.","properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"}},"required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Bank data not allowed":{"title":"Bank data not allowed","summary":"Bank data not allowed","value":{"code":"bank_data_access_denied","message":"Bank data calls need an API key that carries the Bank data permission.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":null,"next_action":"enable_bank_data_access","retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"},"45d11060-cf77-4747-a63c-86b2c134c99a":{"description":"The resource does not exist in this application and environment.","content":{"application/json":{"schema":{"type":"object","description":"Error body of every Bank data operation. Every field is always present.","properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"}},"required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Not found":{"title":"Not found","summary":"Not found","value":{"code":"not_found","message":"The resource does not exist.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":null,"next_action":null,"retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"},"46d8537f-7d6f-46ff-8e21-6debc2962a21":{"description":"The connection has no readable data: it was deleted, or its retention ended (`connection_not_active`).","content":{"application/json":{"schema":{"type":"object","description":"Error body of every Bank data operation. Every field is always present.","properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"}},"required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Not active":{"title":"Not active","summary":"Not active","value":{"code":"connection_not_active","message":"This connection is not active.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":null,"next_action":"create_link","retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"},"b057d3be-9062-4548-9bdf-ac96f51973ca":{"description":"The cursor is older than the 90 days the change log is kept, or the page token expired. For `cursor_expired` the body carries `bootstrap: true`.","content":{"application/json":{"schema":{"type":"object","description":"Body of a `410` answer of the change feed. With `cursor_expired` it carries `bootstrap: true`: read the feed again from an empty cursor, and replace your copy of the connection's transactions with that result instead of adding to it. With `page_expired` there is no `bootstrap`: restart from the last cursor you stored.","required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"},"bootstrap":{"type":"boolean","description":"Present with `cursor_expired`, always `true`: start again from an empty `cursor` and replace your stored copy with the result.","uniqueKey":"bootstrap","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Cursor expired":{"title":"Cursor expired","summary":"Start again from an empty cursor","value":{"code":"cursor_expired","message":"The cursor is older than the change log. Read again from an empty cursor.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"cursor","next_action":"restart_from_cursor","retry_after":null,"bootstrap":true}},"Page expired":{"title":"Page expired","summary":"Restart the read from the last stored cursor","value":{"code":"page_expired","message":"The page token expired. Restart the read.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"page_token","next_action":"restart_read","retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"},"eaa89b92-ded6-47a0-8d9a-fc35fecbecdc":{"description":"Middleware read budget exceeded. Honor Retry-After before retrying.","headers":{"Retry-After":{"description":"Seconds to wait, rounded up to the next window. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Scope":{"description":"The scope whose budget was exceeded. Present on middleware budget refusals.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Budget for the exceeded scope; equals body limit. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining budget, clamped to zero; equals body remaining. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Reset time in Unix seconds; equals body reset. Present on middleware budget refusals.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Returned only for a rate-limit middleware budget refusal. Other 429 errors, including idempotency conflicts and endpoint-specific caps, do not promise these metadata fields.","required":["detail","reference","limit","remaining","reset","window_seconds"],"properties":{"detail":{"type":"string","description":"Existing human-readable budget refusal message.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"reference":{"type":"string","pattern":"^RL-[0-9a-f]{32}$","description":"Opaque support reference: RL- followed by 32 lowercase UUID hexadecimal characters.","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"limit":{"type":"integer","description":"Budget for the exceeded scope; equals X-RateLimit-Limit.","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","minimum":0,"description":"Remaining budget, clamped to zero; equals X-RateLimit-Remaining.","isRequired":true,"uniqueKey":"remaining","typeLabel":"integer"},"reset":{"type":"integer","format":"int64","description":"Window reset time in Unix seconds; equals X-RateLimit-Reset.","isRequired":true,"uniqueKey":"reset","typeLabel":"integer\u003cint64>"},"window_seconds":{"type":"integer","description":"Fixed-window duration in seconds, not the remaining wait. Honor Retry-After before retrying.","isRequired":true,"uniqueKey":"window_seconds","typeLabel":"integer"}},"example":{"detail":"Write request rate limit exceeded. You can make up to 300 requests per minute.","reference":"RL-00000000000040008000000000000001","limit":300,"remaining":0,"reset":1794358860,"window_seconds":60},"uniqueKey":"","typeLabel":"object"},"example":{"detail":"GET request rate limit exceeded. You can make up to 600 requests per minute.","reference":"RL-00000000000040008000000000000001","limit":600,"remaining":0,"reset":1794358860,"window_seconds":60},"examples":{"Example":{"title":"Example","value":{"detail":"GET request rate limit exceeded. You can make up to 600 requests per minute.","reference":"RL-00000000000040008000000000000001","limit":600,"remaining":0,"reset":1794358860,"window_seconds":60}}},"exampleType":"examples"}},"exampleType":"examples"},"56e6dc26-049b-4c9a-81ff-37d8ecf14e3a":{"description":"Something went wrong on Didit's side. Any unexpected error under `/v3/bank/` answers in the Bank error shape, never an HTML page: quote `request_id` to support.","content":{"application/json":{"schema":{"type":"object","description":"Error body of every Bank data operation. Every field is always present.","properties":{"code":{"type":"string","enum":["ongoing_access_not_available","segment_not_available","window_not_available","history_window_ambiguous","redirect_url_not_registered","link_origin_not_allowed","bank_data_access_denied","connection_not_active","consent_expired","renewal_not_needed","renewal_window_expired","access_removed","refresh_limit_reached","cursor_expired","page_expired","invalid_cursor","page_token_mismatch","contract_rate_missing","insufficient_credits","invalid_request","not_found","internal_error"],"description":"Machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Plain-language explanation for a developer. The wording can change; do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Identifier of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field to correct, when the error is about one field. Otherwise `null`.","isRequired":true,"uniqueKey":"field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"field","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"string","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["retry_later","renew_connection","create_link","restart_from_cursor","restart_read","top_up_balance","enable_bank_data_access","contact_support",null],"description":"What to do next, so a client can act without guessing. `null` when there is no standard next step.","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"enum\u003cstring> | null"},"retry_after":{"oneOf":[{"type":"integer","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to wait before retrying. Set on rate-limit and temporary errors, otherwise `null`.","isRequired":true,"uniqueKey":"retry_after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retry_after","typeLabel":"integer | null"}},"required":["code","message","request_id","field","next_action","retry_after"],"example":{"code":"ongoing_access_not_available","message":"This bank cannot keep access open. Use access one_time or choose another bank.","request_id":"3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59","field":"institution_id","next_action":"create_link","retry_after":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Internal error":{"title":"Internal error","summary":"An unexpected error","value":{"code":"internal_error","message":"Something went wrong on our side. Quote the request_id to support.","request_id":"3f6a1c8e92b54d07a1e38c4b7f0d2e59","field":null,"next_action":"contact_support","retry_after":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e8342fc8-ee58-4990-9dd1-ff01f6cad823":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"7f67315f-7c19-4348-bb1c-4fa317815f70":{"url":"https://verification.didit.me"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-25.json"},"subdomain":"didit-0f962782","siteName":"Didit Docs","title":"Bank Transactions Change Feed API: Added, Modified, Removed - Didit Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/standalone-apis/bank-transactions-sync","matchLevel":0},"es":{"href":"/es/standalone-apis/bank-transactions-sync","matchLevel":1},"pt-BR":{"href":"/pt-br/standalone-apis/bank-transactions-sync","matchLevel":1},"ja":{"href":"/ja/standalone-apis/bank-transactions-sync","matchLevel":1},"de":{"href":"/de/standalone-apis/bank-transactions-sync","matchLevel":1},"fr":{"href":"/fr/standalone-apis/bank-transactions-sync","matchLevel":1},"it":{"href":"/it/standalone-apis/bank-transactions-sync","matchLevel":1},"pt":{"href":"/pt/standalone-apis/bank-transactions-sync","matchLevel":1},"ca":{"href":"/ca/standalone-apis/bank-transactions-sync","matchLevel":1},"id":{"href":"/id/standalone-apis/bank-transactions-sync","matchLevel":1},"ru":{"href":"/ru/standalone-apis/bank-transactions-sync","matchLevel":1},"ko":{"href":"/ko/standalone-apis/bank-transactions-sync","matchLevel":1},"zh":{"href":"/zh/standalone-apis/bank-transactions-sync","matchLevel":1},"ar":{"href":"/ar/standalone-apis/bank-transactions-sync","matchLevel":1},"hi":{"href":"/hi/standalone-apis/bank-transactions-sync","matchLevel":1}}},"lastModified":"2026-11-22T19:52:54.295Z","gitLastModified":"2026-11-22T19:45:28.000Z","originalFileLocation":"standalone-apis/bank-transactions-sync.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Didit\u0026#x27;s Sync Transactions endpoint returns what changed in a connection\u0026#x27;s transactions since a cursor: added, modified and removed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Didit Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bank Transactions Change Feed API: Added, Modified, Removed - Didit Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Didit\u0026#x27;s Sync Transactions endpoint returns what changed in a connection\u0026#x27;s transactions since a cursor: added, modified and removed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Didit Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.didit.me/standalone-apis/bank-transactions-sync\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Accounts+and+transactions\u0026amp;title=Bank+Transactions+Change+Feed+API%3A+Added%2C+Modified%2C+Removed\u0026amp;description=Didit%27s+Sync+Transactions+endpoint+returns+what+changed+in+a+connection%27s+transactions+since+a+cursor%3A+added%2C+modified+and+removed.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=74f36c1ab07a87f64286e45fca93142e6a93c164696768c5af641c6fad180a48\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Bank Transactions Change Feed API: Added, Modified, Removed - Didit Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Didit\u0026#x27;s Sync Transactions endpoint returns what changed in a connection\u0026#x27;s transactions since a cursor: added, modified and removed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Accounts+and+transactions\u0026amp;title=Bank+Transactions+Change+Feed+API%3A+Added%2C+Modified%2C+Removed\u0026amp;description=Didit%27s+Sync+Transactions+endpoint+returns+what+changed+in+a+connection%27s+transactions+since+a+cursor%3A+added%2C+modified+and+removed.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=74f36c1ab07a87f64286e45fca93142e6a93c164696768c5af641c6fad180a48\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Didit Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2567FF\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#2567FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.didit.me/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/standalone-apis/bank-transactions-sync.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.didit.me/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.didit.me/es/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.didit.me/pt-br/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.didit.me/ja/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.didit.me/de/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.didit.me/fr/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.didit.me/it/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.didit.me/pt/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.didit.me/ca/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"id\" href=\"https://docs.didit.me/id/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.didit.me/ru/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.didit.me/ko/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.didit.me/zh/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://docs.didit.me/ar/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hi\" href=\"https://docs.didit.me/hi/standalone-apis/bank-transactions-sync\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.didit.me/standalone-apis/bank-transactions-sync\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://didit.me/#organization\",\"name\":\"Didit\",\"legalName\":\"Didit Protocol\",\"url\":\"https://didit.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://didit.me/logos/primary-horizontal-light.png\"},\"sameAs\":[\"https://www.linkedin.com/company/91001155\",\"https://www.youtube.com/@getdidit\",\"https://github.com/didit-protocol\",\"https://x.com/didit\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.didit.me#website\",\"name\":\"Didit Docs\",\"url\":\"https://docs.didit.me\",\"publisher\":{\"@id\":\"https://didit.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync#webpage\",\"url\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync\",\"name\":\"Bank Transactions Change Feed API: Added, Modified, Removed\",\"description\":\"Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.\",\"dateModified\":\"2026-11-22T19:45:28.000Z\",\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bank Verification\",\"item\":\"https://docs.didit.me/standalone-apis/bank-account-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Accounts and transactions\",\"item\":\"https://docs.didit.me/standalone-apis/bank-accounts-list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bank Transactions Change Feed API: Added, Modified, Removed\",\"item\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync#apireference\",\"headline\":\"Bank Transactions Change Feed API: Added, Modified, Removed\",\"name\":\"Bank Transactions Change Feed API: Added, Modified, Removed\",\"description\":\"Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.\",\"url\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync\",\"mainEntityOfPage\":{\"@id\":\"https://docs.didit.me/standalone-apis/bank-transactions-sync#webpage\"},\"dateModified\":\"2026-11-22T19:45:28.000Z\",\"keywords\":\"bank transactions change feed api, sync transactions (change feed), bank data API, open banking API, Didit\",\"publisher\":{\"@id\":\"https://didit.me/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Didit Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Didit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/standalone-apis/bank-transactions-sync.md","siteName":"Didit Docs","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Get Started","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/rocket.svg","pages":[{"title":"Get Started","href":""}]},{"tab":"Integrate / SDKs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/code.svg","pages":[{"title":"Integrate / SDKs","href":"/integration/sdks"}]},{"tab":"API Reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/code.svg","groups":[{"group":"Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/overview.svg","pages":[{"title":"Didit API Reference: Identity Verification REST API","sidebarTitle":"API Reference","href":"/api-reference/overview"},{"title":"Healthcheck API: Public Liveness Probe","sidebarTitle":"Healthcheck","openapi":"openapi-healthcheck.json GET /system/healthcheck","href":"/api-reference/healthcheck"},{"title":"Service Status API: Public Didit Status Feed","sidebarTitle":"Service status","openapi":"openapi-25.json GET /v3/status/","href":"/api-reference/service-status"},{"title":"Bank Verification Pricing API: Public Price Feed","sidebarTitle":"Bank verification prices","openapi":"openapi-25.json GET /v3/organization/bank-verification-pricing/","href":"/api-reference/bank-verification-pricing"}]},{"group":"User and Business Verifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/user-verifications.svg","pages":[{"title":"Sessions API: Unified KYC \u0026 KYB Verification","sidebarTitle":"Overview","href":"/sessions-api/overview"},{"title":"Create Session API: Start KYC or KYB Verification","sidebarTitle":"Create Session","openapi":"openapi-25.json POST /v3/session/","href":"/sessions-api/create-session"},{"title":"Import Data from Another Provider","openapi":"openapi-25.json POST /v3/session/imports/","href":"/sessions-api/import-verifications"},{"title":"Retrieve Session API: KYC \u0026 KYB Decision Data","sidebarTitle":"Retrieve Session","openapi":"openapi-25.json GET /v3/session/{sessionId}/decision/","href":"/sessions-api/retrieve-session"},{"title":"List Sessions API: Filter KYC \u0026 KYB Sessions","sidebarTitle":"List Sessions","openapi":"openapi-25.json GET /v3/sessions/","href":"/sessions-api/list-sessions"},{"title":"Update Session Status API: Approve \u0026 Decline","sidebarTitle":"Update Session Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-status/","href":"/sessions-api/update-status"},{"title":"Preview Resubmission Email","openapi":"openapi-25.json POST /v3/session/{sessionId}/resubmission-preview/","href":"/sessions-api/preview-resubmission"},{"title":"Preview Decision Email API: Approved and Declined Emails","sidebarTitle":"Preview Decision Email","openapi":"openapi-25.json POST /v3/session/{sessionId}/decision-email-preview/","href":"/sessions-api/preview-decision-email"},{"title":"Update Feature Status API: Approve/Decline a Single Step","sidebarTitle":"Update Feature Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/","href":"/sessions-api/update-feature-status"},{"title":"List Feature Overrides API: Step Status History","sidebarTitle":"List Feature Overrides","openapi":"openapi-25.json GET /v3/session/{sessionId}/features/overrides/","href":"/sessions-api/list-feature-overrides"},{"title":"Cancel Feature Override API: Drop a Pending Step Override","sidebarTitle":"Cancel Feature Override","openapi":"openapi-25.json POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/","href":"/sessions-api/cancel-feature-override"},{"title":"Update AML Hit Status API: Clear \u0026 Confirm Matches","sidebarTitle":"Update AML Hit Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-aml-hit-status/","href":"/sessions-api/update-aml-hit-status"},{"title":"Update Session Data API: Fix KYC \u0026 KYB Fields","sidebarTitle":"Update Session Data","href":"/sessions-api/update-data"},{"title":"Update AML Check Status API","sidebarTitle":"Update AML Check Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-aml-status/","href":"/sessions-api/update-aml-status"},{"title":"Update Document AI Data API","sidebarTitle":"Update Document AI Data","openapi":"openapi-25.json PATCH /v3/document-ai/{sessionId}/documents/{documentUuid}/","href":"/sessions-api/update-document-ai-data"},{"title":"Regenerate Key People KYC Session API","sidebarTitle":"Regenerate Key People KYC Session","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/{partyUuid}/regenerate/","href":"/sessions-api/regenerate-kyb-party"},{"title":"Upload KYB Documents API","sidebarTitle":"Upload KYB Documents","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/documents/","href":"/sessions-api/kyb-upload-documents"},{"title":"List KYB Extracted Parties API","sidebarTitle":"List KYB Extracted Parties","openapi":"openapi-25.json GET /v3/session/{sessionId}/kyb/extracted-parties/","href":"/sessions-api/kyb-extracted-parties"},{"title":"List KYB Party Drafts API","sidebarTitle":"List KYB Party Drafts","openapi":"openapi-25.json GET /v3/session/{sessionId}/kyb/parties/drafts/","href":"/sessions-api/kyb-list-party-drafts"},{"title":"Create KYB Party Draft API","sidebarTitle":"Create KYB Party Draft","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/drafts/","href":"/sessions-api/kyb-create-party-draft"},{"title":"Edit KYB Party Draft API","sidebarTitle":"Edit KYB Party Draft","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/","href":"/sessions-api/kyb-update-party-draft"},{"title":"Delete KYB Party Draft API","sidebarTitle":"Delete KYB Party Draft","openapi":"openapi-25.json DELETE /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/","href":"/sessions-api/kyb-delete-party-draft"},{"title":"Submit KYB Key People API","sidebarTitle":"Submit KYB Key People","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/submit/","href":"/sessions-api/kyb-submit-parties"},{"title":"Add Images to a Session API","sidebarTitle":"Add Images to a Session","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/add-images/","href":"/sessions-api/add-images"},{"title":"Delete Session API: GDPR Right-to-Be-Forgotten","sidebarTitle":"Delete Session","openapi":"openapi-25.json DELETE /v3/session/{sessionId}/delete/","href":"/sessions-api/delete-session"},{"title":"Generate PDF API: KYC \u0026 KYB Compliance Reports","sidebarTitle":"Generate PDF","openapi":"openapi-25.json GET /v3/session/{sessionId}/generate-pdf/","href":"/sessions-api/generate-pdf"},{"title":"Export Session Files API: Download Every File as One ZIP","sidebarTitle":"Export files","openapi":"openapi-25.json POST /v3/session/{sessionId}/files-export/","href":"/sessions-api/export-files"},{"title":"Get Session Files Export API: Status and Download Link","sidebarTitle":"Get files export","openapi":"openapi-25.json GET /v3/session/{sessionId}/files-export/{exportId}/","href":"/sessions-api/get-files-export"},{"group":"E-signatures","pages":[{"title":"Download Signed Document API: Signed PDF","sidebarTitle":"Download a Signed Document","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/","href":"/sessions-api/electronic-signature/download-signed-document"},{"title":"Signature Evidence API: Audit Trail PDF","sidebarTitle":"Download the Signature Evidence","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/evidence/","href":"/sessions-api/electronic-signature/download-evidence"},{"title":"Signature Image API: Adopted Signature PNG","sidebarTitle":"Download a Signature Image","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/","href":"/sessions-api/electronic-signature/download-field-image"},{"title":"Validate Signatures API: Re-check Signed PDFs","sidebarTitle":"Validate Signatures","openapi":"openapi-25.json POST /v3/session/{sessionId}/signatures/{nodeId}/validate/","href":"/sessions-api/electronic-signature/validate-signatures"}]},{"title":"Share Session API: Reusable KYC Between Partners","sidebarTitle":"Overview","href":"/sessions-api/share-session/overview"},{"title":"Share Session API: Generate Share Token","sidebarTitle":"Share Session","openapi":"openapi-25.json POST /v3/session/{sessionId}/share/","href":"/sessions-api/share-session/share"},{"title":"Import Shared Session API: Reusable KYC \u0026 KYB","sidebarTitle":"Import Shared Session","openapi":"openapi-25.json POST /v3/session/import-shared/","href":"/sessions-api/share-session/import"}]},{"group":"Lists","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/lists.svg","pages":[{"title":"Lists API: Blocklists \u0026 Allowlists","sidebarTitle":"Overview","href":"/management-api/lists/overview"},{"title":"List All Lists API: Blocklists \u0026 Allowlists","sidebarTitle":"List Lists","openapi":"openapi-25.json GET /v3/lists/","href":"/management-api/lists/list"},{"title":"Create List API: Allowlist \u0026 Custom List","sidebarTitle":"Create List","openapi":"openapi-25.json POST /v3/lists/","href":"/management-api/lists/create"},{"title":"Get List API: Retrieve Compliance List","sidebarTitle":"Get List","openapi":"openapi-25.json GET /v3/lists/{list_uuid}/","href":"/management-api/lists/get"},{"title":"Update List API: Edit Compliance List","sidebarTitle":"Update List","openapi":"openapi-25.json PATCH /v3/lists/{list_uuid}/","href":"/management-api/lists/update"},{"title":"Delete List API: Remove Compliance List","sidebarTitle":"Delete List","openapi":"openapi-25.json DELETE /v3/lists/{list_uuid}/","href":"/management-api/lists/delete"},{"title":"List Entries API: Blocklist \u0026 Allowlist Items","sidebarTitle":"List Entries","openapi":"openapi-25.json GET /v3/lists/{list_uuid}/entries/","href":"/management-api/lists/list-entries"},{"title":"Create List Entry API: Blocklist \u0026 Allowlist","sidebarTitle":"Create List Entry","openapi":"openapi-25.json POST /v3/lists/{list_uuid}/entries/","href":"/management-api/lists/create-entry"},{"title":"Delete List Entry API: Unblock Item","sidebarTitle":"Delete List Entry","openapi":"openapi-25.json DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/","href":"/management-api/lists/delete-entry"},{"title":"Upload Face API: Biometric Lists","sidebarTitle":"Upload Face","openapi":"openapi-25.json POST /v3/lists/{list_uuid}/entries/face-upload/","href":"/management-api/lists/upload-face"}]},{"group":"Blocklist","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/lists.svg","pages":[{"title":"List Blocklisted Items API","sidebarTitle":"List Blocklisted Items","openapi":"openapi-25.json GET /v3/blocklist/","href":"/management-api/blocklist/list"},{"title":"Add to Blocklist API: Block Session Items","sidebarTitle":"Add to Blocklist","openapi":"openapi-25.json POST /v3/blocklist/add/","href":"/management-api/blocklist/add"},{"title":"Remove from Blocklist API: Unblock Session Items","sidebarTitle":"Remove from Blocklist","openapi":"openapi-25.json POST /v3/blocklist/remove/","href":"/management-api/blocklist/remove"}]},{"group":"Workflows","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/workflows.svg","pages":[{"title":"List Workflows API: Verification Flows","sidebarTitle":"List Workflows","openapi":"openapi-25.json GET /v3/workflows/","href":"/management-api/workflows/list"},{"title":"Create Workflow API: Build KYC Flow","sidebarTitle":"Create Workflow","openapi":"openapi-25.json POST /v3/workflows/","href":"/management-api/workflows/create"},{"title":"Workflow Feature Configs API Reference","sidebarTitle":"Workflow Feature Configs","href":"/management-api/workflows/feature-configs"},{"title":"Get Workflow API: Retrieve KYC Flow","sidebarTitle":"Get Workflow","openapi":"openapi-25.json GET /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/get"},{"title":"Update Workflow API: Edit KYC Flow","sidebarTitle":"Update Workflow","openapi":"openapi-25.json PATCH /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/update"},{"title":"Delete Workflow API: Remove KYC Flow","sidebarTitle":"Delete Workflow","openapi":"openapi-25.json DELETE /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/delete"}]},{"group":"Questionnaires","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/task-square.svg","pages":[{"title":"List Questionnaires API: KYC Forms","sidebarTitle":"List Questionnaires","openapi":"openapi-25.json GET /v3/questionnaires/","href":"/management-api/questionnaires/list"},{"title":"Create Questionnaire API: Custom KYC Form","sidebarTitle":"Create Questionnaire","openapi":"openapi-25.json POST /v3/questionnaires/","href":"/management-api/questionnaires/create"},{"title":"Get Questionnaire API: Retrieve KYC Form","sidebarTitle":"Get Questionnaire","openapi":"openapi-25.json GET /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/get"},{"title":"Update Questionnaire API: Edit KYC Form","sidebarTitle":"Update Questionnaire","openapi":"openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/update"},{"title":"Delete Questionnaire API: Remove KYC Form","sidebarTitle":"Delete Questionnaire","openapi":"openapi-25.json DELETE /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/delete"}]},{"group":"Users","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/users.svg","pages":[{"title":"List Users API: Vendor User Entities","sidebarTitle":"List Users","openapi":"openapi-25.json GET /v3/users/","href":"/management-api/users/list"},{"title":"Look Up Users API: Check a List of IDs","sidebarTitle":"Look Up Users","openapi":"openapi-25.json POST /v3/users/lookup/","href":"/management-api/users/lookup"},{"title":"Create User API: Vendor User Entity","sidebarTitle":"Create User","openapi":"openapi-25.json POST /v3/users/create/","href":"/management-api/users/create"},{"title":"Upload User Face API: Vendor User Profile","sidebarTitle":"Upload User Face","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/","href":"/management-api/users/upload-face"},{"title":"Get User API: Vendor User Entity","sidebarTitle":"Get User","openapi":"openapi-25.json GET /v3/users/{vendor_data}/","href":"/management-api/users/get"},{"title":"User History PDF API: All Sessions of a User","sidebarTitle":"User history PDF","openapi":"openapi-25.json GET /v3/users/{vendor_data}/generate-pdf/","href":"/management-api/users/generate-pdf"},{"title":"Update User API: Vendor User Entity","sidebarTitle":"Update User","openapi":"openapi-25.json PATCH /v3/users/{vendor_data}/","href":"/management-api/users/update"},{"title":"Update User Status API: Block or Flag","sidebarTitle":"Update User Status","openapi":"openapi-25.json PATCH /v3/users/{vendor_data}/update-status/","href":"/management-api/users/update-status"},{"title":"Batch Delete Users API: GDPR Erasure","sidebarTitle":"Batch Delete Users","openapi":"openapi-25.json POST /v3/users/delete/","href":"/management-api/users/delete"}]},{"group":"Biometric Templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/liveness.svg","pages":[{"title":"Biometric Templates API","sidebarTitle":"Overview","href":"/management-api/biometric-templates/overview"},{"title":"List Biometric Templates API","sidebarTitle":"List Templates","openapi":"openapi-25.json GET /v3/biometric-templates/","href":"/management-api/biometric-templates/list"},{"title":"Count Biometric Templates API","sidebarTitle":"Count Templates","openapi":"openapi-25.json GET /v3/biometric-templates/count/","href":"/management-api/biometric-templates/count"},{"title":"Get Biometric Template API","sidebarTitle":"Get Template","openapi":"openapi-25.json GET /v3/biometric-templates/{template_uuid}/","href":"/management-api/biometric-templates/get"},{"title":"Purge Biometric Template API","sidebarTitle":"Purge Template","openapi":"openapi-25.json DELETE /v3/biometric-templates/{template_uuid}/","href":"/management-api/biometric-templates/purge"},{"title":"Bulk Purge Biometric Templates API","sidebarTitle":"Bulk Purge","openapi":"openapi-25.json POST /v3/biometric-templates/delete/","href":"/management-api/biometric-templates/batch-purge"}]},{"group":"Businesses","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/businesses.svg","pages":[{"title":"List Businesses API: Vendor KYB Entities","sidebarTitle":"List Businesses","openapi":"openapi-25.json GET /v3/businesses/","href":"/management-api/businesses/list"},{"title":"Create Business API: Vendor KYB Entity","sidebarTitle":"Create Business","openapi":"openapi-25.json POST /v3/businesses/create/","href":"/management-api/businesses/create"},{"title":"Get Business API: Vendor KYB Entity","sidebarTitle":"Get Business","openapi":"openapi-25.json GET /v3/businesses/{vendor_data}/","href":"/management-api/businesses/get"},{"title":"Business Session PDF API","sidebarTitle":"Generate Business Session PDF","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/","href":"/management-api/businesses/generate-session-pdf"},{"title":"Update Business API: Vendor KYB Entity","sidebarTitle":"Update Business","openapi":"openapi-25.json PATCH /v3/businesses/{vendor_data}/","href":"/management-api/businesses/update"},{"title":"Update Business Status API: Block or Flag","sidebarTitle":"Update Business Status","openapi":"openapi-25.json PATCH /v3/businesses/{vendor_data}/update-status/","href":"/management-api/businesses/update-status"},{"title":"Batch Delete Businesses API: KYB Erasure","sidebarTitle":"Batch Delete Businesses","openapi":"openapi-25.json POST /v3/businesses/delete/","href":"/management-api/businesses/delete"}]},{"group":"AML Ongoing Monitoring","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/aml-screening.svg","pages":[{"title":"Toggle AML Monitoring for Users API","sidebarTitle":"Toggle for Users","openapi":"openapi-25.json POST /v3/users/aml-monitoring/","href":"/management-api/aml-monitoring/toggle-users"},{"title":"Toggle AML Monitoring for Businesses API","sidebarTitle":"Toggle for Businesses","openapi":"openapi-25.json POST /v3/businesses/aml-monitoring/","href":"/management-api/aml-monitoring/toggle-businesses"},{"title":"Get AML Monitoring Job API","sidebarTitle":"Get AML Monitoring Job","openapi":"openapi-25.json GET /v3/aml-monitoring/jobs/{job_id}/","href":"/management-api/aml-monitoring/get-job"}]},{"group":"Cases","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/clipboard-check.svg","pages":[{"title":"List Cases API","sidebarTitle":"List Cases","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/","href":"/management-api/cases/list"},{"title":"Create Case API","sidebarTitle":"Create Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/","href":"/management-api/cases/create"},{"title":"Get Case API","sidebarTitle":"Get Case","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/get"},{"title":"Update Case API","sidebarTitle":"Update Case","openapi":"openapi-25.json PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/update"},{"title":"Delete Case API","sidebarTitle":"Delete Case","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/delete"},{"title":"Resolve Case API","sidebarTitle":"Resolve Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/","href":"/management-api/cases/resolve"},{"title":"Request Info Case API","sidebarTitle":"Request Info (Awaiting User)","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/","href":"/management-api/cases/request-info"},{"title":"Transfer Case API","sidebarTitle":"Transfer Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/","href":"/management-api/cases/transfer"},{"title":"Print Case PDF API","sidebarTitle":"Print Case","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/","href":"/management-api/cases/print"},{"title":"Case Analytics API","sidebarTitle":"Case Analytics","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/statistics/","href":"/management-api/cases/statistics"},{"title":"Bulk Update Case Status API","sidebarTitle":"Bulk Update Case Status","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/","href":"/management-api/cases/bulk-status"},{"title":"List Case Notes API","sidebarTitle":"List Case Notes","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/","href":"/management-api/cases/list-notes"},{"title":"Create Case Note API","sidebarTitle":"Create Case Note","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/","href":"/management-api/cases/create-note"}]},{"group":"Case Blueprints","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sliders.svg","pages":[{"title":"List Case Blueprints API","sidebarTitle":"List Case Blueprints","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/","href":"/management-api/case-blueprints/list"},{"title":"Create Case Blueprint API","sidebarTitle":"Create Case Blueprint","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/","href":"/management-api/case-blueprints/create"},{"title":"Draft case blueprint with AI API","sidebarTitle":"Draft with AI","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/","href":"/management-api/case-blueprints/ai-draft"},{"title":"Install Blueprint Presets API","sidebarTitle":"Install Blueprint Presets","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/","href":"/management-api/case-blueprints/install-presets"}]},{"group":"Networks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/link.svg","pages":[{"title":"List Fraud Networks API","sidebarTitle":"List Networks","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/","href":"/management-api/networks/list"},{"title":"Get Fraud Network API","sidebarTitle":"Get Network","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/","href":"/management-api/networks/get"},{"title":"Add a Tag to a Fraud Network API","sidebarTitle":"Add Network Tag","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/","href":"/management-api/networks/add-tag"},{"title":"Remove a Tag from a Fraud Network API","sidebarTitle":"Remove Network Tag","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/","href":"/management-api/networks/remove-tag"},{"title":"Fraud Network Graph API","sidebarTitle":"Get Network Graph","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/","href":"/management-api/networks/graph"},{"title":"List Fraud Network Members API","sidebarTitle":"List Network Members","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/","href":"/management-api/networks/members"},{"title":"List Fraud Network Signals API","sidebarTitle":"List Network Signals","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/","href":"/management-api/networks/signals"},{"title":"Fraud Network Timeline API","sidebarTitle":"Get Network Timeline","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/","href":"/management-api/networks/timeline"},{"title":"Fraud Network Map API","sidebarTitle":"Get Network Map","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/","href":"/management-api/networks/map"},{"title":"Network Membership Lookup API","sidebarTitle":"Membership Lookup","href":"/management-api/networks/membership-lookup"}]},{"group":"Async reports","pages":[{"title":"List Async Reports API","sidebarTitle":"List reports","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/reports/","href":"/management-api/reports/list"},{"title":"Retrieve Async Report API","sidebarTitle":"Retrieve report","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/reports/{report_uuid}/","href":"/management-api/reports/retrieve"},{"title":"Retry Async Report API","sidebarTitle":"Retry report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/reports/{report_uuid}/retry/","href":"/management-api/reports/retry"}]},{"group":"Report Templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/task-square.svg","pages":[{"title":"List Report Templates API","sidebarTitle":"List Report Templates","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/report-templates/","href":"/management-api/report-templates/list"},{"title":"Create Report Template API","sidebarTitle":"Create Report Template","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/report-templates/","href":"/management-api/report-templates/create"}]},{"group":"Regulatory Reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/search-file.svg","pages":[{"title":"Create FIU Report From Case API","sidebarTitle":"Create Report From Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/","href":"/management-api/regulatory-reports/create-for-case"},{"title":"List FIU Reports API","sidebarTitle":"List Reports","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/","href":"/management-api/regulatory-reports/list"},{"title":"Validate FIU Report API","sidebarTitle":"Validate Report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/","href":"/management-api/regulatory-reports/validate"},{"title":"Finalize FIU Report API","sidebarTitle":"Finalize Report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/","href":"/management-api/regulatory-reports/finalize"},{"title":"Delete FIU Report API","sidebarTitle":"Delete Report","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/","href":"/management-api/regulatory-reports/delete"},{"title":"Get FIU Report Download URL API","sidebarTitle":"Get Report Download URL","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/","href":"/management-api/regulatory-reports/download-url"}]},{"group":"Transactions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"List Transactions API: KYT Monitoring","sidebarTitle":"List Transactions","openapi":"openapi-25.json GET /v3/transactions/","href":"/management-api/transactions/list"},{"title":"Create Transaction API: KYT Submission","sidebarTitle":"Create Transaction","openapi":"openapi-25.json POST /v3/transactions/","href":"/management-api/transactions/create"},{"title":"Batch Delete Transactions API","sidebarTitle":"Batch Delete Transactions","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/","href":"/management-api/transactions/delete"},{"title":"Get Transaction API: KYT Detail","sidebarTitle":"Get Transaction","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/","href":"/management-api/transactions/get"},{"title":"List Transaction Notes API","sidebarTitle":"List Transaction Notes","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/notes/","href":"/management-api/transactions/list-notes"},{"title":"Create Transaction Note API","sidebarTitle":"Create Transaction Note","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/notes/","href":"/management-api/transactions/create-note"},{"title":"List Related Transactions API","sidebarTitle":"List Related Transactions","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/related/","href":"/management-api/transactions/list-related"},{"title":"Transaction PDF Report API","sidebarTitle":"Generate Transaction PDF Report","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/","href":"/management-api/transactions/generate-pdf"},{"title":"Screen Wallet API: On-demand Crypto AML","sidebarTitle":"Screen Wallet","openapi":"openapi-25.json POST /v3/wallet-screening/","href":"/management-api/transactions/screen-wallet"},{"title":"Wallet Screening PDF Report API","sidebarTitle":"Screen Wallet PDF","openapi":"openapi-25.json POST /v3/wallet-screening/pdf/","href":"/management-api/transactions/screen-wallet-pdf"},{"title":"Mint SDK Transaction Token API: Client-Side KYT","sidebarTitle":"Mint SDK Transaction Token","openapi":"openapi-25.json POST /v3/transactions/sdk-token/","href":"/management-api/transactions/sdk-token"},{"title":"Submit Transaction from an SDK: Client-Side KYT","sidebarTitle":"Submit Transaction (SDK Token)","openapi":"openapi-25.json POST /v1/transactions/","href":"/management-api/transactions/submit-sdk"},{"title":"Get Transaction from an SDK: Client-Side KYT","sidebarTitle":"Get Transaction (SDK Token)","openapi":"openapi-25.json GET /v1/transactions/{transaction_id}/","href":"/management-api/transactions/get-sdk"},{"title":"List Transaction Monitoring Rules API","sidebarTitle":"List Rules","openapi":"openapi-25.json GET /v3/transactions/rules/","href":"/management-api/transactions/rules-list"},{"title":"Create Transaction Monitoring Rule API - KYT Rules","sidebarTitle":"Create Rule","openapi":"openapi-25.json POST /v3/transactions/rules/","href":"/management-api/transactions/rules-create"},{"title":"Get Transaction Monitoring Rule API","sidebarTitle":"Get Rule","openapi":"openapi-25.json GET /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-get"},{"title":"Update Transaction Monitoring Rule API","sidebarTitle":"Update Rule","openapi":"openapi-25.json PATCH /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-update"},{"title":"Delete Transaction Monitoring Rule API","sidebarTitle":"Delete Rule","openapi":"openapi-25.json DELETE /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-delete"},{"title":"Backtest Transaction Monitoring Rules API","sidebarTitle":"Backtest Rules","openapi":"openapi-25.json POST /v3/transactions/rules/backtest/","href":"/management-api/transactions/rules-backtest"},{"title":"Transaction Monitoring Rule Library API - 150+ Presets","sidebarTitle":"List Rule Library","openapi":"openapi-25.json GET /v3/transactions/rules/library/","href":"/management-api/transactions/rules-library"},{"title":"Install Preset Transaction Monitoring Rules API","sidebarTitle":"Install Library Rules","openapi":"openapi-25.json POST /v3/transactions/rules/install/","href":"/management-api/transactions/rules-install"},{"title":"Uninstall Preset Transaction Monitoring Rules API","sidebarTitle":"Uninstall Library Rules","openapi":"openapi-25.json DELETE /v3/transactions/rules/install/","href":"/management-api/transactions/rules-uninstall"}]},{"group":"Monitoring Events","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"List Monitoring Events API","sidebarTitle":"List Monitoring Events","openapi":"openapi-25.json GET /v3/events/","href":"/management-api/monitoring-events/list"},{"title":"Create Monitoring Event API","sidebarTitle":"Create Monitoring Event","openapi":"openapi-25.json POST /v3/events/","href":"/management-api/monitoring-events/create"},{"title":"Batch Monitoring Events API","sidebarTitle":"Create Monitoring Events in Batch","openapi":"openapi-25.json POST /v3/events/batch/","href":"/management-api/monitoring-events/create-batch"},{"title":"Mint Monitoring SDK Token API","sidebarTitle":"Mint Monitoring SDK Token","openapi":"openapi-25.json POST /v3/events/sdk-token/","href":"/management-api/monitoring-events/sdk-token"},{"title":"Get Monitoring Event API","sidebarTitle":"Get Monitoring Event","openapi":"openapi-25.json GET /v3/events/{event_uuid}/","href":"/management-api/monitoring-events/get"},{"title":"Subject Event Timeline API","sidebarTitle":"Get Subject Event Timeline","openapi":"openapi-25.json GET /v3/events/subjects/{vendor_data}/","href":"/management-api/monitoring-events/subject-timeline"},{"title":"Event Enrichment Metrics API","sidebarTitle":"Get Event Enrichment Metrics","openapi":"openapi-25.json GET /v3/events/enrichment-metrics/","href":"/management-api/monitoring-events/enrichment-metrics"},{"title":"Delete Monitoring Event API","sidebarTitle":"Delete Monitoring Event","openapi":"openapi-25.json DELETE /v3/events/{event_uuid}/delete/","href":"/management-api/monitoring-events/delete"}]},{"group":"Travel Rule","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"Get Travel Rule Settings API: VASP Profile","sidebarTitle":"Get Travel Rule Settings","openapi":"openapi-25.json GET /v3/travel-rule/settings/","href":"/management-api/travel-rule/get-settings"},{"title":"Update Travel Rule Settings API: Enable \u0026 Configure","sidebarTitle":"Update Travel Rule Settings","openapi":"openapi-25.json PUT /v3/travel-rule/settings/","href":"/management-api/travel-rule/update-settings"},{"title":"Get Travel Rule Networks API","sidebarTitle":"Get Travel Rule Networks","openapi":"openapi-25.json GET /v3/travel-rule/networks/","href":"/management-api/travel-rule/get-networks"},{"title":"Get Travel Rule Network Questionnaire API","sidebarTitle":"Get Network Questionnaire","openapi":"openapi-25.json GET /v3/travel-rule/networks/questionnaire/","href":"/management-api/travel-rule/get-network-questionnaire"},{"title":"Save Travel Rule Network Questionnaire API","sidebarTitle":"Save Network Questionnaire Answers","openapi":"openapi-25.json PUT /v3/travel-rule/networks/questionnaire/","href":"/management-api/travel-rule/update-network-questionnaire"},{"title":"Submit Travel Rule Network Questionnaire API","sidebarTitle":"Submit Network Questionnaire","openapi":"openapi-25.json POST /v3/travel-rule/networks/questionnaire/submit/","href":"/management-api/travel-rule/submit-network-questionnaire"},{"title":"Request Travel Rule Network Access API","sidebarTitle":"Request a Travel Rule Network","openapi":"openapi-25.json POST /v3/travel-rule/networks/{network}/request/","href":"/management-api/travel-rule/request-network"},{"title":"Confirm the Travel Rule Compliance Email API","sidebarTitle":"Send the Compliance Email Confirmation","openapi":"openapi-25.json POST /v3/travel-rule/settings/compliance-email/confirmation/","href":"/management-api/travel-rule/send-compliance-email-confirmation"},{"title":"List Travel Rule Transfers API","sidebarTitle":"List Travel Rule Transfers","openapi":"openapi-25.json GET /v3/travel-rule/transfers/","href":"/management-api/travel-rule/list-transfers"},{"title":"List Unmatched Travel Rule Deposits API","sidebarTitle":"List Unmatched Deposits","openapi":"openapi-25.json GET /v3/travel-rule/unmatched/","href":"/management-api/travel-rule/list-unmatched-deposits"},{"title":"Match Travel Rule Deposit API: Pair a Message","sidebarTitle":"Match Unmatched Deposit","openapi":"openapi-25.json POST /v3/travel-rule/unmatched/{transaction_uuid}/match/","href":"/management-api/travel-rule/match-unmatched-deposit"},{"title":"Travel Rule Transfer Actions API: Finish, Resend, Update","sidebarTitle":"Finish, Cancel, Resend, or Update a Transfer","openapi":"openapi-25.json PATCH /v3/transactions/{transaction_id}/travel-rule/","href":"/management-api/travel-rule/update-transfer"},{"title":"Create or email a Travel Rule end-user link","sidebarTitle":"Create an end-user link","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/user-link/","href":"/management-api/travel-rule/create-user-link"},{"title":"Confirm Wallet Ownership API: Travel Rule Beneficiary","sidebarTitle":"Confirm or Deny Wallet Ownership","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/ownership/","href":"/management-api/travel-rule/confirm-ownership"},{"title":"List Travel Rule Messages API","sidebarTitle":"List Travel Rule Messages","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/travel-rule/messages/","href":"/management-api/travel-rule/list-messages"},{"title":"Travel Rule delivery history API","sidebarTitle":"List delivery history","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/travel-rule/deliveries/","href":"/management-api/travel-rule/list-deliveries"},{"title":"Send Travel Rule Message API","sidebarTitle":"Send a Travel Rule Message","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/messages/","href":"/management-api/travel-rule/create-message"},{"title":"Register Inbound Sunrise Transfer API: Travel Rule","sidebarTitle":"Register Inbound (Sunrise) Transfer","openapi":"openapi-25.json POST /v3/travel-rule/inbound/","href":"/management-api/travel-rule/register-inbound"},{"title":"Trigger Test VASP Inbound Transfer API","sidebarTitle":"Trigger Test VASP Inbound Transfer","openapi":"openapi-25.json POST /v3/travel-rule/test-vasp/inbound/","href":"/management-api/travel-rule/trigger-test-vasp-inbound"},{"title":"VASP Directory Search API: Travel Rule Routes","sidebarTitle":"Search the VASP Directory","openapi":"openapi-25.json GET /v3/travel-rule/vasps/","href":"/management-api/travel-rule/search-vasps"},{"title":"Create a private Travel Rule VASP entry","sidebarTitle":"Create a VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/","href":"/management-api/travel-rule/create-vasp"},{"title":"Get a VASP Directory Entry API: Travel Rule Routes","sidebarTitle":"Get a VASP Directory Entry","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/","href":"/management-api/travel-rule/get-vasp"},{"title":"Get a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Get Your Decision on a VASP","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/get-vasp-decision"},{"title":"Set a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Set Your Decision on a VASP","openapi":"openapi-25.json PUT /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/set-vasp-decision"},{"title":"Clear a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Clear Your Decision on a VASP","openapi":"openapi-25.json DELETE /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/clear-vasp-decision"},{"title":"Get a Counterparty VASP Screening API: Travel Rule","sidebarTitle":"Get a VASP's Entity Screening","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/screening/","href":"/management-api/travel-rule/get-vasp-screening"},{"title":"Screen a Counterparty VASP API: Sanctions Check","sidebarTitle":"Screen a Counterparty VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/{vasp_id}/screening/","href":"/management-api/travel-rule/screen-vasp"},{"title":"List VASP Due-Diligence Questionnaires API","sidebarTitle":"List Due-Diligence Questionnaires with a VASP","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/questionnaires/","href":"/management-api/travel-rule/list-vasp-questionnaires"},{"title":"Send a VASP Due-Diligence Questionnaire API","sidebarTitle":"Send a Due-Diligence Questionnaire to a VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/{vasp_id}/questionnaires/","href":"/management-api/travel-rule/send-vasp-questionnaire"},{"title":"List Counterparty Contacts API - Travel Rule Email Rail","sidebarTitle":"List Counterparty Contacts","openapi":"openapi-25.json GET /v3/travel-rule/counterparty-contacts/","href":"/management-api/travel-rule/list-counterparty-contacts"},{"title":"Add a Counterparty Contact API - Travel Rule Email Rail","sidebarTitle":"Add a Counterparty Contact","openapi":"openapi-25.json POST /v3/travel-rule/counterparty-contacts/","href":"/management-api/travel-rule/create-counterparty-contact"},{"title":"Delete a Counterparty Contact API - Travel Rule","sidebarTitle":"Delete a Counterparty Contact","openapi":"openapi-25.json DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/","href":"/management-api/travel-rule/delete-counterparty-contact"},{"title":"List Wallet Addresses API: Travel Rule Address Book","sidebarTitle":"List Wallet Addresses","openapi":"openapi-25.json GET /v3/travel-rule/wallet-addresses/","href":"/management-api/travel-rule/list-wallet-addresses"},{"title":"Register Wallet Address API: Travel Rule Address Book","sidebarTitle":"Register Wallet Address","openapi":"openapi-25.json POST /v3/travel-rule/wallet-addresses/","href":"/management-api/travel-rule/create-wallet-address"},{"title":"Import Wallet Addresses API: Travel Rule Address Book","sidebarTitle":"Import Wallet Addresses","openapi":"openapi-25.json POST /v3/travel-rule/wallet-addresses/import/","href":"/management-api/travel-rule/import-wallet-addresses"},{"title":"Update Wallet Address API: Travel Rule Address Book","sidebarTitle":"Update Wallet Address","openapi":"openapi-25.json PATCH /v3/travel-rule/wallet-addresses/{entry_uuid}/","href":"/management-api/travel-rule/update-wallet-address"},{"title":"Delete Wallet Address API: Travel Rule Address Book","sidebarTitle":"Delete Wallet Address","openapi":"openapi-25.json DELETE /v3/travel-rule/wallet-addresses/{entry_uuid}/","href":"/management-api/travel-rule/delete-wallet-address"},{"title":"List Screenshot Wallet Proofs API - Travel Rule Review","sidebarTitle":"List Wallet Proofs to Review","openapi":"openapi-25.json GET /v3/travel-rule/wallet-proofs/","href":"/management-api/travel-rule/list-wallet-proofs"},{"title":"Approve or Reject a Screenshot Wallet Proof API","sidebarTitle":"Decide a Wallet Proof","openapi":"openapi-25.json POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/","href":"/management-api/travel-rule/decide-wallet-proof"},{"title":"Mint Wallet-Ownership Widget API: Proof of Control","sidebarTitle":"Mint Wallet-Ownership Widget Session","openapi":"openapi-25.json POST /v3/travel-rule/widget-session/","href":"/management-api/travel-rule/create-widget-session"},{"title":"Get Wallet-Ownership Widget Context API","sidebarTitle":"Get Widget Context","openapi":"openapi-25.json GET /v3/travel-rule/widget/{token}/","href":"/management-api/travel-rule/get-widget-context"},{"title":"Start a Wallet-Ownership Proof API - Travel Rule Widget","sidebarTitle":"Start a Widget Proof","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/proofs/","href":"/management-api/travel-rule/create-widget-proof"},{"title":"Submit Wallet-Ownership Proof Evidence API - Travel Rule","sidebarTitle":"Submit Widget Proof Evidence","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/","href":"/management-api/travel-rule/verify-widget-proof"},{"title":"Widget VASP Selection API: Travel Rule Counterparty","sidebarTitle":"Pick the Counterparty VASP in the Wallet Widget","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/vasps/","href":"/management-api/travel-rule/select-widget-vasp"},{"title":"Widget VASP Picker API: Travel Rule Directory Search","sidebarTitle":"Search VASPs from the Wallet Widget","openapi":"openapi-25.json GET /v3/travel-rule/widget/{token}/vasps/","href":"/management-api/travel-rule/search-widget-vasps"},{"title":"Get Email Pickup Info API: Travel Rule Email Rail","sidebarTitle":"Get Email Pickup Info","openapi":"openapi-25.json GET /v3/travel-rule/pickup/{token}/","href":"/management-api/travel-rule/get-pickup"},{"title":"Respond to Email Pickup API: Travel Rule Email Rail","sidebarTitle":"Respond to Email Pickup","openapi":"openapi-25.json POST /v3/travel-rule/pickup/{token}/respond/","href":"/management-api/travel-rule/respond-pickup"},{"title":"List Pickup Messages API - Travel Rule Email Rail","sidebarTitle":"List Pickup Messages","openapi":"openapi-25.json GET /v3/travel-rule/pickup/{token}/messages/","href":"/management-api/travel-rule/list-pickup-messages"},{"title":"Reply in Pickup Portal API - Travel Rule Email Rail","sidebarTitle":"Reply in the Pickup Portal","openapi":"openapi-25.json POST /v3/travel-rule/pickup/{token}/messages/","href":"/management-api/travel-rule/create-pickup-message"},{"title":"Get Join Invitation API - Travel Rule Free Join","sidebarTitle":"Get Join Invitation","openapi":"openapi-25.json GET /v3/travel-rule/join/{token}/","href":"/management-api/travel-rule/get-join-invitation"},{"title":"Register a Free Travel Rule Account API","sidebarTitle":"Register a Free Travel Rule Account","openapi":"openapi-25.json POST /v3/travel-rule/join/{token}/","href":"/management-api/travel-rule/register-join"},{"title":"Verify a Free Travel Rule Account API","sidebarTitle":"Verify a Free Travel Rule Account","openapi":"openapi-25.json POST /v3/travel-rule/join/{token}/verify/","href":"/management-api/travel-rule/verify-join"},{"title":"Get Free Workspace API - Travel Rule Free Join","sidebarTitle":"Get Free Workspace","openapi":"openapi-25.json GET /v3/travel-rule/workspace/","href":"/management-api/travel-rule/get-workspace"},{"title":"Claim a Directory Entry API - Travel Rule Free Join","sidebarTitle":"Claim a Directory Entry","openapi":"openapi-25.json POST /v3/travel-rule/workspace/claim/","href":"/management-api/travel-rule/claim-workspace"},{"title":"Send Domain Code API - Travel Rule Free Join","sidebarTitle":"Send Domain Code","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/code/","href":"/management-api/travel-rule/send-workspace-domain-code"},{"title":"Confirm Domain Code API - Travel Rule Free Join","sidebarTitle":"Confirm Domain Code","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/confirm/","href":"/management-api/travel-rule/confirm-workspace-domain"},{"title":"Verify Domain by DNS API - Travel Rule Free Join","sidebarTitle":"Verify Domain by DNS","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/dns/","href":"/management-api/travel-rule/verify-workspace-domain-dns"},{"title":"Enable Outbound Billing API - Travel Rule Free Join","sidebarTitle":"Enable Outbound Billing","openapi":"openapi-25.json POST /v3/travel-rule/workspace/billing/","href":"/management-api/travel-rule/enable-workspace-billing"}]},{"group":"Session Operations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/play.svg","pages":[{"title":"Batch Delete Sessions API: KYC Cleanup","sidebarTitle":"Batch Delete Sessions","openapi":"openapi-25.json POST /v3/sessions/delete/","href":"/management-api/sessions/batch-delete"},{"title":"Get Session Deletion Job API","sidebarTitle":"Get Session Deletion Job","openapi":"openapi-25.json GET /v3/sessions/delete/{job_id}/","href":"/management-api/sessions/get-deletion-job"},{"title":"List Session Reviews API: KYC Audit Log","sidebarTitle":"List Session Reviews","openapi":"openapi-25.json GET /v3/sessions/{session_id}/reviews/","href":"/management-api/sessions/list-reviews"},{"title":"Create Session Review API: Manual KYC","sidebarTitle":"Create Session Review","openapi":"openapi-25.json POST /v3/sessions/{session_id}/reviews/","href":"/management-api/sessions/create-review"},{"title":"List Session Events API","sidebarTitle":"List Session Events","openapi":"openapi-25.json GET /v3/session/{sessionId}/events/","href":"/management-api/sessions/list-events"},{"title":"List Session Webhook Deliveries API","sidebarTitle":"List Session Webhook Deliveries","openapi":"openapi-25.json GET /v3/session/{sessionId}/webhooks/","href":"/management-api/sessions/list-webhooks"},{"title":"Get Session Webhook Delivery API","sidebarTitle":"Get Session Webhook Delivery","openapi":"openapi-25.json GET /v3/session/{sessionId}/webhook/{webhook_uuid}","href":"/management-api/sessions/get-webhook"},{"title":"Resend Session Webhook Delivery API","sidebarTitle":"Resend Session Webhook Delivery","openapi":"openapi-25.json POST /v3/session/{sessionId}/webhook/{webhook_uuid}/resend","href":"/management-api/sessions/resend-webhook"},{"title":"List AML Screening History API","sidebarTitle":"List AML Screening History","openapi":"openapi-25.json GET /v3/session/{sessionId}/aml-screening-history/","href":"/management-api/sessions/aml-screening-history"},{"title":"Export AML Screening History as CSV API","sidebarTitle":"Export AML Screening History","openapi":"openapi-25.json GET /v3/session/{sessionId}/aml-screening-history/export/","href":"/management-api/sessions/export-aml-screening-history"}]},{"group":"Customization","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sliders.svg","pages":[{"title":"Get Branding Customization API","sidebarTitle":"Get Branding","openapi":"openapi-25.json GET /v3/customization/","href":"/management-api/customization/get"},{"title":"Update Branding Customization API","sidebarTitle":"Update Branding","openapi":"openapi-25.json PATCH /v3/customization/","href":"/management-api/customization/update"}]},{"group":"Webhook","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/link.svg","pages":[{"title":"List Webhook Destinations API","sidebarTitle":"List Webhook Destinations","openapi":"openapi-25.json GET /v3/webhook/destinations/","href":"/management-api/webhook/list-destinations"},{"title":"Create Webhook Destination API","sidebarTitle":"Create Webhook Destination","openapi":"openapi-25.json POST /v3/webhook/destinations/","href":"/management-api/webhook/create-destination"},{"title":"Retrieve a Webhook Destination: Management API","sidebarTitle":"Get Webhook Destination","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/get-destination"},{"title":"Update Webhook Destination API","sidebarTitle":"Update Webhook Destination","openapi":"openapi-25.json PATCH /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/update-destination"},{"title":"Delete Webhook Destination API","sidebarTitle":"Delete Webhook Destination","openapi":"openapi-25.json DELETE /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/delete-destination"},{"title":"Get Webhook Configuration API","sidebarTitle":"Get Webhook Configuration","openapi":"openapi-25.json GET /v3/webhook/","href":"/management-api/webhook/get-config"},{"title":"Update Webhook Configuration API","sidebarTitle":"Update Webhook Configuration","openapi":"openapi-25.json PATCH /v3/webhook/","href":"/management-api/webhook/update-config"},{"title":"Webhook Destination Analytics API","sidebarTitle":"Get Webhook Destination Analytics","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/analytics/","href":"/management-api/webhook/destination-analytics"},{"title":"Webhook Destination Failure Activity API","sidebarTitle":"List destination activity","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/webhook/destinations/{destination_uuid}/activity/","href":"/management-api/webhook/destination-activity"},{"title":"List Webhook Deliveries API","sidebarTitle":"List Webhook Destination Deliveries","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/","href":"/management-api/webhook/list-deliveries"},{"title":"Get Webhook Delivery API","sidebarTitle":"Get Webhook Destination Delivery","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/","href":"/management-api/webhook/get-delivery"},{"title":"Resend Webhook Delivery API","sidebarTitle":"Resend Webhook Destination Delivery","openapi":"openapi-25.json POST /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/","href":"/management-api/webhook/resend-delivery"}]},{"group":"Billing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/billing.svg","pages":[{"title":"Get Credit Balance API: KYC Billing","sidebarTitle":"Get Credit Balance","openapi":"openapi-25.json GET /v3/billing/balance/","href":"/management-api/billing/balance"},{"title":"Top Up Credits API","sidebarTitle":"Top Up Credits","openapi":"openapi-25.json POST /v3/billing/top-up/","href":"/management-api/billing/top-up"}]},{"group":"Analytics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/overview.svg","pages":[{"title":"Application Analytics API","sidebarTitle":"Get Application Analytics","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/","href":"/management-api/analytics/get"},{"title":"Today's Verifications by Hour API","sidebarTitle":"Get Today's Verifications by Hour","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/today/","href":"/management-api/analytics/today-by-hour"}]},{"group":"Management API Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/info.svg","pages":[{"title":"Management API v3: Workflows \u0026 Billing","sidebarTitle":"Management API","href":"/sessions-api/management-api"}]},{"group":"Auth API (Programmatic)","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/key.svg","pages":[{"title":"Auth API: Programmatic Registration","sidebarTitle":"Register Account","openapi":"openapi-auth.json POST /programmatic/register/","href":"/auth-api/register"},{"title":"Verify Email API: Get Didit API Credentials","sidebarTitle":"Verify Email","openapi":"openapi-auth.json POST /programmatic/verify-email/","href":"/auth-api/verify-email"},{"title":"Programmatic Login API: Headless Auth Tokens","sidebarTitle":"Login","openapi":"openapi-auth.json POST /programmatic/login/","href":"/auth-api/login"},{"title":"Get Credentials API: Fetch client_id \u0026 api_key","sidebarTitle":"Get Credentials","openapi":"openapi-auth.json GET /organizations/me/{org_id}/applications/{app_id}/","href":"/auth-api/get-credentials"},{"title":"Create Application API: Programmatic Apps","sidebarTitle":"Create Application","openapi":"openapi-auth.json POST /organizations/me/{org_id}/applications/","href":"/auth-api/create-application"},{"title":"Update Application API: Manage Customer Apps","sidebarTitle":"Update Application","openapi":"openapi-auth.json PATCH /organizations/me/{org_id}/applications/{app_id}/","href":"/auth-api/update-application"}]},{"group":"Identity \u0026 Documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/id-scan.svg","pages":[{"title":"ID Verification API: Document OCR \u0026 Authenticity","sidebarTitle":"ID Verification API","openapi":"openapi-25.json POST /v3/id-verification/","href":"/standalone-apis/id-verification"},{"title":"Proof of Address API: POA Verification \u0026 OCR","sidebarTitle":"Proof of Address API","openapi":"openapi-25.json POST /v3/poa/","href":"/standalone-apis/proof-of-address"},{"title":"Address Validation API: Verify and Normalise Addresses","sidebarTitle":"Address Validation","openapi":"openapi-25.json POST /v3/address-validation/","href":"/standalone-apis/address-validation"}]},{"group":"Digital ID wallets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/id-scan.svg","pages":[{"title":"Digital ID Wallet Verification APIs","sidebarTitle":"Digital ID wallet APIs","href":"/standalone-apis/digital-id-wallets"},{"title":"Digital ID Wallet API Catalog","sidebarTitle":"List digital ID wallets","openapi":"openapi-25.json GET /v3/id-verification/wallets/","href":"/standalone-apis/digital-id-wallet-catalog"},{"group":"Start verification","pages":[{"title":"Bank iD CONNECT Verification API","sidebarTitle":"Bank iD CONNECT","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-cz/","href":"/api-reference/digital-id-wallets/bankid-cz"},{"title":"BankID Sweden Verification API","sidebarTitle":"BankID Sweden","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-se/","href":"/api-reference/digital-id-wallets/bankid-se"},{"title":"Finnish Trust Network Verification API","sidebarTitle":"Finnish Trust Network","openapi":"openapi-25.json POST /v3/id-verification/wallets/ftn/","href":"/api-reference/digital-id-wallets/ftn"},{"title":"Google Wallet ID Verification API","sidebarTitle":"Google Wallet ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/google-wallet/","href":"/api-reference/digital-id-wallets/google-wallet"},{"title":"MitID personal Verification API","sidebarTitle":"MitID personal","openapi":"openapi-25.json POST /v3/id-verification/wallets/mitid/","href":"/api-reference/digital-id-wallets/mitid"},{"title":"Mobile-ID Verification API","sidebarTitle":"Mobile-ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/mobile-id/","href":"/api-reference/digital-id-wallets/mobile-id"},{"title":"Smart-ID Verification API","sidebarTitle":"Smart-ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/smart-id/","href":"/api-reference/digital-id-wallets/smart-id"},{"title":"iDIN full identification Verification API","sidebarTitle":"iDIN full identification","openapi":"openapi-25.json POST /v3/id-verification/wallets/idin/","href":"/api-reference/digital-id-wallets/idin"},{"title":"Auðkenni Verification API","sidebarTitle":"Auðkenni","openapi":"openapi-25.json POST /v3/id-verification/wallets/audkenni/","href":"/api-reference/digital-id-wallets/audkenni"},{"title":"BankID Norway Verification API","sidebarTitle":"BankID Norway","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-no/","href":"/api-reference/digital-id-wallets/bankid-no"},{"title":"Buypass ID Verification API","sidebarTitle":"Buypass ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/buypass/","href":"/api-reference/digital-id-wallets/buypass"},{"title":"ConnectID Verification API","sidebarTitle":"ConnectID","openapi":"openapi-25.json POST /v3/id-verification/wallets/connectid/","href":"/api-reference/digital-id-wallets/connectid"},{"title":"Diia Verification API","sidebarTitle":"Diia","openapi":"openapi-25.json POST /v3/id-verification/wallets/diia/","href":"/api-reference/digital-id-wallets/diia"},{"title":"EUDI Wallet Verification API","sidebarTitle":"EUDI Wallet","openapi":"openapi-25.json POST /v3/id-verification/wallets/eudi/","href":"/api-reference/digital-id-wallets/eudi"},{"title":"Estonian ID-card Verification API","sidebarTitle":"Estonian ID-card","openapi":"openapi-25.json POST /v3/id-verification/wallets/idcard-ee/","href":"/api-reference/digital-id-wallets/idcard-ee"},{"title":"FranceConnect Verification API","sidebarTitle":"FranceConnect","openapi":"openapi-25.json POST /v3/id-verification/wallets/franceconnect/","href":"/api-reference/digital-id-wallets/franceconnect"},{"title":"Freja eID Verification API","sidebarTitle":"Freja eID","openapi":"openapi-25.json POST /v3/id-verification/wallets/frejaid/","href":"/api-reference/digital-id-wallets/frejaid"},{"title":"GOV.UK Wallet Verification API","sidebarTitle":"GOV.UK Wallet","openapi":"openapi-25.json POST /v3/id-verification/wallets/govuk-wallet/","href":"/api-reference/digital-id-wallets/govuk-wallet"},{"title":"MojeID Verification API","sidebarTitle":"MojeID","openapi":"openapi-25.json POST /v3/id-verification/wallets/mojeid/","href":"/api-reference/digital-id-wallets/mojeid"},{"title":"OneID Verification API","sidebarTitle":"OneID","openapi":"openapi-25.json POST /v3/id-verification/wallets/oneid/","href":"/api-reference/digital-id-wallets/oneid"},{"title":"Personalausweis Profile 2 Verification API","sidebarTitle":"Personalausweis Profile 2","openapi":"openapi-25.json POST /v3/id-verification/wallets/personalausweis/","href":"/api-reference/digital-id-wallets/personalausweis"},{"title":"UAE PASS Verification API","sidebarTitle":"UAE PASS","openapi":"openapi-25.json POST /v3/id-verification/wallets/uae-pass/","href":"/api-reference/digital-id-wallets/uae-pass"},{"title":"Vipps Plus Verification API","sidebarTitle":"Vipps Plus","openapi":"openapi-25.json POST /v3/id-verification/wallets/vipps/","href":"/api-reference/digital-id-wallets/vipps"},{"title":"eParaksts mobile Verification API","sidebarTitle":"eParaksts mobile","openapi":"openapi-25.json POST /v3/id-verification/wallets/eparaksts-mobile/","href":"/api-reference/digital-id-wallets/eparaksts-mobile"},{"title":"gov.br Verification API","sidebarTitle":"gov.br","openapi":"openapi-25.json POST /v3/id-verification/wallets/govbr/","href":"/api-reference/digital-id-wallets/govbr"},{"title":"itsme Verification API","sidebarTitle":"itsme","openapi":"openapi-25.json POST /v3/id-verification/wallets/itsme/","href":"/api-reference/digital-id-wallets/itsme"}]},{"title":"Get Digital ID Wallet Verification Result","sidebarTitle":"Get wallet verification","openapi":"openapi-25.json GET /v3/id-verification/wallets/verifications/{request_id}/","href":"/standalone-apis/digital-id-wallet-result"},{"title":"Submit a Digital Credentials Wallet Response","sidebarTitle":"Submit wallet response","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/response/","href":"/standalone-apis/digital-id-wallet-response"},{"title":"Poll Smart-ID and Mobile-ID Authentication","sidebarTitle":"Poll wallet verification","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/poll/","href":"/standalone-apis/digital-id-wallet-poll"},{"title":"Cancel Digital ID Wallet Verification","sidebarTitle":"Cancel wallet verification","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/cancel/","href":"/standalone-apis/digital-id-wallet-cancel"}]},{"group":"Document AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/document-ai.svg","pages":[{"title":"Document AI API: Custom Document Data Extraction","sidebarTitle":"Document AI API","openapi":"openapi-25.json POST /v3/document-ai/","href":"/standalone-apis/document-ai"}]},{"group":"Database Validation API","pages":[{"title":"Database Validation API: National ID Match","sidebarTitle":"Database Validation API","openapi":"openapi-25.json POST /v3/database-validation/","href":"/standalone-apis/database-validation"}]},{"group":"Database Validation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/driver-2.svg","pages":[{"group":"🇦🇷 Argentina","pages":[{"title":"Argentina - DNI data verification API: Data Match","sidebarTitle":"Argentina - DNI data verification (RENAPER, no selfie)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/renaper-data"},{"title":"Argentina - DNI verification (RENAPER) API","sidebarTitle":"Argentina - DNI verification (RENAPER)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/renaper"},{"title":"Argentina Citizens (AFIP) Verification API","sidebarTitle":"Argentina Citizens (AFIP)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/citizens"},{"title":"Argentina Credit Bureau Verification API: ID Match","sidebarTitle":"Argentina Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/credit-bureau"}]},{"group":"🇦🇺 Australia","pages":[{"title":"Australia Credit Bureau Verification API: ID Match","sidebarTitle":"Australia Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/credit-bureau"},{"title":"Australia Death Check (BDM) API: Real-Time Lookup","sidebarTitle":"Australia Death Check (BDM)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/death-check"},{"title":"Australia Electoral Roll Verification API: ID Match","sidebarTitle":"Australia Electoral Roll","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/electoral-roll"},{"title":"Australia Superannuation \u0026 Payroll Verification API","sidebarTitle":"Australia Superannuation \u0026 Payroll","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/superannuation-payroll"},{"title":"Australia VEVO Verification API: Real-Time Lookup","sidebarTitle":"Australia VEVO","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/vevo"}]},{"group":"🇦🇹 Austria","pages":[{"title":"Austria Credit Bureau Verification API: Data Match","sidebarTitle":"Austria Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/austria/credit-bureau"}]},{"group":"🇧🇴 Bolivia","pages":[{"title":"Bolivia - CI verification API: Real-Time ID Lookup","sidebarTitle":"Bolivia - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/bolivia/cedula"}]},{"group":"🇧🇷 Brazil","pages":[{"title":"BRA - Unico IDCloud (CPF + selfie) Verification API","sidebarTitle":"BRA - Unico IDCloud (CPF + selfie)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/unico-idcloud"},{"title":"Brazil - CNH QR code + face match (Datavalid) API","sidebarTitle":"Brazil - CNH QR code + face match (Datavalid)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cnh-facial-qrcode"},{"title":"Brazil - CPF + face match (Datavalid) API: ID Match","sidebarTitle":"Brazil - CPF + face match (Datavalid)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cpf-facial"},{"title":"Brazil - CPF status check API: Real-Time ID Lookup","sidebarTitle":"Brazil - CPF status check","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cpf"},{"title":"Brazil - Company Partners and Directors (QSA) API","sidebarTitle":"Brazil - Company Partners and Directors (QSA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/company-directors"},{"title":"Brazil - Company Registry Lookup (CNPJ) API","sidebarTitle":"Brazil - Company Registry Lookup (CNPJ)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/company-registry"},{"title":"Brazil - Death Check (CPF) API: Real-Time ID Lookup","sidebarTitle":"Brazil - Death Check (CPF)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/death-check"},{"title":"Brazil - Federal Criminal Record Verification API","sidebarTitle":"Brazil - Federal Criminal Record (Polícia Federal)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/antecedentes-criminais-pf"},{"title":"Brazil Residential Verification API: Identity Match","sidebarTitle":"Brazil Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/residential"},{"title":"Brazil Tax Registration (CPF/CNPJ) Verification API","sidebarTitle":"Brazil Tax Registration (CPF/CNPJ)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/tax-registration"}]},{"group":"🇰🇭 Cambodia","pages":[{"title":"Cambodia National ID Verification API: Data Match","sidebarTitle":"Cambodia National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/cambodia/national-id"}]},{"group":"🇨🇦 Canada","pages":[{"title":"Canada Credit Bureau (FINTRAC) Verification API","sidebarTitle":"Canada Credit Bureau (FINTRAC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/credit-bureau-fintrac"},{"title":"Canada Credit Bureau 2 (Non-FINTRAC) API: ID Match","sidebarTitle":"Canada Credit Bureau 2 (Non-FINTRAC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/credit-bureau-2-non-fintrac"},{"title":"Canada Residential Verification API: Identity Match","sidebarTitle":"Canada Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/residential"}]},{"group":"🇨🇱 Chile","pages":[{"title":"Chile - RUT verification API: Real-Time ID Lookup","sidebarTitle":"Chile - RUT verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/chile/rut"}]},{"group":"🇨🇳 China","pages":[{"title":"China Bank Card Verification API: Real-Time Lookup","sidebarTitle":"China Bank Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/bank-card"},{"title":"China National ID Verification API: Identity Lookup","sidebarTitle":"China National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/national-id"},{"title":"China Passport Verification API: Real-Time Lookup","sidebarTitle":"China Passport Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/passport-verification"},{"title":"China Phone Verification API: Real-Time ID Lookup","sidebarTitle":"China Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/phone"}]},{"group":"🇨🇴 Colombia","pages":[{"title":"Colombia - Cédula verification API: Identity Lookup","sidebarTitle":"Colombia - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/colombia/cedula"},{"title":"Colombia - Migración Colombia foreigner status API","sidebarTitle":"Colombia - Migración Colombia foreigner status","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/colombia/migracion"}]},{"group":"🇨🇷 Costa Rica","pages":[{"title":"Costa Rica - Cédula verification API: Data Match","sidebarTitle":"Costa Rica - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/costa-rica/cedula"}]},{"group":"🇩🇰 Denmark","pages":[{"title":"Denmark Consumer 2 Verification API: Identity Match","sidebarTitle":"Denmark Consumer 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/denmark/consumer-2"},{"title":"Denmark National ID Verification API: Data Match","sidebarTitle":"Denmark National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/denmark/national-id"}]},{"group":"🇩🇴 Dominican Republic","pages":[{"title":"Dominican Republic - Cédula verification API","sidebarTitle":"Dominican Republic - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/dominican-republic/cedula"}]},{"group":"🇪🇨 Ecuador","pages":[{"title":"Ecuador - Cédula verification API: Real-Time Lookup","sidebarTitle":"Ecuador - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/ecuador/cedula"}]},{"group":"🇸🇻 El Salvador","pages":[{"title":"El Salvador - DUI verification API: Identity Lookup","sidebarTitle":"El Salvador - DUI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/el-salvador/dui"}]},{"group":"🇫🇮 Finland","pages":[{"title":"Finland Consumer 2 Verification API: Identity Match","sidebarTitle":"Finland Consumer 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/finland/consumer-2"},{"title":"Finland National ID Verification API: Data Match","sidebarTitle":"Finland National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/finland/national-id"}]},{"group":"🇫🇷 France","pages":[{"title":"France Phone Verification API: Real-Time ID Lookup","sidebarTitle":"France Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/phone"},{"title":"France Residential Verification API: Identity Match","sidebarTitle":"France Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/residential"},{"title":"France Utility Verification API: Real-Time Lookup","sidebarTitle":"France Utility","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/utility"}]},{"group":"🇩🇪 Germany","pages":[{"title":"Germany Credit Bureau Verification API: Data Match","sidebarTitle":"Germany Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/germany/credit-bureau"},{"title":"Germany Phone 2 Verification API: Real-Time Lookup","sidebarTitle":"Germany Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/germany/phone-2"}]},{"group":"🌐 Global","pages":[{"title":"Global - Core Intelligence Service Verification API","sidebarTitle":"Global - Core Intelligence Service","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/global/intelligence-service"},{"title":"Global - Sim Swap Verification API: Telco Match","sidebarTitle":"Global - Sim Swap","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/global/swap"}]},{"group":"🇬🇹 Guatemala","pages":[{"title":"Guatemala - DPI + face match (RENAP) API: ID Match","sidebarTitle":"Guatemala - DPI + face match (RENAP)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/guatemala/dpi-facial"},{"title":"Guatemala - DPI verification API: Real-Time Lookup","sidebarTitle":"Guatemala - DPI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/guatemala/dpi"}]},{"group":"🇭🇳 Honduras","pages":[{"title":"Honduras - DNI verification API: Real-Time Lookup","sidebarTitle":"Honduras - DNI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/honduras/dni"}]},{"group":"🇮🇳 India","pages":[{"title":"India Aadhaar (UIDAI) Verification API: Data Match","sidebarTitle":"India Aadhaar (UIDAI)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/aadhaar"},{"title":"India Drivers Licence (RTO) Verification API","sidebarTitle":"India Drivers Licence (RTO)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/drivers-licence"},{"title":"India EPIC (Voter's Registration) (ECI) API","sidebarTitle":"India EPIC (Voter's Registration) (ECI)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/epic-voter-s-registration"},{"title":"India PAN (Permanent Account Number) (ITD) API","sidebarTitle":"India PAN (Permanent Account Number) (ITD)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/pan-permanent-account-number"}]},{"group":"🇮🇩 Indonesia","pages":[{"title":"Indonesia Residential Identity Card Verification API","sidebarTitle":"Indonesia Residential Identity Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/indonesia/residential-identity-card"}]},{"group":"🇮🇹 Italy","pages":[{"title":"Italy Credit Bureau Verification API: Header Match","sidebarTitle":"Italy Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/italy/credit-bureau"},{"title":"Italy Residential Verification API: Identity Lookup","sidebarTitle":"Italy Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/italy/residential"}]},{"group":"🇰🇪 Kenya","pages":[{"title":"Kenya National ID Verification API: Identity Lookup","sidebarTitle":"Kenya National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/kenya/national-id"}]},{"group":"🇲🇾 Malaysia","pages":[{"title":"Malaysia National ID Verification API: Data Match","sidebarTitle":"Malaysia National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/malaysia/national-id"}]},{"group":"🇲🇽 Mexico","pages":[{"title":"Mexico - CURP verification API: Real-Time ID Lookup","sidebarTitle":"Mexico - CURP verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/mexico/curp"},{"title":"Mexico - INE credential validity verification API","sidebarTitle":"Mexico - INE credential validity verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/mexico/ine-vigencia"}]},{"group":"🇳🇱 Netherlands","pages":[{"title":"Netherlands Residential Verification API: ID Match","sidebarTitle":"Netherlands Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/netherlands/residential"}]},{"group":"🇳🇿 New Zealand","pages":[{"title":"DIA - New Zealand Births Verification API: ID Match","sidebarTitle":"DIA - New Zealand Births","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/births"},{"title":"DIA - New Zealand Citizenship Verification API","sidebarTitle":"DIA - New Zealand Citizenship","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/citizenship"},{"title":"DIA - New Zealand Passport Verification API","sidebarTitle":"DIA - New Zealand Passport","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/passport"},{"title":"New Zealand Death Check (BDM) API: Real-Time Lookup","sidebarTitle":"New Zealand Death Check (BDM)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/death-check"},{"title":"New Zealand Drivers Licence (NZTA) Verification API","sidebarTitle":"New Zealand Drivers Licence (NZTA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/drivers-licence"}]},{"group":"🇳🇬 Nigeria","pages":[{"title":"Nigeria Bank Verification Number (BVN) API","sidebarTitle":"Nigeria Bank Verification Number (BVN)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/bank-verification-number"},{"title":"Nigeria Driver's Licence (FRSC) Verification API","sidebarTitle":"Nigeria Driver's Licence (FRSC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/drivers-license"},{"title":"Nigeria International Passport (NIS) API: ID Match","sidebarTitle":"Nigeria International Passport (NIS)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/passport"},{"title":"Nigeria National ID (NIMC) Verification API","sidebarTitle":"Nigeria National ID (NIMC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/national-id"},{"title":"Nigeria National ID + Selfie (NIMC) Verification API","sidebarTitle":"Nigeria National ID + Selfie (NIMC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/national-id-facial"}]},{"group":"🇳🇴 Norway","pages":[{"title":"Norway Residential Verification API: Identity Match","sidebarTitle":"Norway Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/norway/residential"}]},{"group":"🇵🇦 Panama","pages":[{"title":"Panama - Cédula with biometric face-match API","sidebarTitle":"Panama - Cédula with biometric face-match (SIB Plus, elevated tier)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/panama/sib-plus"},{"title":"Panama - Cédula with biometric face-match (SIB) API","sidebarTitle":"Panama - Cédula with biometric face-match (SIB)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/panama/sib"}]},{"group":"🇵🇾 Paraguay","pages":[{"title":"Paraguay - CI verification API: Real-Time ID Lookup","sidebarTitle":"Paraguay - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/paraguay/cedula"}]},{"group":"🇵🇪 Peru","pages":[{"title":"Peru - DNI verification API: Real-Time ID Lookup","sidebarTitle":"Peru - DNI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/peru/dni"},{"title":"Peru Tax Registration (SUNAT) Verification API","sidebarTitle":"Peru Tax Registration (SUNAT)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/peru/tax-registration"}]},{"group":"🇵🇭 Philippines","pages":[{"title":"Philippines Residential Verification API: ID Match","sidebarTitle":"Philippines Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/philippines/residential"}]},{"group":"🇸🇬 Singapore","pages":[{"title":"Singapore Credit Bureau Verification API: ID Match","sidebarTitle":"Singapore Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/singapore/credit-bureau"},{"title":"Singapore Utility Verification API: Identity Lookup","sidebarTitle":"Singapore Utility","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/singapore/utility"}]},{"group":"🇿🇦 South Africa","pages":[{"title":"South Africa - Bank Account Holder Verification API","sidebarTitle":"South Africa - Bank Account Holder Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/bank-account-holder"},{"title":"South Africa - Company Directors Lookup API","sidebarTitle":"South Africa - Company Directors Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/company-directors"},{"title":"South Africa - Company Registry Lookup API","sidebarTitle":"South Africa - Company Registry Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/company-registry"},{"title":"South Africa - Contactability Lookup API: ID Match","sidebarTitle":"South Africa - Contactability Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/contactability"},{"title":"South Africa - Criminal Screening by Face API","sidebarTitle":"South Africa - Criminal Screening by Face","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/criminal-face-screening"},{"title":"South Africa - DHA Fingerprint Match API: ID Match","sidebarTitle":"South Africa - DHA Fingerprint Match","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/dha-fingerprint-match"},{"title":"South Africa - DHA Photo Retrieval Verification API","sidebarTitle":"South Africa - DHA Photo Retrieval","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/dha-photo"},{"title":"South Africa - Driving License Verification API","sidebarTitle":"South Africa - Driving License Verification","href":"/api-reference/database-validation/south-africa/drivers-license"},{"title":"South Africa - Fraud Prevention Screening API","sidebarTitle":"South Africa - Fraud Prevention Screening","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/fraud-prevention"},{"title":"South Africa - Person Directorships Lookup API","sidebarTitle":"South Africa - Person Directorships Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/person-directorships"},{"title":"South Africa - Refugee File Verification API","sidebarTitle":"South Africa - Refugee File Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/refugee"},{"title":"South Africa - Vehicle Ownership Verification API","sidebarTitle":"South Africa - Vehicle Ownership Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/vehicle-ownership"},{"title":"South Africa National ID (DHA) Verification API","sidebarTitle":"South Africa National ID (DHA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/national-id"}]},{"group":"🇪🇸 Spain","pages":[{"title":"Spain - DNI/NIE verification API: Real-Time Lookup","sidebarTitle":"Spain - DNI/NIE verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/spain/dni"}]},{"group":"🇸🇪 Sweden","pages":[{"title":"Sweden National ID Verification API: Identity Match","sidebarTitle":"Sweden National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/sweden/national-id"},{"title":"Sweden Phone Verification API: Real-Time ID Lookup","sidebarTitle":"Sweden Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/sweden/phone"}]},{"group":"🇨🇭 Switzerland","pages":[{"title":"Switzerland Credit Bureau Verification API","sidebarTitle":"Switzerland Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/switzerland/credit-bureau"}]},{"group":"🇹🇭 Thailand","pages":[{"title":"Thailand National ID Verification API: Data Match","sidebarTitle":"Thailand National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/thailand/national-id"}]},{"group":"🇬🇧 United Kingdom","pages":[{"title":"United Kingdom Credit Bureau Verification API","sidebarTitle":"United Kingdom Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/credit-bureau"},{"title":"United Kingdom Financial Services Verification API","sidebarTitle":"United Kingdom Financial Services","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/financial-services"},{"title":"United Kingdom Phone 2 Verification API: Data Match","sidebarTitle":"United Kingdom Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/phone-2"},{"title":"United Kingdom Residential Verification API","sidebarTitle":"United Kingdom Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/residential"}]},{"group":"🇺🇸 United States","pages":[{"title":"United States - Driver's License (DMV) API","sidebarTitle":"United States - Driver's License (DMV)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/driver-license-dmv"},{"title":"United States Credit Bureau Verification API","sidebarTitle":"United States of America - United States Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/credit-bureau"},{"title":"United States Death Check (SSDMF) API: Data Match","sidebarTitle":"United States of America - United States Death Check (SSDMF)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/death-check"},{"title":"United States Financial Services Verification API","sidebarTitle":"United States of America - United States Financial Services","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/financial-services"},{"title":"United States Phone 2 Verification API: Data Match","sidebarTitle":"United States of America - United States Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/phone-2"},{"title":"United States Residential Verification API","sidebarTitle":"United States of America - United States Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/residential"}]},{"group":"🇺🇾 Uruguay","pages":[{"title":"Uruguay - CI verification API: Real-Time ID Lookup","sidebarTitle":"Uruguay - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/uruguay/cedula"}]},{"group":"🇻🇪 Venezuela","pages":[{"title":"Venezuela - Cédula verification API: Identity Match","sidebarTitle":"Venezuela - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/venezuela/cedula"}]},{"group":"🌐 Zambia","pages":[{"title":"Zambia NRC (tax register) Verification API","sidebarTitle":"Zambia NRC (tax register)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/zambia/national-id"}]}]},{"group":"Biometrics \u0026 Face","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/liveness.svg","pages":[{"title":"Passive Liveness API: Deepfake Detection","sidebarTitle":"Passive Liveness","openapi":"openapi-25.json POST /v3/passive-liveness/","href":"/standalone-apis/passive-liveness"},{"title":"Face Match API: 1:1 Face Comparison","sidebarTitle":"Face Match","openapi":"openapi-25.json POST /v3/face-match/","href":"/standalone-apis/face-match"},{"title":"Face Search API: 1:N Facial Dedup \u0026 Fraud Rings","sidebarTitle":"Face Search","openapi":"openapi-25.json POST /v3/face-search/","href":"/standalone-apis/face-search"},{"title":"Age Estimation API: Selfie-Based Age Verification","sidebarTitle":"Age Estimation API","openapi":"openapi-25.json POST /v3/age-estimation/","href":"/standalone-apis/age-estimation"}]},{"group":"Compliance \u0026 Risk","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/aml-screening.svg","pages":[{"title":"AML Screening API: Sanctions, PEP \u0026 Watchlists","sidebarTitle":"AML Screening API","openapi":"openapi-25.json POST /v3/aml/","href":"/standalone-apis/aml-screening"},{"title":"AML Dataset Freshness API","sidebarTitle":"Get AML Dataset Freshness","openapi":"openapi-25.json GET /v3/aml/dataset-freshness/","href":"/standalone-apis/aml-dataset-freshness"},{"title":"Fraud Check API","openapi":"openapi-25.json POST /v3/fraud/checks/","href":"/standalone-apis/fraud-check"},{"title":"Plan a Fraud Check","openapi":"openapi-25.json POST /v3/fraud/checks/plan/","href":"/standalone-apis/fraud-check-plan"},{"title":"Get a Fraud Check","openapi":"openapi-25.json GET /v3/fraud/checks/{check_id}/","href":"/standalone-apis/fraud-check-result"}]},{"group":"Device \u0026 IP Analysis","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/ip-analysis.svg","pages":[{"title":"IP Risk API: Geo, VPN \u0026 Datacenter Signals","sidebarTitle":"IP Risk API","openapi":"openapi-25.json POST /v3/ip/risk/","href":"/standalone-apis/ip-risk"}]},{"group":"KYB Registry","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/businesses.svg","pages":[{"title":"KYB Registry API: Company Search and Select","sidebarTitle":"Overview","href":"/standalone-apis/kyb-registry"},{"title":"KYB Registry Search API - Company Search","sidebarTitle":"KYB Registry Search","openapi":"openapi-25.json POST /v3/kyb/search/","href":"/standalone-apis/kyb-registry-search"},{"title":"KYB Registry Select API: Retrieve Company Profile","sidebarTitle":"KYB Registry Select","openapi":"openapi-25.json POST /v3/kyb/select/","href":"/standalone-apis/kyb-registry-select"},{"title":"KYB Registry Shareholders API","sidebarTitle":"KYB Registry Shareholders","openapi":"openapi-25.json POST /v3/kyb/shareholders/","href":"/standalone-apis/kyb-registry-shareholders"},{"title":"KYB Registry UBO API: Ultimate Beneficial Owners","sidebarTitle":"KYB Registry UBOs","openapi":"openapi-25.json POST /v3/kyb/ubo/","href":"/standalone-apis/kyb-registry-ubo"}]},{"group":"Email Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sms-tracking.svg","pages":[{"title":"Email Verification API: OTP \u0026 Risk Scoring","sidebarTitle":"Overview","href":"/standalone-apis/email-verification"},{"title":"Send Email OTP API: Email Verification Code","sidebarTitle":"Send Email Code","openapi":"openapi-25.json POST /v3/email/send/","href":"/standalone-apis/email-send"},{"title":"Check Email OTP API: Validate Email Code","sidebarTitle":"Check Email Code","openapi":"openapi-25.json POST /v3/email/check/","href":"/standalone-apis/email-check"},{"title":"Email Risk API: Deliverability \u0026 Breach Signals","sidebarTitle":"Email Risk API","openapi":"openapi-25.json POST /v3/email/risk/","href":"/standalone-apis/email-risk"}]},{"group":"Phone Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/phone-verification.svg","pages":[{"title":"Phone Verification API: SMS OTP \u0026 Risk Signals","sidebarTitle":"Overview","href":"/standalone-apis/phone-verification"},{"title":"Send Phone OTP API: SMS Verification Code","sidebarTitle":"Send Phone Code","openapi":"openapi-25.json POST /v3/phone/send/","href":"/standalone-apis/phone-send"},{"title":"Check Phone OTP API: Validate SMS Code","sidebarTitle":"Check Phone Code","openapi":"openapi-25.json POST /v3/phone/check/","href":"/standalone-apis/phone-check"},{"title":"Phone Risk API: Carrier \u0026 Fraud Signals","sidebarTitle":"Phone Risk API","openapi":"openapi-25.json POST /v3/phone/risk/","href":"/standalone-apis/phone-risk"}]},{"group":"Bank Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/billing.svg","pages":[{"title":"Account Check API: Verify a Payout Bank Account","sidebarTitle":"Account Check API","openapi":"openapi-25.json POST /v3/bank/account-check/","href":"/standalone-apis/bank-account-check"},{"title":"Bank Data API: Links, Connections, Accounts and Transactions","sidebarTitle":"Overview","href":"/standalone-apis/bank-data"},{"group":"Links","pages":[{"title":"Create a Bank Link API: Connect or Renew a Bank","sidebarTitle":"Create a link","openapi":"openapi-25.json POST /v3/bank/links/","href":"/standalone-apis/bank-link-create"},{"title":"Get a Bank Link API: Status and Connection Id","sidebarTitle":"Get a link","openapi":"openapi-25.json GET /v3/bank/links/{id}/","href":"/standalone-apis/bank-link-get"},{"title":"Cancel a Bank Link API: Stop an Unfinished Link","sidebarTitle":"Cancel a link","openapi":"openapi-25.json POST /v3/bank/links/{id}/cancel/","href":"/standalone-apis/bank-link-cancel"}]},{"group":"Connections","pages":[{"title":"List Bank Connections API: Filter by Status and Consent","sidebarTitle":"List connections","openapi":"openapi-25.json GET /v3/bank/connections/","href":"/standalone-apis/bank-connections-list"},{"title":"Get a Bank Connection API: Consent, Sync and Accounts","sidebarTitle":"Get a connection","openapi":"openapi-25.json GET /v3/bank/connections/{id}/","href":"/standalone-apis/bank-connection-get"},{"title":"Refresh a Bank Connection API: Sync Now","sidebarTitle":"Refresh a connection","openapi":"openapi-25.json POST /v3/bank/connections/{id}/refresh/","href":"/standalone-apis/bank-connection-refresh"},{"title":"Renew a Bank Connection API: Create a Renew Link","sidebarTitle":"Renew a connection","openapi":"openapi-25.json POST /v3/bank/connections/{id}/renew/","href":"/standalone-apis/bank-connection-renew"},{"title":"Revoke a Bank Connection API: Stop Access","sidebarTitle":"Revoke a connection","openapi":"openapi-25.json POST /v3/bank/connections/{id}/revoke/","href":"/standalone-apis/bank-connection-revoke"},{"title":"Delete a Bank Connection API: Stop Access and Erase Data","sidebarTitle":"Delete a connection","openapi":"openapi-25.json DELETE /v3/bank/connections/{id}/","href":"/standalone-apis/bank-connection-delete"},{"title":"List Bank Sync Runs API: What Each Sync Did","sidebarTitle":"List sync runs","openapi":"openapi-25.json GET /v3/bank/connections/{id}/sync-runs/","href":"/standalone-apis/bank-sync-runs-list"},{"title":"Get a Bank Sync Run API: Results per Account","sidebarTitle":"Get a sync run","openapi":"openapi-25.json GET /v3/bank/connections/{id}/sync-runs/{sync_id}/","href":"/standalone-apis/bank-sync-run-get"}]},{"group":"Accounts and transactions","pages":[{"title":"List Bank Accounts API: Accounts of a Connection","sidebarTitle":"List accounts","openapi":"openapi-25.json GET /v3/bank/connections/{id}/accounts/","href":"/standalone-apis/bank-accounts-list"},{"title":"Get a Bank Account API: Identifiers, Holders and Sync","sidebarTitle":"Get an account","openapi":"openapi-25.json GET /v3/bank/accounts/{account_id}/","href":"/standalone-apis/bank-account-get"},{"title":"Get Bank Account Balances API: Booked and Available","sidebarTitle":"Get balances","openapi":"openapi-25.json GET /v3/bank/accounts/{account_id}/balances/","href":"/standalone-apis/bank-account-balances"},{"title":"List Bank Transactions API: Date Range, Booked and Pending","sidebarTitle":"List transactions","description":"Didit's List Transactions endpoint reads an account's transactions for a date range, booked and pending, with page-token pagination.","openapi":"openapi-25.json GET /v3/bank/accounts/{account_id}/transactions/","href":"/standalone-apis/bank-account-transactions"},{"title":"Bank Transactions Change Feed API: Added, Modified, Removed","sidebarTitle":"Transactions change feed","openapi":"openapi-25.json GET /v3/bank/connections/{id}/transactions/sync/","href":"/standalone-apis/bank-transactions-sync"}]},{"group":"Banks and coverage","pages":[{"title":"List Banks API: Institutions and Capabilities","sidebarTitle":"List institutions","description":"Didit's List Institutions endpoint returns banks per country with what each supports: segments, ongoing access, consent length, history depth and the fields...","openapi":"openapi-25.json GET /v3/bank/institutions/","href":"/standalone-apis/bank-institutions-list"},{"title":"Get a Bank API: One Institution and Its Capabilities","sidebarTitle":"Get an institution","openapi":"openapi-25.json GET /v3/bank/institutions/{id}/","href":"/standalone-apis/bank-institution-get"},{"title":"Bank Data Coverage API: Capabilities per Country","sidebarTitle":"Get coverage","openapi":"openapi-25.json GET /v3/bank/coverage/","href":"/standalone-apis/bank-coverage"}]}]}]},{"tab":"User Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/user-verifications.svg","pages":[{"title":"User Verification","href":"/core-technology/liveness/overview"}]},{"tab":"Business Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/business-verifications.svg","pages":[{"title":"Business Verification","href":"/business-verification/overview"}]},{"tab":"Transaction Monitoring","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"Transaction Monitoring","href":"/transaction-monitoring/overview"}]},{"tab":"Authentication","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/authentication.svg","pages":[{"title":"Authentication","href":"/authentication/overview"}]},{"tab":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/calendar.svg","pages":[{"title":"Changelog","href":"/changelog"}]}],"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/overview"},{"anchor":"Business Console","icon":"gauge","href":"https://business.didit.me"},{"anchor":"OpenAPI Spec","icon":"file-code","href":"https://docs.didit.me/openapi-25.json"},{"anchor":"Integration Prompt","icon":"wand-magic-sparkles","href":"/integration/integration-prompt"},{"anchor":"MCP Server","icon":"plug","href":"/integration/mcp/overview"},{"anchor":"Agent Skills","icon":"robot","href":"https://github.com/didit-protocol/skills"}]}},{"language":"es","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Soporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sesión","href":"https://business.didit.me"}},"pages":[{"title":"es","href":"/es/standalone-apis/bank-transactions-sync"}]},{"language":"pt-BR","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Entrar","href":"https://business.didit.me"}},"pages":[{"title":"pt-BR","href":"/pt-br/standalone-apis/bank-transactions-sync"}]},{"language":"ja","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"サポート"},{"icon":"signal","href":"https://status.didit.me","label":"ステータス"}],"primary":{"type":"button","label":"サインイン","href":"https://business.didit.me"}},"pages":[{"title":"ja","href":"/ja/standalone-apis/bank-transactions-sync"}]},{"language":"de","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Anmelden","href":"https://business.didit.me"}},"pages":[{"title":"de","href":"/de/standalone-apis/bank-transactions-sync"}]},{"language":"fr","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Assistance"},{"icon":"signal","href":"https://status.didit.me","label":"Statut"}],"primary":{"type":"button","label":"Se connecter","href":"https://business.didit.me"}},"pages":[{"title":"fr","href":"/fr/standalone-apis/bank-transactions-sync"}]},{"language":"it","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Supporto"},{"icon":"signal","href":"https://status.didit.me","label":"Stato"}],"primary":{"type":"button","label":"Accedi","href":"https://business.didit.me"}},"pages":[{"title":"it","href":"/it/standalone-apis/bank-transactions-sync"}]},{"language":"pt","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sessão","href":"https://business.didit.me"}},"pages":[{"title":"pt","href":"/pt/standalone-apis/bank-transactions-sync"}]},{"language":"ca","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suport"},{"icon":"signal","href":"https://status.didit.me","label":"Estat"}],"primary":{"type":"button","label":"Inicia la sessió","href":"https://business.didit.me"}},"pages":[{"title":"ca","href":"/ca/standalone-apis/bank-transactions-sync"}]},{"language":"id","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Dukungan"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Masuk","href":"https://business.didit.me"}},"pages":[{"title":"id","href":"/id/standalone-apis/bank-transactions-sync"}]},{"language":"ru","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Поддержка"},{"icon":"signal","href":"https://status.didit.me","label":"Статус"}],"primary":{"type":"button","label":"Вход","href":"https://business.didit.me"}},"pages":[{"title":"ru","href":"/ru/standalone-apis/bank-transactions-sync"}]},{"language":"ko","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"지원"},{"icon":"signal","href":"https://status.didit.me","label":"상태"}],"primary":{"type":"button","label":"로그인","href":"https://business.didit.me"}},"pages":[{"title":"ko","href":"/ko/standalone-apis/bank-transactions-sync"}]},{"language":"zh","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"支持"},{"icon":"signal","href":"https://status.didit.me","label":"状态"}],"primary":{"type":"button","label":"登录","href":"https://business.didit.me"}},"pages":[{"title":"zh","href":"/zh/standalone-apis/bank-transactions-sync"}]},{"language":"ar","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"الدعم"},{"icon":"signal","href":"https://status.didit.me","label":"الحالة"}],"primary":{"type":"button","label":"تسجيل الدخول","href":"https://business.didit.me"}},"pages":[{"title":"ar","href":"/ar/standalone-apis/bank-transactions-sync"}]},{"language":"hi","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"सहायता"},{"icon":"signal","href":"https://status.didit.me","label":"स्थिति"}],"primary":{"type":"button","label":"साइन इन करें","href":"https://business.didit.me"}},"pages":[{"title":"hi","href":"/hi/standalone-apis/bank-transactions-sync"}]}]},"basePath":"","title":"Bank Transactions Change Feed API: Added, Modified, Removed - Didit Docs","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","CodeSnippet-B373COAT.js","getApiPlaygroundDisplay-CfL-UuDS.js","Page-DuqezyvM.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js","Markdown-Dy9a8hT8.js","AssistantPageLink-87tSPwGm.js","dist-CXMB3QQU.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}