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.
Headers
Idempotency-Key
string
Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409idempotency_key_reused, and while the first request is still running, 409idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.
Required string length: 1 - 255
Body
application/json
chain
string
required
Chain the deposit settled on, for example ETH. Stored lowercase and compared case-insensitively with your wallet address book entries, so use the same chain token there.
Maximum string length: 32
txid
string
required
On-chain transaction hash. Deduped together with wallet_address.
Maximum string length: 128
wallet_address
string
required
The destination wallet you received the deposit on. An XRP X-address is split into its classic address and tag.
Maximum string length: 128
amount
string
required
Deposit amount as a decimal string, zero or greater, with up to 18 decimal places.
currency
string
required
Deposit asset, e.g. "USDC".
Maximum string length: 16
originator_data
object
Originator details from the sending VASP, if known, as a flat object such as {"name": "..."}. Didit reads name (or full_name), first_name, last_name and vendor_data from it.
beneficiary_data
object
Beneficiary details (your customer), as a flat object such as {"name": "..."}. Didit matches name against the holder_name of the matched address book entry, and sets wallet_address and chain from the request.
originating_vasp
object
Optional description of the sending VASP. It stays on this transfer only (metadata.originating_vasp, and the transfer's originator VASP in GET /v3/travel-rule/transfers/); it never creates, edits or links a shared VASP directory entry.
Show child attributes
memo
string
Optional. The deposit's destination tag or memo on a memo network: on a shared deposit address it is what tells your customers apart, and the address-book entry for that memo is matched. XRP: a destination tag, a whole number from 0 to 4294967295 (a JSON number is accepted). XLM: a text memo of up to 28 bytes, a 64-bit id or a 32-byte hash in hex. EOS: up to 256 bytes. ATOM: up to 256 characters. HBAR: up to 100 bytes. Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin and Lightning wallets take no memo: one there is a 400. Alias: destinationTag or destination_tag.
Maximum string length: 256
utxo
object
Optional, UTXO chains only. The deposit transaction's inputs and outputs: the sender's wallet is the declared originator_data.wallet_address, else the largest input.
Show child attributes
Response
A transfer for this txid and wallet_address was already registered; the existing one is returned unchanged (created is false).
transaction_id
string<uuid>
Didit transaction UUID for the inbound deposit.
txn_id
string
txn_id of the inbound transaction: Didit-generated when Didit created the transaction, or your own when an unclaimed deposit was reused.
created
boolean
true when this call registered the transfer (HTTP 201); false when a transfer for the same txid and wallet_address already existed (HTTP 200).
travel_rule
object
Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. While an inbound transfer's wallet ownership is unconfirmed, the counterparty's originator_data and beneficiary_data come back masked (the first letter of each word is kept; the wallet, chain and VASP routing stay readable) and data_masked is true.
Show child attributes
Last modified on November 11, 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":"6b02cd3fe22a015b940409e4","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"ar","tag":"مرجع API","count":430},{"language":"ca","tag":"Referència de l'API","count":430},{"language":"de","tag":"API-Referenz","count":430},{"language":"es","tag":"Referencia de la API","count":430},{"language":"fr","tag":"Référence API","count":430},{"language":"hi","tag":"API संदर्भ","count":430},{"language":"id","tag":"Referensi API","count":430},{"language":"it","tag":"Riferimento API","count":430},{"language":"ja","tag":"APIリファレンス","count":430},{"language":"ko","tag":"API 레퍼런스","count":430},{"language":"pt-BR","tag":"Referência da API","count":430},{"language":"pt","tag":"Referência da API","count":430},{"language":"ru","tag":"Справочник API","count":430},{"language":"zh","tag":"API 参考","count":430},{"language":"en","tag":"API Reference","count":422},{"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":"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":"ko","tag":"인증","count":93},{"language":"en","tag":"Get Started","count":87},{"language":"ar","tag":"ابدأ الآن","count":87},{"language":"fr","tag":"Commencer","count":87},{"language":"hi","tag":"शुरू करें","count":87},{"language":"id","tag":"Mulai","count":87},{"language":"it","tag":"Inizia","count":87},{"language":"pt","tag":"Começar","count":87},{"language":"zh","tag":"快速开始","count":87},{"language":"en","tag":"User Verification","count":74},{"language":"ar","tag":"التحقق من المستخدمين","count":74},{"language":"ca","tag":"Verificació d'usuaris","count":74},{"language":"de","tag":"Benutzerverifizierung","count":74},{"language":"es","tag":"Verificación de usuarios","count":74},{"language":"fr","tag":"Vérification des utilisateurs","count":74},{"language":"hi","tag":"उपयोगकर्ता सत्यापन","count":74},{"language":"id","tag":"Verifikasi Pengguna","count":74},{"language":"it","tag":"Verifica degli utenti","count":74},{"language":"ja","tag":"ユーザー認証","count":74},{"language":"ko","tag":"사용자 인증","count":74},{"language":"pt-BR","tag":"Verificação de usuários","count":74},{"language":"pt","tag":"Verificação de utilizadores","count":74},{"language":"ru","tag":"Проверка пользователей","count":74},{"language":"zh","tag":"用户验证","count":74},{"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":"Verification","count":48},{"language":"ar","tag":"التحقق","count":48},{"language":"ca","tag":"Verificació","count":48},{"language":"de","tag":"Verifizierung","count":48},{"language":"es","tag":"Verificación","count":48},{"language":"fr","tag":"Vérification","count":48},{"language":"hi","tag":"सत्यापन","count":48},{"language":"id","tag":"Verifikasi","count":48},{"language":"it","tag":"Verifica","count":48},{"language":"ja","tag":"検証","count":48},{"language":"pt-BR","tag":"Verificação","count":48},{"language":"pt","tag":"Verificação","count":48},{"language":"ru","tag":"Верификация","count":48},{"language":"zh","tag":"验证","count":48},{"language":"en","tag":"Integrate / SDKs","count":47},{"language":"ar","tag":"التكامل / SDKs","count":47},{"language":"ca","tag":"Integració / SDK","count":47},{"language":"de","tag":"Integrieren / SDKs","count":47},{"language":"es","tag":"Integración / SDKs","count":47},{"language":"fr","tag":"Intégrer / SDK","count":47},{"language":"hi","tag":"इंटीग्रेट करें / SDK","count":47},{"language":"id","tag":"Integrasi / SDK","count":47},{"language":"it","tag":"Integrazione / SDK","count":47},{"language":"ja","tag":"連携 / SDK","count":47},{"language":"ko","tag":"연동 / SDK","count":47},{"language":"pt-BR","tag":"Integração / SDKs","count":47},{"language":"pt","tag":"Integrar / SDKs","count":47},{"language":"ru","tag":"Интеграция / SDK","count":47},{"language":"zh","tag":"集成 / SDK","count":47},{"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":"Digital ID wallets","count":35},{"language":"en","tag":"User and Business Verifications","count":35},{"language":"ar","tag":"محافظ الهوية الرقمية","count":35},{"language":"ar","tag":"التحقق من المستخدمين والشركات","count":35},{"language":"ca","tag":"Carteres d'identitat digital","count":35},{"language":"ca","tag":"Verificacions d'usuaris i empreses","count":35},{"language":"de","tag":"Digitale ID-Wallets","count":35},{"language":"de","tag":"Benutzer- und Unternehmensverifizierungen","count":35},{"language":"es","tag":"Wallets de identidad digital","count":35},{"language":"es","tag":"Verificaciones de usuarios y empresas","count":35},{"language":"fr","tag":"Portefeuilles d'identité numérique","count":35},{"language":"fr","tag":"Vérifications des utilisateurs et des entreprises","count":35},{"language":"hi","tag":"डिजिटल ID वॉलेट","count":35},{"language":"hi","tag":"उपयोगकर्ता और व्यवसाय सत्यापन","count":35},{"language":"id","tag":"Dompet ID Digital","count":35},{"language":"id","tag":"Verifikasi Pengguna dan Bisnis","count":35},{"language":"it","tag":"Wallet di identità digitale","count":35},{"language":"it","tag":"Verifiche di utenti e aziende","count":35},{"language":"ja","tag":"デジタルIDウォレット","count":35},{"language":"ja","tag":"ユーザーと企業の認証","count":35},{"language":"ko","tag":"디지털 신분증 지갑","count":35},{"language":"ko","tag":"사용자 인증 및 기업 확인","count":35},{"language":"pt-BR","tag":"Carteiras de identidade digital","count":35},{"language":"pt","tag":"Carteiras de identidade digital","count":35},{"language":"pt","tag":"Verificações de utilizadores e empresas","count":35},{"language":"ru","tag":"Цифровые ID-кошельки","count":35},{"language":"ru","tag":"Верификация пользователей и компаний","count":35},{"language":"zh","tag":"数字身份钱包","count":35},{"language":"zh","tag":"用户与企业验证","count":35},{"language":"ko","tag":"기능","count":34}]},"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":"management-api/travel-rule/register-inbound","slug":"/management-api/travel-rule/register-inbound","pageMetadata":{"title":"Register Inbound Sunrise Transfer API: Travel Rule","sidebarTitle":"Register Inbound (Sunrise) Transfer","description":"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.","keywords":["sunrise registration API","inbound travel rule transfer","after-deposit registration","travel rule backfill","unreachable VASP deposit","Didit Management API"],"openapi":"openapi-25.json POST /v3/travel-rule/inbound/","href":"/management-api/travel-rule/register-inbound"},"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: \"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\"\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const __snippet_AGENT_PROMPT_LABELS_qsruim={en:{copy:`Copy`,copied:`Copied`,copyTitle:`Copy prompt to clipboard`,copiedTitle:`Copied!`,pasteInto:`Paste into`},es:{copy:`Copiar`,copied:`Copiado`,copyTitle:`Copiar el prompt al portapapeles`,copiedTitle:`¡Copiado!`,pasteInto:`Pegar en`},\"pt-BR\":{copy:`Copiar`,copied:`Copiado`,copyTitle:`Copiar o prompt para a área de transferência`,copiedTitle:`Copiado!`,pasteInto:`Colar em`},ja:{copy:`コピー`,copied:`コピーしました`,copyTitle:`プロンプトをクリップボードにコピー`,copiedTitle:`コピーしました`,pasteInto:`貼り付け先`},\"de\":{copy:`Kopieren`,copied:`Kopiert`,copyTitle:`Prompt in die Zwischenablage kopieren`,copiedTitle:`Kopiert!`,pasteInto:`Einfügen in`},\"fr\":{copy:`Copier`,copied:`Copié`,copyTitle:`Copier le prompt dans le presse-papiers`,copiedTitle:`Copié !`,pasteInto:`Coller dans`},\"it\":{copy:`Copia`,copied:`Copiato`,copyTitle:`Copia il prompt negli appunti`,copiedTitle:`Copiato!`,pasteInto:`Incolla in`},\"pt-PT\":{copy:`Copiar`,copied:`Copiado`,copyTitle:`Copiar o prompt para a área de transferência`,copiedTitle:`Copiado!`,pasteInto:`Colar em`},\"ca\":{copy:`Copia`,copied:`Copiat`,copyTitle:`Copia el prompt al porta-retalls`,copiedTitle:`Copiat!`,pasteInto:`Enganxa a`},\"id\":{copy:`Salin`,copied:`Disalin`,copyTitle:`Salin prompt ke papan klip`,copiedTitle:`Disalin!`,pasteInto:`Tempel ke`},\"ru\":{copy:`Копировать`,copied:`Скопировано`,copyTitle:`Скопировать промпт в буфер обмена`,copiedTitle:`Скопировано!`,pasteInto:`Вставьте в`},\"ko\":{copy:`복사`,copied:`복사됨`,copyTitle:`프롬프트를 클립보드에 복사`,copiedTitle:`복사됨!`,pasteInto:`붙여넣을 곳`},\"zh\":{copy:`复制`,copied:`已复制`,copyTitle:`将提示词复制到剪贴板`,copiedTitle:`已复制!`,pasteInto:`粘贴到`},\"ar\":{copy:`نسخ`,copied:`تم النسخ`,copyTitle:`نسخ الموجّه إلى الحافظة`,copiedTitle:`تم النسخ!`,pasteInto:`الصق في`},\"hi\":{copy:`कॉपी करें`,copied:`कॉपी हो गया`,copyTitle:`प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें`,copiedTitle:`कॉपी हो गया!`,pasteInto:`यहाँ पेस्ट करें`}};const AgentPromptAccordion=({prompt,title=`AI Agent Integration Prompt`,lang=`en`})=>{const[copied,setCopied]=React.useState(false);const labels=__snippet_AGENT_PROMPT_LABELS_qsruim[lang]||__snippet_AGENT_PROMPT_LABELS_qsruim.en;const handleCopy=e=>{e.stopPropagation();if(!prompt)return;navigator.clipboard.writeText(prompt.trim()).then(()=>{setCopied(true);setTimeout(()=>setCopied(false),2e3)})};const agents=[`Claude Code`,`Codex`,`Cursor`,`Devin`,`Windsurf`,`GitHub Copilot`];return _jsxs(`div`,{className:`didit-agent-card`,children:[_jsxs(`div`,{className:`didit-agent-titlebar`,children:[_jsxs(`div`,{className:`didit-agent-dots`,\"aria-hidden\":`true`,children:[_jsx(`span`,{className:`didit-agent-dot didit-agent-dot-red`}),_jsx(`span`,{className:`didit-agent-dot didit-agent-dot-yellow`}),_jsx(`span`,{className:`didit-agent-dot didit-agent-dot-green`})]}),_jsx(`span`,{className:`didit-agent-filename`,children:title}),_jsx(`button`,{type:`button`,className:`didit-agent-copy ${copied?`didit-agent-copy-copied`:``}`,onClick:handleCopy,title:labels.copyTitle,\"aria-label\":copied?labels.copiedTitle:labels.copyTitle,children:copied?_jsxs(_Fragment,{children:[_jsx(`svg`,{width:`13`,height:`13`,viewBox:`0 0 16 16`,fill:`none`,children:_jsx(`path`,{d:`M3 8.5l3.5 3.5L13 4`,stroke:`currentColor`,strokeWidth:`2`,strokeLinecap:`round`,strokeLinejoin:`round`})}),_jsx(`span`,{children:labels.copied})]}):_jsxs(_Fragment,{children:[_jsxs(`svg`,{width:`13`,height:`13`,viewBox:`0 0 16 16`,fill:`none`,children:[_jsx(`rect`,{x:`5`,y:`5`,width:`9`,height:`9`,rx:`1.5`,stroke:`currentColor`,strokeWidth:`1.5`}),_jsx(`path`,{d:`M11 5V3.5A1.5 1.5 0 0 0 9.5 2h-6A1.5 1.5 0 0 0 2 3.5v6A1.5 1.5 0 0 0 3.5 11H5`,stroke:`currentColor`,strokeWidth:`1.5`})]}),_jsx(`span`,{children:labels.copy})]})})]}),_jsx(`pre`,{className:`didit-agent-body`,children:_jsx(`code`,{children:prompt.trim()})}),_jsxs(`div`,{className:`didit-agent-footer`,children:[_jsx(`span`,{className:`didit-agent-footer-label`,children:labels.pasteInto}),_jsx(`div`,{className:`didit-agent-chips`,children:agents.map(name=>_jsx(`span`,{className:`didit-agent-chip`,children:name},name))})]})]})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`AgentPromptAccordion`,children:_jsx(AgentPromptAccordion,{title:`Register Inbound Sunrise Transfer API Prompt`,prompt:`Register Travel Rule data for a crypto deposit that settled on-chain BEFORE any exchange took place - because the sending VASP was unreachable at the time (the sunrise problem), or when backfilling historical deposits.\n\nEndpoint:\nPOST https://verification.didit.me/v3/travel-rule/inbound/\n\nAuthentication:\nUse the x-api-key header with my Didit API key. You are the beneficiary VASP.\n\nRequest body (application/json):\n{\n\"chain\": \"ETH\", // required; stored lowercased and matched case-insensitively against your address-book entries' chain\n\"txid\": \"0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060\", // dedupe key: same txid + wallet_address returns the existing transfer\n\"wallet_address\": \"0x8ba1f109551bD432803012645Ac136ddd64DBA72\", // an XRP X-address is split into its classic address and tag\n\"memo\": \"\", // optional destination tag or memo: on a shared deposit address it names your customer\n\"amount\": \"500.00\",\n\"currency\": \"USDC\",\n\"originator_data\": { \"name\": \"Origin CASP SL\" }, // flat originator details from the sender, if known (name or full_name, first_name, last_name, vendor_data)\n\"beneficiary_data\": { \"name\": \"Ana Diaz\" }, // flat beneficiary details (your customer); name is matched against the entry's holder_name\n\"originating_vasp\": { \"name\": \"Origin CASP SL\", \"lei\": \"984500ABCDEF12345634\", \"travel_address\": \"taHg7hkTmJ4mTpdQxn61H9cyx6RreB2jrDHeB3pkioRRBgKQaSAGUzp73FVsmEXXJVxdAuCCWiBEFMkcB4MCtcyjnpbyEbTeSHwym394NMS7ev\" }, // optional sender identity\n\"utxo\": { \"inputs\": [ { \"address\": \"bc1q...\", \"amount\": \"0.5\" } ], \"outputs\": [ { \"address\": \"bc1q...\", \"amount\": \"0.25\" } ] } // optional, BTC/LTC/BCH/DOGE only\n}\n\nBehavior:\n- Creates an inbound travelRule transaction (or reuses an unclaimed recorded deposit) and resolves it against your wallet address book, by the address and its memo (an entry with exactly that memo first, else one for the whole address; a deposit without a memo never reaches an entry that has one):\n- no matching entry -> ON_HOLD\n- entry exists, ownership unproven -> UNCONFIRMED_OWNERSHIP\n- name does not match the entry's holder_name -> COUNTERPARTY_MISMATCHED_DATA\n- verified entry + name match -> COMPLETED then immediately FINISHED (the deposit already settled).\n- The address-book match is chain-scoped: an entry matches when its chain equals the request chain (case-insensitive) or the entry's chain is blank, and \"ethereum\" does not match \"ETH\".\n- Resolve ON_HOLD (and UNCONFIRMED_OWNERSHIP) with POST /v3/transactions/{transaction_id}/travel-rule/ownership/.\n{\"confirmed\": true} registers or verifies the wallet entry and runs the name match; {\"confirmed\": false} declines the transfer.\nON_HOLD does not change the transaction status by itself; only a rule that acts on the Travel Rule status changes it (for example the opt-in library preset travel-rule-pending-action sets AWAITING_USER).\n- Naming originating_vasp keeps the sender's identity on this transfer (metadata.originating_vasp, and the transfer's originator VASP in GET /v3/travel-rule/transfers/); it never creates or changes a shared VASP directory entry.\noriginating_vasp.lei must be a valid 20-character LEI (ISO 17442) or blank, and originating_vasp.travel_address must be a valid travel address or blank.\nAn inbound TRP inquiry does not create or change its sender's directory entry either.\n- Webhooks: when a new transaction was created, transaction.created is sent first and travel_rule.status.updated follows for each status transition.\nEach webhook is delivered and retried on its own, so do not rely on arrival order; key on transaction_id.\n- Billing: there is no base fee.\nA newly created deposit is screened and charged the Wallet Verification \u0026 Screening rate only when crypto monitoring is enabled and chain is one Didit can screen (btc, eth, sol, trx, matic, bnb, ltc, xrp, bch, doge, or their full names such as bitcoin or ethereum).\nSandbox applications are never charged.\n- utxo: the sender's wallet is originator_data.wallet_address when you declare it, else the input address that contributed the most. The result is on travel_rule.chain_details.\n\nWhat to read from the response:\n- transaction_id - the Didit transaction uuid, used in /v3/transactions/{transaction_id}/ calls.\n- txn_id - tr-in-{first 80 characters of txid}-{12 hex characters} for a new transaction, or the existing txn_id of a reused recorded deposit.\n- created - true (201) when this call registered the deposit, false (200) when the same txid + wallet_address was already registered.\n- travel_rule - the full transfer object: uuid, status, direction, rail, protocol, ivms_version, required, ownership_confirmed, deadline_at, timeline, counterparty_vasp, originator_data, beneficiary_data, delivery, deliveries, deliveries_truncated, discovery, reason, next_actions, created_at.\ndeliveries is the newest 100 delivery entries, oldest first (uuid, kind, status, supplier-neutral rail, created_at, delivered_at, detail_lines); deliveries_truncated is true when older entries were omitted.\nbeneficiary_data includes the wallet_address and the lowercased chain.\noriginator_data and beneficiary_data stay masked in the response (data_masked: true) until wallet ownership is confirmed.\n- travel_rule.status - the resolved state (see above).\n\nFailure modes:\n- 400 - a missing required field (chain, txid, wallet_address, amount, currency), an invalid originating_vasp.lei, or an invalid travel address (\"Invalid travel address.\").\n- 403 - missing x-api-key (a wrong, revoked or expired key gets 401).\n\nFull guide: /transaction-monitoring/travel-rule#after-deposit-sunrise-registration.`})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{__snippet_AGENT_PROMPT_LABELS_qsruim,AgentPromptAccordion,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Register Inbound Sunrise Transfer API: Travel Rule","sidebarTitle":"Register Inbound (Sunrise) Transfer","description":"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.","keywords":["sunrise registration API","inbound travel rule transfer","after-deposit registration","travel rule backfill","unreachable VASP deposit","Didit Management API"],"openapi":"openapi-25.json POST /v3/travel-rule/inbound/","href":"/management-api/travel-rule/register-inbound"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[19,69,"jsx:_jsx}=arguments["],[171,4204,"undefined;const AgentPromptAccordion=()=>null;function _crea"]]},"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":"Register an after-deposit (sunrise) inbound transfer","description":"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.","operationId":"registerTravelRuleInbound","x-didit-sdk":{"resource":"travel_rule","method":"register_inbound","auth":"api_key","server":true},"tags":["Travel Rule"],"security":["7941e524-f359-44b3-9f2c-22522b012416"],"requestBody":"ae0e6125-69d0-459e-8fab-16dfb3285e64","x-codeSamples":[{"lang":"curl","label":"curl","source":"curl -X POST https://verification.didit.me/v3/travel-rule/inbound/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"chain\":\"ETH\",\"txid\":\"0xdeposit-hash\",\"wallet_address\":\"0xYourDepositWallet\",\"amount\":\"500.00\",\"currency\":\"USDC\"}'"},{"lang":"python","label":"Python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.register_inbound(\n chain=\"ETH\",\n txid=\"0xdeposit-hash\",\n wallet_address=\"0xYourDepositWallet\",\n amount=\"500.00\",\n currency=\"USDC\",\n originator_data={\"name\": \"Origin CASP SL\"},\n beneficiary_data={\"name\": \"Ana Diaz\"},\n originating_vasp={\n \"name\": \"Origin CASP SL\",\n \"lei\": \"\",\n \"travel_address\": \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\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.travelRule.registerInbound({\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nconsole.log(result);"},{"lang":"go","label":"Go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RegisterInbound(ctx, didit.TravelRuleRegisterInboundParams{\n\tBody: didit.TravelRuleInboundRequest{\n\t\tChain: \"ETH\",\n\t\tTxid: \"0xdeposit-hash\",\n\t\tWalletAddress: \"0xYourDepositWallet\",\n\t\tAmount: \"500.00\",\n\t\tCurrency: \"USDC\",\n\t\tOriginatorData: didit.Some(map[string]any{\"name\": \"Origin CASP SL\"}),\n\t\tBeneficiaryData: didit.Some(map[string]any{\"name\": \"Ana Diaz\"}),\n\t\tOriginatingVASP: didit.Some(didit.TravelRuleInboundRequestOriginatingVASP{\n\t\t\tName: didit.String(\"Origin CASP SL\"),\n\t\t\tLei: didit.String(\"\"),\n\t\t\tTravelAddress: didit.String(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\"),\n\t\t}),\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"lang":"java","label":"Java","source":"import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().registerInbound(TravelRuleInboundRequest.builder()\n .chain(\"ETH\")\n .txid(\"0xdeposit-hash\")\n .walletAddress(\"0xYourDepositWallet\")\n .amount(\"500.00\")\n .currency(\"USDC\")\n .originatorData(Map.of(\"name\", \"Origin CASP SL\"))\n .beneficiaryData(Map.of(\"name\", \"Ana Diaz\"))\n .originatingVasp(TravelRuleInboundRequest.OriginatingVasp.builder()\n .name(\"Origin CASP SL\")\n .lei(\"\")\n .travelAddress(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\")\n .build())\n .build());\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->travelRule->registerInbound([\n 'chain' => 'ETH',\n 'txid' => '0xdeposit-hash',\n 'wallet_address' => '0xYourDepositWallet',\n 'amount' => '500.00',\n 'currency' => 'USDC',\n 'originator_data' => ['name' => 'Origin CASP SL'],\n 'beneficiary_data' => ['name' => 'Ana Diaz'],\n 'originating_vasp' => [\n 'name' => 'Origin CASP SL',\n 'lei' => '',\n 'travel_address' => 'ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC',\n ],\n]);\nprint_r($result->toArray());"},{"lang":"ruby","label":"Ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.register_inbound(\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n }\n)\nputs result.to_h"},{"lang":"csharp","label":".NET","source":"using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RegisterInboundAsync(new TravelRuleInboundRequest\n{\n Chain = \"ETH\",\n Txid = \"0xdeposit-hash\",\n WalletAddress = \"0xYourDepositWallet\",\n Amount = \"500.00\",\n Currency = \"USDC\",\n OriginatorData = new Dictionary\u003cstring, object> { [\"name\"] = \"Origin CASP SL\" },\n BeneficiaryData = new Dictionary\u003cstring, object> { [\"name\"] = \"Ana Diaz\" },\n OriginatingVasp = new TravelRuleInboundRequestOriginatingVasp\n {\n Name = \"Origin CASP SL\",\n Lei = \"\",\n TravelAddress = \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"responses":{"200":"187ee407-836a-494c-adf6-97c68f1eb54b","201":"9f355d14-ab6b-4a7a-8f60-f13dad69e1e9","400":"da979c45-884b-4049-a4cf-19bf88b30d10"},"parameters":["ac0ebfa0-2eac-4b34-acfa-2f4eedfb7c21"],"method":"post","type":"path","servers":["020faff0-0394-4c06-9271-4c2a538bea7c"],"path":"/v3/travel-rule/inbound/","baseUrlOptions":["https://verification.didit.me"],"title":"Register an after-deposit (sunrise) inbound transfer","codeSamples":[{"label":"curl","lang":"curl","source":"curl -X POST https://verification.didit.me/v3/travel-rule/inbound/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"chain\":\"ETH\",\"txid\":\"0xdeposit-hash\",\"wallet_address\":\"0xYourDepositWallet\",\"amount\":\"500.00\",\"currency\":\"USDC\"}'"},{"label":"Python","lang":"python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.register_inbound(\n chain=\"ETH\",\n txid=\"0xdeposit-hash\",\n wallet_address=\"0xYourDepositWallet\",\n amount=\"500.00\",\n currency=\"USDC\",\n originator_data={\"name\": \"Origin CASP SL\"},\n beneficiary_data={\"name\": \"Ana Diaz\"},\n originating_vasp={\n \"name\": \"Origin CASP SL\",\n \"lei\": \"\",\n \"travel_address\": \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\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.travelRule.registerInbound({\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nconsole.log(result);"},{"label":"Go","lang":"go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RegisterInbound(ctx, didit.TravelRuleRegisterInboundParams{\n\tBody: didit.TravelRuleInboundRequest{\n\t\tChain: \"ETH\",\n\t\tTxid: \"0xdeposit-hash\",\n\t\tWalletAddress: \"0xYourDepositWallet\",\n\t\tAmount: \"500.00\",\n\t\tCurrency: \"USDC\",\n\t\tOriginatorData: didit.Some(map[string]any{\"name\": \"Origin CASP SL\"}),\n\t\tBeneficiaryData: didit.Some(map[string]any{\"name\": \"Ana Diaz\"}),\n\t\tOriginatingVASP: didit.Some(didit.TravelRuleInboundRequestOriginatingVASP{\n\t\t\tName: didit.String(\"Origin CASP SL\"),\n\t\t\tLei: didit.String(\"\"),\n\t\t\tTravelAddress: didit.String(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\"),\n\t\t}),\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"label":"Java","lang":"java","source":"import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().registerInbound(TravelRuleInboundRequest.builder()\n .chain(\"ETH\")\n .txid(\"0xdeposit-hash\")\n .walletAddress(\"0xYourDepositWallet\")\n .amount(\"500.00\")\n .currency(\"USDC\")\n .originatorData(Map.of(\"name\", \"Origin CASP SL\"))\n .beneficiaryData(Map.of(\"name\", \"Ana Diaz\"))\n .originatingVasp(TravelRuleInboundRequest.OriginatingVasp.builder()\n .name(\"Origin CASP SL\")\n .lei(\"\")\n .travelAddress(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\")\n .build())\n .build());\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->travelRule->registerInbound([\n 'chain' => 'ETH',\n 'txid' => '0xdeposit-hash',\n 'wallet_address' => '0xYourDepositWallet',\n 'amount' => '500.00',\n 'currency' => 'USDC',\n 'originator_data' => ['name' => 'Origin CASP SL'],\n 'beneficiary_data' => ['name' => 'Ana Diaz'],\n 'originating_vasp' => [\n 'name' => 'Origin CASP SL',\n 'lei' => '',\n 'travel_address' => 'ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC',\n ],\n]);\nprint_r($result->toArray());"},{"label":"Ruby","lang":"ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.register_inbound(\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n }\n)\nputs result.to_h"},{"label":".NET","lang":"csharp","source":"using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RegisterInboundAsync(new TravelRuleInboundRequest\n{\n Chain = \"ETH\",\n Txid = \"0xdeposit-hash\",\n WalletAddress = \"0xYourDepositWallet\",\n Amount = \"500.00\",\n Currency = \"USDC\",\n OriginatorData = new Dictionary\u003cstring, object> { [\"name\"] = \"Origin CASP SL\" },\n BeneficiaryData = new Dictionary\u003cstring, object> { [\"name\"] = \"Ana Diaz\" },\n OriginatingVasp = new TravelRuleInboundRequestOriginatingVasp\n {\n Name = \"Origin CASP SL\",\n Lei = \"\",\n TravelAddress = \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.chain":"ETH","body.txid":"0xdeposit-hash","body.wallet_address":"0xYourDepositWallet","body.amount":"500.00","body.currency":"USDC","body.originator_data":{"name":"Origin CASP SL"},"body.beneficiary_data":{"name":"Ana Diaz"},"body.originating_vasp.name":"Origin CASP SL","body.originating_vasp.lei":"","body.originating_vasp.travel_address":"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC"}]},"dependencies":{"parameters":{"ac0ebfa0-2eac-4b34-acfa-2f4eedfb7c21":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns `409` `idempotency_key_reused`, and while the first request is still running, `409` `idempotency_key_in_progress` with `Retry-After`. A failed request (any `4xx` or `5xx`) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See [Retries and idempotency](/integration/api-errors#retries-and-idempotency).","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns `409` `idempotency_key_reused`, and while the first request is still running, `409` `idempotency_key_in_progress` with `Retry-After`. A failed request (any `4xx` or `5xx`) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See [Retries and idempotency](/integration/api-errors#retries-and-idempotency).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["chain","txid","wallet_address","amount","currency"],"properties":{"chain":{"type":"string","description":"Chain the deposit settled on, for example `ETH`. Stored lowercase and compared case-insensitively with your wallet address book entries, so use the same chain token there.","maxLength":32,"isRequired":true,"uniqueKey":"chain","typeLabel":"string"},"txid":{"type":"string","description":"On-chain transaction hash. Deduped together with wallet_address.","maxLength":128,"isRequired":true,"uniqueKey":"txid","typeLabel":"string"},"wallet_address":{"type":"string","description":"The destination wallet you received the deposit on. An XRP X-address is split into its classic address and tag.","maxLength":128,"isRequired":true,"uniqueKey":"wallet_address","typeLabel":"string"},"amount":{"type":"string","description":"Deposit amount as a decimal string, zero or greater, with up to 18 decimal places.","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","description":"Deposit asset, e.g. \"USDC\".","maxLength":16,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"originator_data":{"type":"object","description":"Originator details from the sending VASP, if known, as a flat object such as `{\"name\": \"...\"}`. Didit reads name (or full_name), first_name, last_name and vendor_data from it.","additionalProperties":true,"uniqueKey":"originator_data","typeLabel":"object"},"beneficiary_data":{"type":"object","description":"Beneficiary details (your customer), as a flat object such as `{\"name\": \"...\"}`. Didit matches name against the holder_name of the matched address book entry, and sets wallet_address and chain from the request.","additionalProperties":true,"uniqueKey":"beneficiary_data","typeLabel":"object"},"originating_vasp":{"type":"object","description":"Optional description of the sending VASP. It stays on this transfer only (`metadata.originating_vasp`, and the transfer's originator VASP in GET /v3/travel-rule/transfers/); it never creates, edits or links a shared VASP directory entry.","properties":{"name":{"type":"string","maxLength":255,"uniqueKey":"originating_vasp.name","typeLabel":"string"},"lei":{"type":"string","maxLength":20,"description":"Optional. A valid 20-character ISO 17442 LEI, or empty.","uniqueKey":"originating_vasp.lei","typeLabel":"string"},"travel_address":{"type":"string","description":"The sender's travel address, recorded on this transfer.","maxLength":512,"uniqueKey":"originating_vasp.travel_address","typeLabel":"string"}},"uniqueKey":"originating_vasp","typeLabel":"object"},"memo":{"type":"string","maxLength":256,"description":"Optional. The deposit's destination tag or memo on a memo network: on a shared deposit address it is what tells your customers apart, and the address-book entry for that memo is matched. XRP: a destination tag, a whole number from 0 to 4294967295 (a JSON number is accepted). XLM: a text memo of up to 28 bytes, a 64-bit id or a 32-byte hash in hex. EOS: up to 256 bytes. ATOM: up to 256 characters. HBAR: up to 100 bytes. Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin and Lightning wallets take no memo: one there is a `400`. Alias: `destinationTag` or `destination_tag`.","uniqueKey":"memo","typeLabel":"string"},"utxo":{"type":"object","description":"Optional, UTXO chains only. The deposit transaction's inputs and outputs: the sender's wallet is the declared `originator_data.wallet_address`, else the largest input.","required":["outputs"],"properties":{"outputs":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"utxo.outputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"utxo.outputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"utxo.outputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"utxo.outputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"utxo.outputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"utxo.outputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"utxo.outputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"utxo.outputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"utxo.outputs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"utxo.outputs","typeLabel":"object[]"},"inputs":{"type":"array","maxItems":1000,"items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"utxo.inputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"utxo.inputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"utxo.inputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"utxo.inputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"utxo.inputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"utxo.inputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"utxo.inputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"utxo.inputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"utxo.inputs.items.[INDEX]","typeLabel":"object"},"description":"Optional. Without inputs no originator is inferred and no change output is recognised.","uniqueKey":"utxo.inputs","typeLabel":"object[]"}},"uniqueKey":"utxo","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"chain":"ETH","txid":"0xdeposit-hash","wallet_address":"0xYourDepositWallet","amount":"500.00","currency":"USDC","originator_data":{"name":"Origin CASP SL"},"beneficiary_data":{"name":"Ana Diaz"},"originating_vasp":{"name":"Origin CASP SL","lei":"","travel_address":"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC"}},"examples":{"Example":{"title":"Example","value":{"chain":"ETH","txid":"0xdeposit-hash","wallet_address":"0xYourDepositWallet","amount":"500.00","currency":"USDC","originator_data":{"name":"Origin CASP SL"},"beneficiary_data":{"name":"Ana Diaz"},"originating_vasp":{"name":"Origin CASP SL","lei":"","travel_address":"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"187ee407-836a-494c-adf6-97c68f1eb54b":{"description":"A transfer for this txid and wallet_address was already registered; the existing one is returned unchanged (created is false).","content":{"application/json":{"schema":{"type":"object","properties":{"transaction_id":{"type":"string","format":"uuid","description":"Didit transaction UUID for the inbound deposit.","uniqueKey":"transaction_id","typeLabel":"string\u003cuuid>"},"txn_id":{"type":"string","description":"txn_id of the inbound transaction: Didit-generated when Didit created the transaction, or your own when an unclaimed deposit was reused.","uniqueKey":"txn_id","typeLabel":"string"},"created":{"type":"boolean","description":"true when this call registered the transfer (HTTP 201); false when a transfer for the same txid and wallet_address already existed (HTTP 200).","uniqueKey":"created","typeLabel":"boolean"},"travel_rule":{"type":"object","description":"Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. While an inbound transfer's wallet ownership is unconfirmed, the counterparty's `originator_data` and `beneficiary_data` come back masked (the first letter of each word is kept; the wallet, chain and VASP routing stay readable) and `data_masked` is true.","properties":{"uuid":{"type":"string","format":"uuid","uniqueKey":"travel_rule.uuid","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["AWAITING_COUNTERPARTY","ON_HOLD","COMPLETED","FINISHED","CANCELLED","EXPIRED","COUNTERPARTY_MISMATCHED_DATA","COUNTERPARTY_VASP_NOT_FOUND","COUNTERPARTY_VASP_NOT_REACHABLE","UNCONFIRMED_OWNERSHIP","COUNTERPARTY_VASP_GENERAL_DECLINE","NOT_ENOUGH_COUNTERPARTY_DATA","NOT_APPLICABLE"],"uniqueKey":"travel_rule.status","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"],"uniqueKey":"travel_rule.direction","typeLabel":"enum\u003cstring>"},"rail":{"oneOf":[{"type":"string","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",null],"description":"The rail the transfer was routed over, or null when no rail was selected (for example below the threshold, a self-hosted counterparty wallet, an after-deposit registration, or no reachable counterparty). INTERNAL means both sides are Didit applications; EMAIL means the counterparty was reached by an emailed pickup link. TEST_VASP means the Didit Test VASP answered the sandbox transfer. Over GTR, VERIFYVASP and SYGNA, Didit reads the counterparty's answer from the network's response or by polling it every 5 minutes. TRUST only sends, so a TRUST transfer stays AWAITING_COUNTERPARTY until it expires. A network rail is used only when you have connected your own membership for that network. It is chosen after the transaction create returns, so it is null in that response.","uniqueKey":"travel_rule.rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",null],"description":"The rail the transfer was routed over, or null when no rail was selected (for example below the threshold, a self-hosted counterparty wallet, an after-deposit registration, or no reachable counterparty). INTERNAL means both sides are Didit applications; EMAIL means the counterparty was reached by an emailed pickup link. TEST_VASP means the Didit Test VASP answered the sandbox transfer. Over GTR, VERIFYVASP and SYGNA, Didit reads the counterparty's answer from the network's response or by polling it every 5 minutes. TRUST only sends, so a TRUST transfer stays AWAITING_COUNTERPARTY until it expires. A network rail is used only when you have connected your own membership for that network. It is chosen after the transaction create returns, so it is null in that response.","uniqueKey":"travel_rule.rail.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.rail","typeLabel":"enum\u003cstring> | null"},"protocol":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.protocol.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.protocol.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.protocol","typeLabel":"string | null"},"ivms_version":{"type":"string","example":"ivms101.2023","uniqueKey":"travel_rule.ivms_version","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"travel_rule.required","typeLabel":"boolean"},"ownership_confirmed":{"oneOf":[{"type":"boolean","uniqueKey":"travel_rule.ownership_confirmed.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"travel_rule.ownership_confirmed.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.ownership_confirmed","typeLabel":"boolean | null"},"deadline_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"travel_rule.deadline_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"travel_rule.deadline_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.deadline_at","typeLabel":"string\u003cdate-time> | null"},"timeline":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].status","typeLabel":"string"},"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.timeline.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"detail":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].detail","typeLabel":"string"},"name_match":{"oneOf":[{"type":"object","description":"The name comparison this entry decided, next to `detail`. Absent on entries that compared no name.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.score","typeLabel":"integer"},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched","typeLabel":"boolean"},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`).","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.method","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.strictness","typeLabel":"enum\u003cstring>"},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.compared_with","typeLabel":"enum\u003cstring>"},"transfer_name":{"type":"string","description":"The name on the transfer.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.transfer_name","typeLabel":"string"},"compared_name":{"type":"string","description":"The name it was compared with.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.compared_name","typeLabel":"string"},"matched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` found in `compared_name`.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched_names","typeLabel":"string[]"},"mismatched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.mismatched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.mismatched_names","typeLabel":"string[]"}},"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"The name comparison this entry decided, next to `detail`. Absent on entries that compared no name.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank."},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true."},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`)."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox."},"transfer_name":{"type":"string","description":"The name on the transfer."},"compared_name":{"type":"string","description":"The name it was compared with."},"matched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` found in `compared_name`."},"mismatched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`."}},"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.2","typeLabel":"null"}],"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match","typeLabel":"object · null · null"},"reason":{"type":"string","description":"Present only on the entry of a transition a failed delivery caused: `email_undeliverable` or `delivery_failed`, the value the transfer's `reason` reports.","uniqueKey":"travel_rule.timeline.items.[INDEX].reason","typeLabel":"string"}},"uniqueKey":"travel_rule.timeline.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.timeline","typeLabel":"object[]"},"counterparty_vasp":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.name","typeLabel":"string"},"lei":{"type":"string","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.lei","typeLabel":"string"},"dd_score":{"type":"integer","description":"Due-diligence score from 0 to 100, where higher is better. Same scale as in the VASP directory.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score","typeLabel":"integer"},"dd_score_breakdown":{"type":"object","description":"Per-component contributions to dd_score, one object per component as in the VASP directory (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), each {points, max, reason, detail}. {} until the counterparty has been assessed.","additionalProperties":{"type":"object","properties":{"points":{"type":"number","description":"Points awarded for this component.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.points","typeLabel":"number"},"max":{"type":"integer","description":"Maximum points this component can award.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.max","typeLabel":"integer"},"reason":{"type":"string","description":"Machine-readable code of the component's verdict.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.reason","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable reason for the awarded points.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.detail","typeLabel":"string"}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties","typeLabel":"object"},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown","typeLabel":"object"},"dd_assessed_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string"},"lei":{"type":"string"},"dd_score":{"type":"integer","description":"Due-diligence score from 0 to 100, where higher is better. Same scale as in the VASP directory."},"dd_score_breakdown":{"type":"object","description":"Per-component contributions to dd_score, one object per component as in the VASP directory (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), each {points, max, reason, detail}. {} until the counterparty has been assessed.","additionalProperties":{"type":"object","properties":{"points":{"type":"number","description":"Points awarded for this component."},"max":{"type":"integer","description":"Maximum points this component can award."},"reason":{"type":"string","description":"Machine-readable code of the component's verdict."},"detail":{"type":"string","description":"Human-readable reason for the awarded points."}}}},"dd_assessed_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed."},{"type":"null","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed."}]}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.counterparty_vasp","typeLabel":"object | null"},"originator_data":{"type":"object","description":"Originator party. For an inbound transfer the counterparty's values are masked until ownership is confirmed.","uniqueKey":"travel_rule.originator_data","typeLabel":"object"},"beneficiary_data":{"type":"object","description":"Beneficiary party. For an inbound transfer the counterparty's values are masked until ownership is confirmed.","uniqueKey":"travel_rule.beneficiary_data","typeLabel":"object"},"name_match":{"oneOf":[{"type":"object","description":"The name comparison that decided the transfer, or null until one ran. While the parties are masked, and on the other customer's copy of an INTERNAL exchange, `transfer_name`, `compared_name`, `matched_names` and `mismatched_names` are hidden. `score` and `matched` can disagree: `matched` follows the strictness, `score` is the similarity of the two full names.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank.","uniqueKey":"travel_rule.name_match.oneOf.0.score","typeLabel":"integer"},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true.","uniqueKey":"travel_rule.name_match.oneOf.0.matched","typeLabel":"boolean"},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`).","uniqueKey":"travel_rule.name_match.oneOf.0.method","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.name_match.oneOf.0.strictness","typeLabel":"enum\u003cstring>"},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox.","uniqueKey":"travel_rule.name_match.oneOf.0.compared_with","typeLabel":"enum\u003cstring>"},"transfer_name":{"type":"string","description":"The name on the transfer.","uniqueKey":"travel_rule.name_match.oneOf.0.transfer_name","typeLabel":"string"},"compared_name":{"type":"string","description":"The name it was compared with.","uniqueKey":"travel_rule.name_match.oneOf.0.compared_name","typeLabel":"string"},"matched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.name_match.oneOf.0.matched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` found in `compared_name`.","uniqueKey":"travel_rule.name_match.oneOf.0.matched_names","typeLabel":"string[]"},"mismatched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.name_match.oneOf.0.mismatched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`.","uniqueKey":"travel_rule.name_match.oneOf.0.mismatched_names","typeLabel":"string[]"}},"uniqueKey":"travel_rule.name_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"The name comparison that decided the transfer, or null until one ran. While the parties are masked, and on the other customer's copy of an INTERNAL exchange, `transfer_name`, `compared_name`, `matched_names` and `mismatched_names` are hidden. `score` and `matched` can disagree: `matched` follows the strictness, `score` is the similarity of the two full names.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank."},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true."},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`)."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox."},"transfer_name":{"type":"string","description":"The name on the transfer."},"compared_name":{"type":"string","description":"The name it was compared with."},"matched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` found in `compared_name`."},"mismatched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`."}},"uniqueKey":"travel_rule.name_match.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"travel_rule.name_match.oneOf.2","typeLabel":"null"}],"uniqueKey":"travel_rule.name_match","typeLabel":"object · null · null"},"data_match":{"oneOf":[{"type":"object","description":"Field-by-field comparison of the transfer's party data with what the other side knows about the wallet holder. It names fields and results, never values, so it stays readable while the counterparty's data is masked. Null until a comparison ran.","properties":{"matched":{"type":"boolean","description":"True when no compared field differs.","uniqueKey":"travel_rule.data_match.oneOf.0.matched","typeLabel":"boolean"},"mismatched_fields":{"type":"array","items":{"type":"string","enum":["name","date_of_birth","address","account"],"uniqueKey":"travel_rule.data_match.oneOf.0.mismatched_fields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The fields that differ.","uniqueKey":"travel_rule.data_match.oneOf.0.mismatched_fields","typeLabel":"enum\u003cstring>[]"},"fields":{"type":"object","description":"One entry per field compared for the party's entity type (`name`, `date_of_birth`, `address`, `account`; a company has no `date_of_birth`).","additionalProperties":{"type":"object","properties":{"result":{"type":"string","enum":["matched","mismatched","not_compared"],"description":"`not_compared` when the rule is `NONE` or either side has no value for the field.","uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties.result","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties.strictness","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties","typeLabel":"object"},"uniqueKey":"travel_rule.data_match.oneOf.0.fields","typeLabel":"object"}},"uniqueKey":"travel_rule.data_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"Field-by-field comparison of the transfer's party data with what the other side knows about the wallet holder. It names fields and results, never values, so it stays readable while the counterparty's data is masked. Null until a comparison ran.","properties":{"matched":{"type":"boolean","description":"True when no compared field differs."},"mismatched_fields":{"type":"array","items":{"type":"string","enum":["name","date_of_birth","address","account"]},"description":"The fields that differ."},"fields":{"type":"object","description":"One entry per field compared for the party's entity type (`name`, `date_of_birth`, `address`, `account`; a company has no `date_of_birth`).","additionalProperties":{"type":"object","properties":{"result":{"type":"string","enum":["matched","mismatched","not_compared"],"description":"`not_compared` when the rule is `NONE` or either side has no value for the field."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]}}}}},"uniqueKey":"travel_rule.data_match.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.data_match","typeLabel":"object | null"},"mismatched_fields":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.mismatched_fields.items.[INDEX]","typeLabel":"string"},"description":"Shortcut for `data_match.mismatched_fields`. Empty when nothing differs.","uniqueKey":"travel_rule.mismatched_fields","typeLabel":"string[]"},"data_unmasked":{"oneOf":[{"type":"object","description":"Audit record of the moment the counterparty's data was unmasked. Null while the data is still masked, and for outbound transfers.","properties":{"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.data_unmasked.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"reason":{"type":"string","enum":["ownership_confirmed","wallet_proof","address_book_match","own_verified_wallet","inquiry_approved","known_payment_method","travel_address"],"description":"What confirmed ownership: ownership_confirmed (your confirmation through the console or the API), wallet_proof (a wallet proof in the widget, or an INTERNAL inbound transfer, set when it is created), address_book_match (a verified address-book wallet), own_verified_wallet (your user's own verified wallet), inquiry_approved (your approval of an inbound TRP inquiry or a GTR or Sygna message), known_payment_method (a wallet your user already paid with) or travel_address (the per-wallet travel address named the wallet).","uniqueKey":"travel_rule.data_unmasked.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"actor":{"type":"string","description":"Who confirmed it: the console user's email or the API key's label. Blank for an automatic decision.","uniqueKey":"travel_rule.data_unmasked.oneOf.0.actor","typeLabel":"string"}},"uniqueKey":"travel_rule.data_unmasked.oneOf.0","typeLabel":"object"},{"type":"null","description":"Audit record of the moment the counterparty's data was unmasked. Null while the data is still masked, and for outbound transfers.","properties":{"at":{"type":"string","format":"date-time"},"reason":{"type":"string","enum":["ownership_confirmed","wallet_proof","address_book_match","own_verified_wallet","inquiry_approved","known_payment_method","travel_address"],"description":"What confirmed ownership: ownership_confirmed (your confirmation through the console or the API), wallet_proof (a wallet proof in the widget, or an INTERNAL inbound transfer, set when it is created), address_book_match (a verified address-book wallet), own_verified_wallet (your user's own verified wallet), inquiry_approved (your approval of an inbound TRP inquiry or a GTR or Sygna message), known_payment_method (a wallet your user already paid with) or travel_address (the per-wallet travel address named the wallet)."},"actor":{"type":"string","description":"Who confirmed it: the console user's email or the API key's label. Blank for an automatic decision."}},"uniqueKey":"travel_rule.data_unmasked.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.data_unmasked","typeLabel":"object | null"},"data_masked":{"type":"boolean","description":"True while the counterparty's personal data is masked in this response.","uniqueKey":"travel_rule.data_masked","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.created_at","typeLabel":"string\u003cdate-time>"},"delivery":{"oneOf":[{"type":"object","description":"Where the latest message this transfer owes the other side stands. Null when the transfer never owed one (for example below `threshold_amount`, a declared self-hosted wallet, or a sunrise registration).","required":["kind","status","rail","attempts","last_error","next_attempt_at","delivered_at","updated_at","failure","route"],"properties":{"kind":{"type":"string","enum":["SEND","ANSWER","TXID","CANCEL","POLL"],"description":"What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it. `POLL`: a status query to a network that offers one, repeated every 5 minutes while the transfer waits on the counterparty.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["QUEUED","SENDING","RETRYING","DELIVERED","FAILED"],"description":"`QUEUED`: waiting to be sent. `SENDING`: an attempt is running. `RETRYING`: an attempt failed and the next one runs at `next_attempt_at`. `DELIVERED`: the other side took the message. `FAILED`: the other side refused it, or the last attempt failed.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.status","typeLabel":"enum\u003cstring>"},"rail":{"type":"string","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",""],"description":"The rail that carries the message. Empty until Didit has chosen one for a first message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.rail","typeLabel":"enum\u003cstring>"},"attempts":{"type":"integer","minimum":0,"description":"Attempts made so far for this message. A message that is not a status poll is attempted at most 6 times.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.attempts","typeLabel":"integer"},"last_error":{"type":"string","description":"A short customer-safe reason for the last failure, `\"\"` when there is none: `email undeliverable`, `trp identity endpoint unreachable`, `trp transfer inquiry delivery failed` or `The message could not be delivered.` It never carries the counterparty's own answer, which stays on the transfer's `timeline`, and never a response body.","example":"email undeliverable","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.last_error","typeLabel":"string"},"next_attempt_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at","typeLabel":"string\u003cdate-time> | null"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the other side took the message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the other side took the message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"type":"string","format":"date-time","description":"When the delivery last changed.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"failure":{"oneOf":[{"type":"object","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0","typeLabel":"object"},{"type":"null","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure."},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered."}},"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure","typeLabel":"object | null"},"route":{"oneOf":[{"type":"string","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route","typeLabel":"string | null"}},"uniqueKey":"travel_rule.delivery.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.delivery.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.delivery","typeLabel":"object | null"},"discovery":{"type":"array","description":"How Didit looked for the counterparty, one entry per step that ran. Empty when no discovery ran, for example on an inbound transfer.","items":{"type":"object","description":"One step of the counterparty discovery Didit ran for an outbound transfer, in the order it ran them. The first step that names a VASP with a route ends the chain.","properties":{"step":{"type":"string","enum":["internal_address_book","wallet_attribution","network_lookup","customer_hint","end_user"],"description":"`internal_address_book`: another Didit customer that proved control of the destination wallet. `wallet_attribution`: the wallet's blockchain analytics attribution. `network_lookup`: a network that can say which VASP holds the address. `customer_hint`: the VASP name, LEI or jurisdiction you sent in `beneficiary_data`. `end_user`: the counterparty the end user (or you) picked, or the request to pick one.","uniqueKey":"travel_rule.discovery.items.[INDEX].step","typeLabel":"enum\u003cstring>"},"outcome":{"type":"string","enum":["match","miss","skipped"],"description":"`match`: the step named a counterparty. `miss`: it ran and found none. `skipped`: it could not run, and `reason` says why.","uniqueKey":"travel_rule.discovery.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Machine-readable reason, `\"\"` on a match: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` or `picked_member_without_proven_wallet`.","uniqueKey":"travel_rule.discovery.items.[INDEX].reason","typeLabel":"string"},"vasp":{"oneOf":[{"type":"string","format":"uuid","description":"The directory VASP the step named, when it named one.","uniqueKey":"travel_rule.discovery.items.[INDEX].vasp.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The directory VASP the step named, when it named one.","uniqueKey":"travel_rule.discovery.items.[INDEX].vasp.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.discovery.items.[INDEX].vasp","typeLabel":"string\u003cuuid> | null"},"rail":{"oneOf":[{"type":"string","description":"The rail that reaches that counterparty, when the step found one.","uniqueKey":"travel_rule.discovery.items.[INDEX].rail.oneOf.0","typeLabel":"string"},{"type":"null","description":"The rail that reaches that counterparty, when the step found one.","uniqueKey":"travel_rule.discovery.items.[INDEX].rail.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.discovery.items.[INDEX].rail","typeLabel":"string | null"},"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.discovery.items.[INDEX].at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"travel_rule.discovery.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.discovery","typeLabel":"object[]"},"reason":{"type":"string","description":"Why a `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE` transfer is stuck; `\"\"` for any other status. A failed delivery decides it first, on `COUNTERPARTY_VASP_NOT_REACHABLE` only: `email_undeliverable` (the mail provider refused the compliance email and no address is left to try: when it was sent, on a reminder, or as a permanent bounce reported later) or `delivery_failed` (the rail that was delivering failed for good: a network rail refused the message or ran out of retries, a `TRP` identity host did not answer, or the counterparty's `TRP` host did not accept the inquiry). Otherwise the `discovery` trace decides it: `awaiting_end_user` (no step named a counterparty Didit can reach), `directory_match_no_route` (a step named a directory VASP that has no route), `picked_member_without_proven_wallet` (the end user picked a Didit customer that has not proven control of the wallet and that the directory no longer lists), or `no_directory_match` when the trace gives no other reason. A resend moves the transfer on, so the reason clears. See [Why a transfer is stuck](/transaction-monitoring/travel-rule#why-a-transfer-is-stuck).","uniqueKey":"travel_rule.reason","typeLabel":"string"},"next_actions":{"type":"array","description":"What moves the transfer on; `[]` for any status but `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` offers `update_compliance_email`, then `resend`. `delivery_failed` offers `resend`. A discovery reason offers `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` and `resend`.","items":{"type":"object","description":"One thing that moves a `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE` transfer on. See [Why a transfer is stuck](/transaction-monitoring/travel-rule#why-a-transfer-is-stuck).","properties":{"action":{"type":"string","enum":["select_counterparty_vasp","declare_self_hosted","add_vasp_hint","update_compliance_email","resend"],"description":"`select_counterparty_vasp`: the end user picks the destination VASP in the wallet-ownership widget, or you PATCH `action=beneficiary_vasp`. `declare_self_hosted`: the end user declares the wallet self-hosted in the widget. `add_vasp_hint`: tell Didit who the counterparty is, with a VASP name, LEI or travel address (for example a `travel_address` on the destination wallet's address-book entry), then resend. `update_compliance_email` and `resend` are `action` values of `PATCH /v3/transactions/{transaction_id}/travel-rule/`: give the counterparty's compliance email again, and re-run routing.","isRequired":true,"uniqueKey":"travel_rule.next_actions.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"The wallet-ownership widget link, on `select_counterparty_vasp` and `declare_self_hosted` while the transfer has an open widget session.","uniqueKey":"travel_rule.next_actions.items.[INDEX].url","typeLabel":"string\u003curi>"}},"required":["action"],"uniqueKey":"travel_rule.next_actions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.next_actions","typeLabel":"object[]"},"chain_details":{"type":"object","description":"How the transfer's chain names its two wallets, when that is more than one address paying another. Empty (`{}`) for an account-chain transfer (EVM, Solana, Tron), where the two addresses are the wallets. Matching, routing and the address book read the wallets from here first.","properties":{"chain":{"type":"string","description":"Canonical chain, e.g. `BTC`, `XRP`, or `LIGHTNING` for a Lightning transfer.","uniqueKey":"travel_rule.chain_details.chain","typeLabel":"string"},"shape":{"type":"string","enum":["utxo","memo","lightning"],"uniqueKey":"travel_rule.chain_details.shape","typeLabel":"enum\u003cstring>"},"originator":{"type":"object","description":"One side's wallet as Didit resolved it from the chain data.","properties":{"address":{"type":"string","description":"The wallet. On a memo network the classic address (an XRP X-address is split into its classic address and its tag); on Lightning the payee node id or Lightning Address.","uniqueKey":"travel_rule.chain_details.originator.address","typeLabel":"string"},"memo":{"type":"string","description":"The destination tag or memo that is part of the wallet; `\"\"` for none.","uniqueKey":"travel_rule.chain_details.originator.memo","typeLabel":"string"},"source":{"type":"string","enum":["declared","x_address","largest_input","only_non_change_output","amount_match","invoice_payee","updated"],"description":"Where the wallet came from: `declared` (your request), `x_address` (split from an XRP X-address), `largest_input` (the UTXO input address that contributed the most), `only_non_change_output` (the only UTXO output that is not change), `amount_match` (the one UTXO output paying the transfer amount), `invoice_payee` (the payee a Lightning payment request names), `updated` (set later with `action: update_originator_wallet`).","uniqueKey":"travel_rule.chain_details.originator.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"One side's wallet as Didit resolved it from the chain data.","properties":{"address":{"type":"string","description":"The wallet. On a memo network the classic address (an XRP X-address is split into its classic address and its tag); on Lightning the payee node id or Lightning Address.","uniqueKey":"travel_rule.chain_details.beneficiary.address","typeLabel":"string"},"memo":{"type":"string","description":"The destination tag or memo that is part of the wallet; `\"\"` for none.","uniqueKey":"travel_rule.chain_details.beneficiary.memo","typeLabel":"string"},"source":{"type":"string","enum":["declared","x_address","largest_input","only_non_change_output","amount_match","invoice_payee","updated"],"description":"Where the wallet came from: `declared` (your request), `x_address` (split from an XRP X-address), `largest_input` (the UTXO input address that contributed the most), `only_non_change_output` (the only UTXO output that is not change), `amount_match` (the one UTXO output paying the transfer amount), `invoice_payee` (the payee a Lightning payment request names), `updated` (set later with `action: update_originator_wallet`).","uniqueKey":"travel_rule.chain_details.beneficiary.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details.beneficiary","typeLabel":"object"},"utxo":{"type":"object","description":"On a UTXO transfer: the inputs and outputs as stored (amounts as decimal strings) and which outputs Didit read as what.","properties":{"inputs":{"type":"array","items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.chain_details.utxo.inputs","typeLabel":"object[]"},"outputs":{"type":"array","items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.chain_details.utxo.outputs","typeLabel":"object[]"},"change_output_indexes":{"type":"array","items":{"type":"integer","uniqueKey":"travel_rule.chain_details.utxo.change_output_indexes.items.[INDEX]","typeLabel":"integer"},"description":"Outputs that pay an input address back.","uniqueKey":"travel_rule.chain_details.utxo.change_output_indexes","typeLabel":"integer[]"},"beneficiary_output_index":{"oneOf":[{"type":"integer","description":"The output that pays the beneficiary; null when none could be told apart.","uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The output that pays the beneficiary; null when none could be told apart.","uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo","typeLabel":"object"},"lightning":{"type":"object","description":"On a Lightning transfer: what the payment request says. Always `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` or `unknown`); a BOLT11 invoice adds `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` and `expires_at`; a BOLT12 string `blinded_paths` and `payee_node_id`; an LNURL or a Lightning Address its `domain`. Nothing is resolved over the network: the request is decoded only.","additionalProperties":true,"uniqueKey":"travel_rule.chain_details.lightning","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","enum":["declared_originator_not_an_input","declared_beneficiary_not_an_output","beneficiary_output_ambiguous","beneficiary_output_amount_differs"],"uniqueKey":"travel_rule.chain_details.warnings.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"UTXO inconsistencies worth a look: the declared originator is not an input, the declared beneficiary is not an output, no single beneficiary output could be told apart, or the beneficiary output pays a different amount than the transaction states.","uniqueKey":"travel_rule.chain_details.warnings","typeLabel":"enum\u003cstring>[]"},"not_applicable_reason":{"type":"string","enum":["LIGHTNING_NO_PAYEE_IDENTIFIER","LIGHTNING_BOLT12_BLINDED_PAYEE","LIGHTNING_LNURL_NAMES_NO_PAYEE"],"description":"On an outbound Lightning transfer whose payment request names no payee: why the transfer is `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (the request names no payee node, or could not be decoded), `LIGHTNING_BOLT12_BLINDED_PAYEE` (the offer hides its payee behind blinded paths), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (an LNURL names a service, not a payee). The same code opens the transfer's last `timeline` entry.","uniqueKey":"travel_rule.chain_details.not_applicable_reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details","typeLabel":"object"},"deliveries":{"type":"array","maxItems":100,"items":{"type":"object","description":"One supplier-neutral entry in the delivery history.","required":["uuid","kind","status","rail","created_at","delivered_at","detail_lines","attempts","updated_at","next_attempt_at","failure","route"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Delivery identifier.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].uuid","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["SEND","ANSWER","TXID","CANCEL","POLL"],"description":"What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it. `POLL`: a status query to a network that offers one, repeated every 5 minutes while the transfer waits on the counterparty.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["QUEUED","SENDING","RETRYING","DELIVERED","FAILED"],"description":"Current delivery status.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"rail":{"oneOf":[{"type":"string","enum":["EMAIL","TRP","INTERNAL","NETWORK",null],"description":"Supplier-neutral transport type; null until selected.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EMAIL","TRP","INTERNAL","NETWORK",null],"description":"Supplier-neutral transport type; null until selected.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail","typeLabel":"enum\u003cstring> | null"},"created_at":{"type":"string","format":"date-time","description":"When the delivery was created.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"When delivery completed, or null.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When delivery completed, or null.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at","typeLabel":"string\u003cdate-time> | null"},"detail_lines":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.deliveries.items.[INDEX].detail_lines.items.[INDEX]","typeLabel":"string"},"description":"Human-readable message kind and delivery status. Does not expose transport payloads or raw errors.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].detail_lines","typeLabel":"string[]"},"attempts":{"type":"integer","minimum":0,"description":"Attempts made so far for this message.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].attempts","typeLabel":"integer"},"updated_at":{"type":"string","format":"date-time","description":"When the delivery last changed.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"next_attempt_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at","typeLabel":"string\u003cdate-time> | null"},"failure":{"oneOf":[{"type":"object","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0","typeLabel":"object"},{"type":"null","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure."},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered."}},"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure","typeLabel":"object | null"},"route":{"oneOf":[{"type":"string","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route","typeLabel":"string | null"}},"example":{"uuid":"11111111-2222-4333-8444-555555555555","kind":"SEND","status":"DELIVERED","rail":"NETWORK","created_at":"2026-11-01T10:00:00Z","delivered_at":"2026-11-01T10:00:01Z","detail_lines":["Send","Delivered"],"attempts":1,"updated_at":"2026-11-01T10:00:01Z","next_attempt_at":null,"failure":null,"route":"Network"},"uniqueKey":"travel_rule.deliveries.items.[INDEX]","typeLabel":"object"},"description":"Newest 100 delivery entries, presented oldest first (creation time, then identifier). Empty when no messages exist. Use the paginated delivery endpoint for complete history.","uniqueKey":"travel_rule.deliveries","typeLabel":"object[]"},"deliveries_truncated":{"type":"boolean","description":"True when older entries were omitted from deliveries. Follow GET /v3/transactions/{transaction_id}/travel-rule/deliveries/ for the complete history.","uniqueKey":"travel_rule.deliveries_truncated","typeLabel":"boolean"},"not_required_reason":{"oneOf":[{"type":"string","description":"Null when required is true. Otherwise below_threshold, the recorded chain exemption (for example LIGHTNING_NO_PAYEE_IDENTIFIER, LIGHTNING_BOLT12_BLINDED_PAYEE or LIGHTNING_LNURL_NAMES_NO_PAYEE), or unknown for legacy transfers without a recorded reason.","example":"below_threshold","uniqueKey":"travel_rule.not_required_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Null when required is true. Otherwise below_threshold, the recorded chain exemption (for example LIGHTNING_NO_PAYEE_IDENTIFIER, LIGHTNING_BOLT12_BLINDED_PAYEE or LIGHTNING_LNURL_NAMES_NO_PAYEE), or unknown for legacy transfers without a recorded reason.","example":"below_threshold","uniqueKey":"travel_rule.not_required_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.not_required_reason","typeLabel":"string | null"},"proof_state":{"type":"string","description":"not_required when the transfer is not required; otherwise confirmed or not_confirmed follows ownership_confirmed. With no verdict, requested means an active outbound ownership widget matches this transfer and subject; otherwise not_requested. A request is not completed proof.","enum":["not_required","confirmed","not_confirmed","requested","not_requested"],"example":"not_requested","uniqueKey":"travel_rule.proof_state","typeLabel":"enum\u003cstring>"},"cancel_reason":{"type":"string","description":"Recorded cancellation reason, empty when unspecified.","enum":["","user_cancelled","wrong_wallet","compliance_decision","other"],"uniqueKey":"travel_rule.cancel_reason","typeLabel":"enum\u003cstring>"},"cancelled_by":{"type":"string","description":"Recorded cancellation actor, or an empty string when none is recorded.","uniqueKey":"travel_rule.cancelled_by","typeLabel":"string"},"notify_on_answer":{"type":"boolean","description":"Saved team notification preference. Initially false.","uniqueKey":"travel_rule.notify_on_answer","typeLabel":"boolean"},"user_choice":{"oneOf":[{"type":"object","description":"Explicit user-choice state, or null when counterparty_choice=user was not requested.","required":["active","waiting","end_user_link","link_expires_at","emailed_to","email_available"],"properties":{"active":{"type":"boolean","description":"True when explicit user choice was requested.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.active","typeLabel":"boolean"},"waiting":{"type":"boolean","description":"True with no selected directory VASP while status is AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE or UNCONFIRMED_OWNERSHIP.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.waiting","typeLabel":"boolean"},"end_user_link":{"type":"string","description":"Latest open end-user link, or an empty string when none is available.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.end_user_link","typeLabel":"string"},"link_expires_at":{"oneOf":[{"type":"string","description":"Expiry of the open link, or null.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Expiry of the open link, or null.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at","typeLabel":"string\u003cdate-time> | null"},"emailed_to":{"type":"string","description":"Recorded recipient of the user-choice email, or an empty string.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.emailed_to","typeLabel":"string"},"email_available":{"type":"boolean","description":"Recorded availability of an end-user email for user choice.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.email_available","typeLabel":"boolean"}},"uniqueKey":"travel_rule.user_choice.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.user_choice.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.user_choice","typeLabel":"object | null"},"proof_request":{"oneOf":[{"type":"object","description":"Latest application- and subject-scoped request if it matches this transfer counterparty wallet and chain; otherwise null. A standalone request is not attached to a transfer. Request status and proof verdict are separate from the saved transfer decision.","required":["request_id","status","expires_at","proof"],"properties":{"request_id":{"type":"string","description":"Identifier of the matching widget request. Does not expose its access token.","format":"uuid","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.request_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"COMPLETED when the request was completed; otherwise EXPIRED once expires_at has passed, or PENDING. This is the request status, not the proof verdict.","enum":["PENDING","COMPLETED","EXPIRED"],"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.status","typeLabel":"enum\u003cstring>"},"expires_at":{"type":"string","description":"Expiry of the widget request.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.expires_at","typeLabel":"string\u003cdate-time>"},"proof":{"oneOf":[{"type":"object","description":"Latest proof submitted for this request and matching wallet/chain, or null when none exists. Null after the wallet and its proofs are deleted; the saved transfer decision stays unchanged.","properties":{"proof_id":{"type":"string","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.proof_id","typeLabel":"string\u003cuuid>"},"method":{"type":"string","enum":["MESSAGE_SIGNING","SATOSHI_TEST","SCREENSHOT","SELF_DECLARATION"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PENDING","VERIFIED","REJECTED","EXPIRED"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.status","typeLabel":"enum\u003cstring>"},"wallet_address":{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.wallet_address","typeLabel":"string"},"chain":{"type":"string","description":"Canonical chain identifier, e.g. ETH, BTC, SOL, TRX.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.chain","typeLabel":"string"},"holder_name":{"type":"string","description":"Holder name from the submitting widget, never a reassigned holder. Empty when the submitting widget was deleted.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.holder_name","typeLabel":"string"},"is_ownership_verified":{"type":"boolean","description":"Whether the address book entry is ownership-verified, by this proof or another one.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.is_ownership_verified","typeLabel":"boolean"},"transaction_id":{"oneOf":[{"type":"string","format":"uuid","description":"The transaction whose Travel Rule transfer the widget session was minted for. Null for a session minted without a transaction_id.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The transaction whose Travel Rule transfer the widget session was minted for. Null for a session minted without a transaction_id.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id","typeLabel":"string\u003cuuid> | null"},"file_name":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name","typeLabel":"string | null"},"content_type":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type","typeLabel":"string | null"},"screenshot_url":{"oneOf":[{"type":"string","description":"Authorized /v3/media/preview/ URL with an expiring signed source for this proof screenshot. Returns a recompressed preview, not the original upload or an arbitrary public URL. Null when no eligible screenshot exists. Read the proof again for a fresh link.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Authorized /v3/media/preview/ URL with an expiring signed source for this proof screenshot. Returns a recompressed preview, not the original upload or an arbitrary public URL. Null when no eligible screenshot exists. Read the proof again for a fresh link.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url","typeLabel":"string | null"},"attempts":{"type":"integer","description":"Number of attempts made for this proof.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.attempts","typeLabel":"integer"},"failure_reason":{"type":"string","description":"Fixed failure code for this proof or its last attempt; empty when no documented failure applies. A PENDING proof can carry a failure code while another attempt remains possible.","enum":["","SIGNATURE_INVALID","SIGNATURE_UNSUPPORTED_SCHEME","SIGNATURE_LOOKUP_FAILED","DEPOSIT_NOT_FOUND","DEPOSIT_UNCONFIRMED","DEPOSIT_LOOKUP_FAILED","DEPOSIT_MISMATCH","DEPOSIT_STALE","TXID_REUSED","CHAIN_UNSUPPORTED","WINDOW_EXPIRED","OWNERSHIP_CHANGED","METHOD_SWITCHED","REVIEW_REJECTED","ABANDONED"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.failure_reason","typeLabel":"enum\u003cstring>"},"method_chosen_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the end user chose this proof method, or null when unavailable.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the end user chose this proof method, or null when unavailable.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at","typeLabel":"string\u003cdate-time> | null"},"decided_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at","typeLabel":"string\u003cdate-time> | null"},"decided_by":{"type":"string","description":"Who closed the proof: review:\u003cuser identifier> for a console reviewer, review for an API-key decision, widget or sweeper when Didit closed it automatically. Empty while PENDING.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_by","typeLabel":"string"},"review_note":{"type":"string","description":"The note sent with the decision. Empty when none.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.review_note","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"application_id":{"type":"string","description":"Application that owns the wallet and proof.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.application_id","typeLabel":"string\u003cuuid>"},"user_id":{"oneOf":[{"type":"string","description":"User in this application matching the submitting widget vendor_data. Null when no matching current user exists, or the submitting widget was deleted. Never the reassigned wallet holder.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"User in this application matching the submitting widget vendor_data. Null when no matching current user exists, or the submitting widget was deleted. Never the reassigned wallet holder.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id","typeLabel":"string\u003cuuid> | null"},"holder_vendor_data":{"type":"string","description":"Holder identifier from the submitting widget, not the current wallet holder. Empty when the submitting widget was deleted.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.holder_vendor_data","typeLabel":"string"},"wallet_label":{"type":"string","description":"Exact current wallet label, including an empty string when no label is set. Not a name inferred from the holder or address.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.wallet_label","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof","typeLabel":"object | null"}},"uniqueKey":"travel_rule.proof_request.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request","typeLabel":"object | null"}},"uniqueKey":"travel_rule","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","txn_id":"\u003cstring>","created":true,"travel_rule":{"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"AWAITING_COUNTERPARTY","direction":"INBOUND","rail":"INTERNAL","protocol":"\u003cstring>","ivms_version":"ivms101.2023","required":true,"ownership_confirmed":true,"deadline_at":"2023-11-07T05:31:56Z","timeline":[{"status":"\u003cstring>","at":"2023-11-07T05:31:56Z","detail":"\u003cstring>","name_match":{"score":50,"matched":true,"method":"none","strictness":"NONE","compared_with":"wallet_holder","transfer_name":"\u003cstring>","compared_name":"\u003cstring>","matched_names":["\u003cstring>"],"mismatched_names":["\u003cstring>"]},"reason":"\u003cstring>"}],"counterparty_vasp":{"name":"\u003cstring>","lei":"\u003cstring>","dd_score":123,"dd_score_breakdown":{},"dd_assessed_at":"2023-11-07T05:31:56Z"},"originator_data":{},"beneficiary_data":{},"name_match":{"score":50,"matched":true,"method":"none","strictness":"NONE","compared_with":"wallet_holder","transfer_name":"\u003cstring>","compared_name":"\u003cstring>","matched_names":["\u003cstring>"],"mismatched_names":["\u003cstring>"]},"data_match":{"matched":true,"mismatched_fields":["name"],"fields":{}},"mismatched_fields":["\u003cstring>"],"data_unmasked":{"at":"2023-11-07T05:31:56Z","reason":"ownership_confirmed","actor":"\u003cstring>"},"data_masked":true,"created_at":"2023-11-07T05:31:56Z","delivery":{"kind":"SEND","status":"QUEUED","rail":"INTERNAL","attempts":1,"last_error":"email undeliverable","next_attempt_at":"2023-11-07T05:31:56Z","delivered_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","failure":{"code":"email_undeliverable","message":"The message could not be delivered."},"route":"Email"},"discovery":[{"step":"internal_address_book","outcome":"match","reason":"\u003cstring>","vasp":"3c90c3cc-0d44-4b50-8888-8dd25736052a","rail":"\u003cstring>","at":"2023-11-07T05:31:56Z"}],"reason":"\u003cstring>","next_actions":[{"action":"select_counterparty_vasp","url":"\u003cstring>"}],"chain_details":{"chain":"\u003cstring>","shape":"utxo","originator":{"address":"\u003cstring>","memo":"\u003cstring>","source":"declared"},"beneficiary":{"address":"\u003cstring>","memo":"\u003cstring>","source":"declared"},"utxo":{"inputs":[{"address":"\u003cstring>","amount":"0.0125","txid":"\u003cstring>","vout":1}],"outputs":[{"address":"\u003cstring>","amount":"0.0125","txid":"\u003cstring>","vout":1}],"change_output_indexes":[123],"beneficiary_output_index":123},"lightning":{},"warnings":["declared_originator_not_an_input"],"not_applicable_reason":"LIGHTNING_NO_PAYEE_IDENTIFIER"},"deliveries":[{"uuid":"11111111-2222-4333-8444-555555555555","kind":"SEND","status":"DELIVERED","rail":"NETWORK","created_at":"2026-11-01T10:00:00Z","delivered_at":"2026-11-01T10:00:01Z","detail_lines":["Send","Delivered"],"attempts":1,"updated_at":"2026-11-01T10:00:01Z","next_attempt_at":null,"failure":null,"route":"Network"}],"deliveries_truncated":true,"not_required_reason":"below_threshold","proof_state":"not_requested","cancel_reason":"","cancelled_by":"\u003cstring>","notify_on_answer":true,"user_choice":{"active":true,"waiting":true,"end_user_link":"\u003cstring>","link_expires_at":"2023-11-07T05:31:56Z","emailed_to":"\u003cstring>","email_available":true},"proof_request":{"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"PENDING","expires_at":"2023-11-07T05:31:56Z","proof":{"proof_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","method":"MESSAGE_SIGNING","status":"PENDING","wallet_address":"\u003cstring>","chain":"\u003cstring>","holder_name":"\u003cstring>","is_ownership_verified":true,"transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","file_name":"\u003cstring>","content_type":"\u003cstring>","screenshot_url":"\u003cstring>","attempts":123,"failure_reason":"","method_chosen_at":"2023-11-07T05:31:56Z","decided_at":"2023-11-07T05:31:56Z","decided_by":"\u003cstring>","review_note":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","application_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","user_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","holder_vendor_data":"\u003cstring>","wallet_label":"\u003cstring>"}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"9f355d14-ab6b-4a7a-8f60-f13dad69e1e9":{"description":"A new Travel Rule transfer was registered, on a new inbound transaction or on an existing unclaimed deposit (created is true).","content":{"application/json":{"schema":{"type":"object","properties":{"transaction_id":{"type":"string","format":"uuid","description":"Didit transaction UUID for the inbound deposit.","uniqueKey":"transaction_id","typeLabel":"string\u003cuuid>"},"txn_id":{"type":"string","description":"txn_id of the inbound transaction: Didit-generated when Didit created the transaction, or your own when an unclaimed deposit was reused.","uniqueKey":"txn_id","typeLabel":"string"},"created":{"type":"boolean","description":"true when this call registered the transfer (HTTP 201); false when a transfer for the same txid and wallet_address already existed (HTTP 200).","uniqueKey":"created","typeLabel":"boolean"},"travel_rule":{"type":"object","description":"Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. While an inbound transfer's wallet ownership is unconfirmed, the counterparty's `originator_data` and `beneficiary_data` come back masked (the first letter of each word is kept; the wallet, chain and VASP routing stay readable) and `data_masked` is true.","properties":{"uuid":{"type":"string","format":"uuid","uniqueKey":"travel_rule.uuid","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["AWAITING_COUNTERPARTY","ON_HOLD","COMPLETED","FINISHED","CANCELLED","EXPIRED","COUNTERPARTY_MISMATCHED_DATA","COUNTERPARTY_VASP_NOT_FOUND","COUNTERPARTY_VASP_NOT_REACHABLE","UNCONFIRMED_OWNERSHIP","COUNTERPARTY_VASP_GENERAL_DECLINE","NOT_ENOUGH_COUNTERPARTY_DATA","NOT_APPLICABLE"],"uniqueKey":"travel_rule.status","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"],"uniqueKey":"travel_rule.direction","typeLabel":"enum\u003cstring>"},"rail":{"oneOf":[{"type":"string","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",null],"description":"The rail the transfer was routed over, or null when no rail was selected (for example below the threshold, a self-hosted counterparty wallet, an after-deposit registration, or no reachable counterparty). INTERNAL means both sides are Didit applications; EMAIL means the counterparty was reached by an emailed pickup link. TEST_VASP means the Didit Test VASP answered the sandbox transfer. Over GTR, VERIFYVASP and SYGNA, Didit reads the counterparty's answer from the network's response or by polling it every 5 minutes. TRUST only sends, so a TRUST transfer stays AWAITING_COUNTERPARTY until it expires. A network rail is used only when you have connected your own membership for that network. It is chosen after the transaction create returns, so it is null in that response.","uniqueKey":"travel_rule.rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",null],"description":"The rail the transfer was routed over, or null when no rail was selected (for example below the threshold, a self-hosted counterparty wallet, an after-deposit registration, or no reachable counterparty). INTERNAL means both sides are Didit applications; EMAIL means the counterparty was reached by an emailed pickup link. TEST_VASP means the Didit Test VASP answered the sandbox transfer. Over GTR, VERIFYVASP and SYGNA, Didit reads the counterparty's answer from the network's response or by polling it every 5 minutes. TRUST only sends, so a TRUST transfer stays AWAITING_COUNTERPARTY until it expires. A network rail is used only when you have connected your own membership for that network. It is chosen after the transaction create returns, so it is null in that response.","uniqueKey":"travel_rule.rail.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.rail","typeLabel":"enum\u003cstring> | null"},"protocol":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.protocol.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.protocol.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.protocol","typeLabel":"string | null"},"ivms_version":{"type":"string","example":"ivms101.2023","uniqueKey":"travel_rule.ivms_version","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"travel_rule.required","typeLabel":"boolean"},"ownership_confirmed":{"oneOf":[{"type":"boolean","uniqueKey":"travel_rule.ownership_confirmed.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"travel_rule.ownership_confirmed.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.ownership_confirmed","typeLabel":"boolean | null"},"deadline_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"travel_rule.deadline_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"travel_rule.deadline_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.deadline_at","typeLabel":"string\u003cdate-time> | null"},"timeline":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].status","typeLabel":"string"},"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.timeline.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"detail":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].detail","typeLabel":"string"},"name_match":{"oneOf":[{"type":"object","description":"The name comparison this entry decided, next to `detail`. Absent on entries that compared no name.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.score","typeLabel":"integer"},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched","typeLabel":"boolean"},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`).","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.method","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.strictness","typeLabel":"enum\u003cstring>"},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.compared_with","typeLabel":"enum\u003cstring>"},"transfer_name":{"type":"string","description":"The name on the transfer.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.transfer_name","typeLabel":"string"},"compared_name":{"type":"string","description":"The name it was compared with.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.compared_name","typeLabel":"string"},"matched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` found in `compared_name`.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.matched_names","typeLabel":"string[]"},"mismatched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.mismatched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`.","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0.mismatched_names","typeLabel":"string[]"}},"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"The name comparison this entry decided, next to `detail`. Absent on entries that compared no name.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank."},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true."},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`)."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox."},"transfer_name":{"type":"string","description":"The name on the transfer."},"compared_name":{"type":"string","description":"The name it was compared with."},"matched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` found in `compared_name`."},"mismatched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`."}},"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"travel_rule.timeline.items.[INDEX].name_match.oneOf.2","typeLabel":"null"}],"uniqueKey":"travel_rule.timeline.items.[INDEX].name_match","typeLabel":"object · null · null"},"reason":{"type":"string","description":"Present only on the entry of a transition a failed delivery caused: `email_undeliverable` or `delivery_failed`, the value the transfer's `reason` reports.","uniqueKey":"travel_rule.timeline.items.[INDEX].reason","typeLabel":"string"}},"uniqueKey":"travel_rule.timeline.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.timeline","typeLabel":"object[]"},"counterparty_vasp":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.name","typeLabel":"string"},"lei":{"type":"string","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.lei","typeLabel":"string"},"dd_score":{"type":"integer","description":"Due-diligence score from 0 to 100, where higher is better. Same scale as in the VASP directory.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score","typeLabel":"integer"},"dd_score_breakdown":{"type":"object","description":"Per-component contributions to dd_score, one object per component as in the VASP directory (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), each {points, max, reason, detail}. {} until the counterparty has been assessed.","additionalProperties":{"type":"object","properties":{"points":{"type":"number","description":"Points awarded for this component.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.points","typeLabel":"number"},"max":{"type":"integer","description":"Maximum points this component can award.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.max","typeLabel":"integer"},"reason":{"type":"string","description":"Machine-readable code of the component's verdict.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.reason","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable reason for the awarded points.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties.detail","typeLabel":"string"}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown.additionalProperties","typeLabel":"object"},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_score_breakdown","typeLabel":"object"},"dd_assessed_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed.","uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0.dd_assessed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string"},"lei":{"type":"string"},"dd_score":{"type":"integer","description":"Due-diligence score from 0 to 100, where higher is better. Same scale as in the VASP directory."},"dd_score_breakdown":{"type":"object","description":"Per-component contributions to dd_score, one object per component as in the VASP directory (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), each {points, max, reason, detail}. {} until the counterparty has been assessed.","additionalProperties":{"type":"object","properties":{"points":{"type":"number","description":"Points awarded for this component."},"max":{"type":"integer","description":"Maximum points this component can award."},"reason":{"type":"string","description":"Machine-readable code of the component's verdict."},"detail":{"type":"string","description":"Human-readable reason for the awarded points."}}}},"dd_assessed_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed."},{"type":"null","format":"date-time","description":"When the due-diligence assessment last ran. Null until the counterparty has been assessed."}]}},"uniqueKey":"travel_rule.counterparty_vasp.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.counterparty_vasp","typeLabel":"object | null"},"originator_data":{"type":"object","description":"Originator party. For an inbound transfer the counterparty's values are masked until ownership is confirmed.","uniqueKey":"travel_rule.originator_data","typeLabel":"object"},"beneficiary_data":{"type":"object","description":"Beneficiary party. For an inbound transfer the counterparty's values are masked until ownership is confirmed.","uniqueKey":"travel_rule.beneficiary_data","typeLabel":"object"},"name_match":{"oneOf":[{"type":"object","description":"The name comparison that decided the transfer, or null until one ran. While the parties are masked, and on the other customer's copy of an INTERNAL exchange, `transfer_name`, `compared_name`, `matched_names` and `mismatched_names` are hidden. `score` and `matched` can disagree: `matched` follows the strictness, `score` is the similarity of the two full names.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank.","uniqueKey":"travel_rule.name_match.oneOf.0.score","typeLabel":"integer"},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true.","uniqueKey":"travel_rule.name_match.oneOf.0.matched","typeLabel":"boolean"},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`).","uniqueKey":"travel_rule.name_match.oneOf.0.method","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.name_match.oneOf.0.strictness","typeLabel":"enum\u003cstring>"},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox.","uniqueKey":"travel_rule.name_match.oneOf.0.compared_with","typeLabel":"enum\u003cstring>"},"transfer_name":{"type":"string","description":"The name on the transfer.","uniqueKey":"travel_rule.name_match.oneOf.0.transfer_name","typeLabel":"string"},"compared_name":{"type":"string","description":"The name it was compared with.","uniqueKey":"travel_rule.name_match.oneOf.0.compared_name","typeLabel":"string"},"matched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.name_match.oneOf.0.matched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` found in `compared_name`.","uniqueKey":"travel_rule.name_match.oneOf.0.matched_names","typeLabel":"string[]"},"mismatched_names":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.name_match.oneOf.0.mismatched_names.items.[INDEX]","typeLabel":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`.","uniqueKey":"travel_rule.name_match.oneOf.0.mismatched_names","typeLabel":"string[]"}},"uniqueKey":"travel_rule.name_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"The name comparison that decided the transfer, or null until one ran. While the parties are masked, and on the other customer's copy of an INTERNAL exchange, `transfer_name`, `compared_name`, `matched_names` and `mismatched_names` are hidden. `score` and `matched` can disagree: `matched` follows the strictness, `score` is the similarity of the two full names.","properties":{"score":{"type":"integer","minimum":0,"maximum":100,"description":"Similarity of the two full names, 0 to 100. 0 when either name is blank."},"matched":{"type":"boolean","description":"Whether the names satisfy `strictness`. The transfer's outcome follows `data_match`, which compares every field, so a transfer can be COUNTERPARTY_MISMATCHED_DATA while this is true."},"method":{"type":"string","enum":["none","exact_token","token_subset","token_containment","sequence_ratio"],"description":"How `matched` was decided: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) or sequence_ratio (`FUZZY`)."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]},"compared_with":{"type":"string","enum":["wallet_holder","counterparty_vasp"],"description":"wallet_holder: the holder recorded for the wallet. counterparty_vasp: the name the counterparty answered on the email response page, or the Didit Test VASP's answer in sandbox."},"transfer_name":{"type":"string","description":"The name on the transfer."},"compared_name":{"type":"string","description":"The name it was compared with."},"matched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` found in `compared_name`."},"mismatched_names":{"type":"array","items":{"type":"string"},"description":"Words of `transfer_name` missing from `compared_name`, then words of `compared_name` missing from `transfer_name`."}},"uniqueKey":"travel_rule.name_match.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"travel_rule.name_match.oneOf.2","typeLabel":"null"}],"uniqueKey":"travel_rule.name_match","typeLabel":"object · null · null"},"data_match":{"oneOf":[{"type":"object","description":"Field-by-field comparison of the transfer's party data with what the other side knows about the wallet holder. It names fields and results, never values, so it stays readable while the counterparty's data is masked. Null until a comparison ran.","properties":{"matched":{"type":"boolean","description":"True when no compared field differs.","uniqueKey":"travel_rule.data_match.oneOf.0.matched","typeLabel":"boolean"},"mismatched_fields":{"type":"array","items":{"type":"string","enum":["name","date_of_birth","address","account"],"uniqueKey":"travel_rule.data_match.oneOf.0.mismatched_fields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The fields that differ.","uniqueKey":"travel_rule.data_match.oneOf.0.mismatched_fields","typeLabel":"enum\u003cstring>[]"},"fields":{"type":"object","description":"One entry per field compared for the party's entity type (`name`, `date_of_birth`, `address`, `account`; a company has no `date_of_birth`).","additionalProperties":{"type":"object","properties":{"result":{"type":"string","enum":["matched","mismatched","not_compared"],"description":"`not_compared` when the rule is `NONE` or either side has no value for the field.","uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties.result","typeLabel":"enum\u003cstring>"},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties.strictness","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.data_match.oneOf.0.fields.additionalProperties","typeLabel":"object"},"uniqueKey":"travel_rule.data_match.oneOf.0.fields","typeLabel":"object"}},"uniqueKey":"travel_rule.data_match.oneOf.0","typeLabel":"object"},{"type":"null","description":"Field-by-field comparison of the transfer's party data with what the other side knows about the wallet holder. It names fields and results, never values, so it stays readable while the counterparty's data is masked. Null until a comparison ran.","properties":{"matched":{"type":"boolean","description":"True when no compared field differs."},"mismatched_fields":{"type":"array","items":{"type":"string","enum":["name","date_of_birth","address","account"]},"description":"The fields that differ."},"fields":{"type":"object","description":"One entry per field compared for the party's entity type (`name`, `date_of_birth`, `address`, `account`; a company has no `date_of_birth`).","additionalProperties":{"type":"object","properties":{"result":{"type":"string","enum":["matched","mismatched","not_compared"],"description":"`not_compared` when the rule is `NONE` or either side has no value for the field."},"strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"]}}}}},"uniqueKey":"travel_rule.data_match.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.data_match","typeLabel":"object | null"},"mismatched_fields":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.mismatched_fields.items.[INDEX]","typeLabel":"string"},"description":"Shortcut for `data_match.mismatched_fields`. Empty when nothing differs.","uniqueKey":"travel_rule.mismatched_fields","typeLabel":"string[]"},"data_unmasked":{"oneOf":[{"type":"object","description":"Audit record of the moment the counterparty's data was unmasked. Null while the data is still masked, and for outbound transfers.","properties":{"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.data_unmasked.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"reason":{"type":"string","enum":["ownership_confirmed","wallet_proof","address_book_match","own_verified_wallet","inquiry_approved","known_payment_method","travel_address"],"description":"What confirmed ownership: ownership_confirmed (your confirmation through the console or the API), wallet_proof (a wallet proof in the widget, or an INTERNAL inbound transfer, set when it is created), address_book_match (a verified address-book wallet), own_verified_wallet (your user's own verified wallet), inquiry_approved (your approval of an inbound TRP inquiry or a GTR or Sygna message), known_payment_method (a wallet your user already paid with) or travel_address (the per-wallet travel address named the wallet).","uniqueKey":"travel_rule.data_unmasked.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"actor":{"type":"string","description":"Who confirmed it: the console user's email or the API key's label. Blank for an automatic decision.","uniqueKey":"travel_rule.data_unmasked.oneOf.0.actor","typeLabel":"string"}},"uniqueKey":"travel_rule.data_unmasked.oneOf.0","typeLabel":"object"},{"type":"null","description":"Audit record of the moment the counterparty's data was unmasked. Null while the data is still masked, and for outbound transfers.","properties":{"at":{"type":"string","format":"date-time"},"reason":{"type":"string","enum":["ownership_confirmed","wallet_proof","address_book_match","own_verified_wallet","inquiry_approved","known_payment_method","travel_address"],"description":"What confirmed ownership: ownership_confirmed (your confirmation through the console or the API), wallet_proof (a wallet proof in the widget, or an INTERNAL inbound transfer, set when it is created), address_book_match (a verified address-book wallet), own_verified_wallet (your user's own verified wallet), inquiry_approved (your approval of an inbound TRP inquiry or a GTR or Sygna message), known_payment_method (a wallet your user already paid with) or travel_address (the per-wallet travel address named the wallet)."},"actor":{"type":"string","description":"Who confirmed it: the console user's email or the API key's label. Blank for an automatic decision."}},"uniqueKey":"travel_rule.data_unmasked.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.data_unmasked","typeLabel":"object | null"},"data_masked":{"type":"boolean","description":"True while the counterparty's personal data is masked in this response.","uniqueKey":"travel_rule.data_masked","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.created_at","typeLabel":"string\u003cdate-time>"},"delivery":{"oneOf":[{"type":"object","description":"Where the latest message this transfer owes the other side stands. Null when the transfer never owed one (for example below `threshold_amount`, a declared self-hosted wallet, or a sunrise registration).","required":["kind","status","rail","attempts","last_error","next_attempt_at","delivered_at","updated_at","failure","route"],"properties":{"kind":{"type":"string","enum":["SEND","ANSWER","TXID","CANCEL","POLL"],"description":"What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it. `POLL`: a status query to a network that offers one, repeated every 5 minutes while the transfer waits on the counterparty.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["QUEUED","SENDING","RETRYING","DELIVERED","FAILED"],"description":"`QUEUED`: waiting to be sent. `SENDING`: an attempt is running. `RETRYING`: an attempt failed and the next one runs at `next_attempt_at`. `DELIVERED`: the other side took the message. `FAILED`: the other side refused it, or the last attempt failed.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.status","typeLabel":"enum\u003cstring>"},"rail":{"type":"string","enum":["INTERNAL","TRP","GTR","TRUST","VERIFYVASP","SYGNA","EMAIL","TEST_VASP",""],"description":"The rail that carries the message. Empty until Didit has chosen one for a first message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.rail","typeLabel":"enum\u003cstring>"},"attempts":{"type":"integer","minimum":0,"description":"Attempts made so far for this message. A message that is not a status poll is attempted at most 6 times.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.attempts","typeLabel":"integer"},"last_error":{"type":"string","description":"A short customer-safe reason for the last failure, `\"\"` when there is none: `email undeliverable`, `trp identity endpoint unreachable`, `trp transfer inquiry delivery failed` or `The message could not be delivered.` It never carries the counterparty's own answer, which stays on the transfer's `timeline`, and never a response body.","example":"email undeliverable","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.last_error","typeLabel":"string"},"next_attempt_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.next_attempt_at","typeLabel":"string\u003cdate-time> | null"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the other side took the message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the other side took the message.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.delivered_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"type":"string","format":"date-time","description":"When the delivery last changed.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"failure":{"oneOf":[{"type":"object","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered.","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.0","typeLabel":"object"},{"type":"null","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure."},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered."}},"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.failure","typeLabel":"object | null"},"route":{"oneOf":[{"type":"string","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.delivery.oneOf.0.route","typeLabel":"string | null"}},"uniqueKey":"travel_rule.delivery.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.delivery.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.delivery","typeLabel":"object | null"},"discovery":{"type":"array","description":"How Didit looked for the counterparty, one entry per step that ran. Empty when no discovery ran, for example on an inbound transfer.","items":{"type":"object","description":"One step of the counterparty discovery Didit ran for an outbound transfer, in the order it ran them. The first step that names a VASP with a route ends the chain.","properties":{"step":{"type":"string","enum":["internal_address_book","wallet_attribution","network_lookup","customer_hint","end_user"],"description":"`internal_address_book`: another Didit customer that proved control of the destination wallet. `wallet_attribution`: the wallet's blockchain analytics attribution. `network_lookup`: a network that can say which VASP holds the address. `customer_hint`: the VASP name, LEI or jurisdiction you sent in `beneficiary_data`. `end_user`: the counterparty the end user (or you) picked, or the request to pick one.","uniqueKey":"travel_rule.discovery.items.[INDEX].step","typeLabel":"enum\u003cstring>"},"outcome":{"type":"string","enum":["match","miss","skipped"],"description":"`match`: the step named a counterparty. `miss`: it ran and found none. `skipped`: it could not run, and `reason` says why.","uniqueKey":"travel_rule.discovery.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Machine-readable reason, `\"\"` on a match: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` or `picked_member_without_proven_wallet`.","uniqueKey":"travel_rule.discovery.items.[INDEX].reason","typeLabel":"string"},"vasp":{"oneOf":[{"type":"string","format":"uuid","description":"The directory VASP the step named, when it named one.","uniqueKey":"travel_rule.discovery.items.[INDEX].vasp.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The directory VASP the step named, when it named one.","uniqueKey":"travel_rule.discovery.items.[INDEX].vasp.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.discovery.items.[INDEX].vasp","typeLabel":"string\u003cuuid> | null"},"rail":{"oneOf":[{"type":"string","description":"The rail that reaches that counterparty, when the step found one.","uniqueKey":"travel_rule.discovery.items.[INDEX].rail.oneOf.0","typeLabel":"string"},{"type":"null","description":"The rail that reaches that counterparty, when the step found one.","uniqueKey":"travel_rule.discovery.items.[INDEX].rail.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.discovery.items.[INDEX].rail","typeLabel":"string | null"},"at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.discovery.items.[INDEX].at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"travel_rule.discovery.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.discovery","typeLabel":"object[]"},"reason":{"type":"string","description":"Why a `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE` transfer is stuck; `\"\"` for any other status. A failed delivery decides it first, on `COUNTERPARTY_VASP_NOT_REACHABLE` only: `email_undeliverable` (the mail provider refused the compliance email and no address is left to try: when it was sent, on a reminder, or as a permanent bounce reported later) or `delivery_failed` (the rail that was delivering failed for good: a network rail refused the message or ran out of retries, a `TRP` identity host did not answer, or the counterparty's `TRP` host did not accept the inquiry). Otherwise the `discovery` trace decides it: `awaiting_end_user` (no step named a counterparty Didit can reach), `directory_match_no_route` (a step named a directory VASP that has no route), `picked_member_without_proven_wallet` (the end user picked a Didit customer that has not proven control of the wallet and that the directory no longer lists), or `no_directory_match` when the trace gives no other reason. A resend moves the transfer on, so the reason clears. See [Why a transfer is stuck](/transaction-monitoring/travel-rule#why-a-transfer-is-stuck).","uniqueKey":"travel_rule.reason","typeLabel":"string"},"next_actions":{"type":"array","description":"What moves the transfer on; `[]` for any status but `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` offers `update_compliance_email`, then `resend`. `delivery_failed` offers `resend`. A discovery reason offers `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` and `resend`.","items":{"type":"object","description":"One thing that moves a `COUNTERPARTY_VASP_NOT_FOUND` or `COUNTERPARTY_VASP_NOT_REACHABLE` transfer on. See [Why a transfer is stuck](/transaction-monitoring/travel-rule#why-a-transfer-is-stuck).","properties":{"action":{"type":"string","enum":["select_counterparty_vasp","declare_self_hosted","add_vasp_hint","update_compliance_email","resend"],"description":"`select_counterparty_vasp`: the end user picks the destination VASP in the wallet-ownership widget, or you PATCH `action=beneficiary_vasp`. `declare_self_hosted`: the end user declares the wallet self-hosted in the widget. `add_vasp_hint`: tell Didit who the counterparty is, with a VASP name, LEI or travel address (for example a `travel_address` on the destination wallet's address-book entry), then resend. `update_compliance_email` and `resend` are `action` values of `PATCH /v3/transactions/{transaction_id}/travel-rule/`: give the counterparty's compliance email again, and re-run routing.","isRequired":true,"uniqueKey":"travel_rule.next_actions.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"The wallet-ownership widget link, on `select_counterparty_vasp` and `declare_self_hosted` while the transfer has an open widget session.","uniqueKey":"travel_rule.next_actions.items.[INDEX].url","typeLabel":"string\u003curi>"}},"required":["action"],"uniqueKey":"travel_rule.next_actions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.next_actions","typeLabel":"object[]"},"chain_details":{"type":"object","description":"How the transfer's chain names its two wallets, when that is more than one address paying another. Empty (`{}`) for an account-chain transfer (EVM, Solana, Tron), where the two addresses are the wallets. Matching, routing and the address book read the wallets from here first.","properties":{"chain":{"type":"string","description":"Canonical chain, e.g. `BTC`, `XRP`, or `LIGHTNING` for a Lightning transfer.","uniqueKey":"travel_rule.chain_details.chain","typeLabel":"string"},"shape":{"type":"string","enum":["utxo","memo","lightning"],"uniqueKey":"travel_rule.chain_details.shape","typeLabel":"enum\u003cstring>"},"originator":{"type":"object","description":"One side's wallet as Didit resolved it from the chain data.","properties":{"address":{"type":"string","description":"The wallet. On a memo network the classic address (an XRP X-address is split into its classic address and its tag); on Lightning the payee node id or Lightning Address.","uniqueKey":"travel_rule.chain_details.originator.address","typeLabel":"string"},"memo":{"type":"string","description":"The destination tag or memo that is part of the wallet; `\"\"` for none.","uniqueKey":"travel_rule.chain_details.originator.memo","typeLabel":"string"},"source":{"type":"string","enum":["declared","x_address","largest_input","only_non_change_output","amount_match","invoice_payee","updated"],"description":"Where the wallet came from: `declared` (your request), `x_address` (split from an XRP X-address), `largest_input` (the UTXO input address that contributed the most), `only_non_change_output` (the only UTXO output that is not change), `amount_match` (the one UTXO output paying the transfer amount), `invoice_payee` (the payee a Lightning payment request names), `updated` (set later with `action: update_originator_wallet`).","uniqueKey":"travel_rule.chain_details.originator.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"One side's wallet as Didit resolved it from the chain data.","properties":{"address":{"type":"string","description":"The wallet. On a memo network the classic address (an XRP X-address is split into its classic address and its tag); on Lightning the payee node id or Lightning Address.","uniqueKey":"travel_rule.chain_details.beneficiary.address","typeLabel":"string"},"memo":{"type":"string","description":"The destination tag or memo that is part of the wallet; `\"\"` for none.","uniqueKey":"travel_rule.chain_details.beneficiary.memo","typeLabel":"string"},"source":{"type":"string","enum":["declared","x_address","largest_input","only_non_change_output","amount_match","invoice_payee","updated"],"description":"Where the wallet came from: `declared` (your request), `x_address` (split from an XRP X-address), `largest_input` (the UTXO input address that contributed the most), `only_non_change_output` (the only UTXO output that is not change), `amount_match` (the one UTXO output paying the transfer amount), `invoice_payee` (the payee a Lightning payment request names), `updated` (set later with `action: update_originator_wallet`).","uniqueKey":"travel_rule.chain_details.beneficiary.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details.beneficiary","typeLabel":"object"},"utxo":{"type":"object","description":"On a UTXO transfer: the inputs and outputs as stored (amounts as decimal strings) and which outputs Didit read as what.","properties":{"inputs":{"type":"array","items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo.inputs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.chain_details.utxo.inputs","typeLabel":"object[]"},"outputs":{"type":"array","items":{"type":"object","description":"One input or output of a UTXO transaction, as the chain recorded it.","required":["address"],"properties":{"address":{"type":"string","maxLength":128,"isRequired":true,"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].address","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the coin's own unit (BTC, not satoshis). Optional.","example":"0.0125","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].amount","typeLabel":"string | null"},"txid":{"type":"string","maxLength":128,"description":"Optional. The transaction an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].txid","typeLabel":"string"},"vout":{"oneOf":[{"type":"integer","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Optional. The output index an input spends.","uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX].vout","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo.outputs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"travel_rule.chain_details.utxo.outputs","typeLabel":"object[]"},"change_output_indexes":{"type":"array","items":{"type":"integer","uniqueKey":"travel_rule.chain_details.utxo.change_output_indexes.items.[INDEX]","typeLabel":"integer"},"description":"Outputs that pay an input address back.","uniqueKey":"travel_rule.chain_details.utxo.change_output_indexes","typeLabel":"integer[]"},"beneficiary_output_index":{"oneOf":[{"type":"integer","description":"The output that pays the beneficiary; null when none could be told apart.","uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The output that pays the beneficiary; null when none could be told apart.","uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.chain_details.utxo.beneficiary_output_index","typeLabel":"integer | null"}},"uniqueKey":"travel_rule.chain_details.utxo","typeLabel":"object"},"lightning":{"type":"object","description":"On a Lightning transfer: what the payment request says. Always `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` or `unknown`); a BOLT11 invoice adds `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` and `expires_at`; a BOLT12 string `blinded_paths` and `payee_node_id`; an LNURL or a Lightning Address its `domain`. Nothing is resolved over the network: the request is decoded only.","additionalProperties":true,"uniqueKey":"travel_rule.chain_details.lightning","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","enum":["declared_originator_not_an_input","declared_beneficiary_not_an_output","beneficiary_output_ambiguous","beneficiary_output_amount_differs"],"uniqueKey":"travel_rule.chain_details.warnings.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"UTXO inconsistencies worth a look: the declared originator is not an input, the declared beneficiary is not an output, no single beneficiary output could be told apart, or the beneficiary output pays a different amount than the transaction states.","uniqueKey":"travel_rule.chain_details.warnings","typeLabel":"enum\u003cstring>[]"},"not_applicable_reason":{"type":"string","enum":["LIGHTNING_NO_PAYEE_IDENTIFIER","LIGHTNING_BOLT12_BLINDED_PAYEE","LIGHTNING_LNURL_NAMES_NO_PAYEE"],"description":"On an outbound Lightning transfer whose payment request names no payee: why the transfer is `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (the request names no payee node, or could not be decoded), `LIGHTNING_BOLT12_BLINDED_PAYEE` (the offer hides its payee behind blinded paths), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (an LNURL names a service, not a payee). The same code opens the transfer's last `timeline` entry.","uniqueKey":"travel_rule.chain_details.not_applicable_reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"travel_rule.chain_details","typeLabel":"object"},"deliveries":{"type":"array","maxItems":100,"items":{"type":"object","description":"One supplier-neutral entry in the delivery history.","required":["uuid","kind","status","rail","created_at","delivered_at","detail_lines","attempts","updated_at","next_attempt_at","failure","route"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Delivery identifier.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].uuid","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["SEND","ANSWER","TXID","CANCEL","POLL"],"description":"What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it. `POLL`: a status query to a network that offers one, repeated every 5 minutes while the transfer waits on the counterparty.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["QUEUED","SENDING","RETRYING","DELIVERED","FAILED"],"description":"Current delivery status.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"rail":{"oneOf":[{"type":"string","enum":["EMAIL","TRP","INTERNAL","NETWORK",null],"description":"Supplier-neutral transport type; null until selected.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EMAIL","TRP","INTERNAL","NETWORK",null],"description":"Supplier-neutral transport type; null until selected.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].rail","typeLabel":"enum\u003cstring> | null"},"created_at":{"type":"string","format":"date-time","description":"When the delivery was created.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"When delivery completed, or null.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When delivery completed, or null.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].delivered_at","typeLabel":"string\u003cdate-time> | null"},"detail_lines":{"type":"array","items":{"type":"string","uniqueKey":"travel_rule.deliveries.items.[INDEX].detail_lines.items.[INDEX]","typeLabel":"string"},"description":"Human-readable message kind and delivery status. Does not expose transport payloads or raw errors.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].detail_lines","typeLabel":"string[]"},"attempts":{"type":"integer","minimum":0,"description":"Attempts made so far for this message.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].attempts","typeLabel":"integer"},"updated_at":{"type":"string","format":"date-time","description":"When the delivery last changed.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"next_attempt_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the next attempt runs while the message is `QUEUED` or `RETRYING`.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].next_attempt_at","typeLabel":"string\u003cdate-time> | null"},"failure":{"oneOf":[{"type":"object","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered.","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.0","typeLabel":"object"},{"type":"null","required":["code","message"],"description":"Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe sentence: it never carries the counterparty's own text or a transport error.","properties":{"code":{"type":"string","enum":["email_undeliverable","delivery_failed"],"description":"`email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other failure."},"message":{"type":"string","description":"Customer-safe description of the failure.","example":"The message could not be delivered."}},"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].failure","typeLabel":"object | null"},"route":{"oneOf":[{"type":"string","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable name of the route that carried the message: `Email`, `TRP`, `Didit`, `Didit Test VASP`, the name of a network listed in the Marketplace, or `Network` for any other network. Null until a route is chosen.","example":"Email","isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.deliveries.items.[INDEX].route","typeLabel":"string | null"}},"example":{"uuid":"11111111-2222-4333-8444-555555555555","kind":"SEND","status":"DELIVERED","rail":"NETWORK","created_at":"2026-11-01T10:00:00Z","delivered_at":"2026-11-01T10:00:01Z","detail_lines":["Send","Delivered"],"attempts":1,"updated_at":"2026-11-01T10:00:01Z","next_attempt_at":null,"failure":null,"route":"Network"},"uniqueKey":"travel_rule.deliveries.items.[INDEX]","typeLabel":"object"},"description":"Newest 100 delivery entries, presented oldest first (creation time, then identifier). Empty when no messages exist. Use the paginated delivery endpoint for complete history.","uniqueKey":"travel_rule.deliveries","typeLabel":"object[]"},"deliveries_truncated":{"type":"boolean","description":"True when older entries were omitted from deliveries. Follow GET /v3/transactions/{transaction_id}/travel-rule/deliveries/ for the complete history.","uniqueKey":"travel_rule.deliveries_truncated","typeLabel":"boolean"},"not_required_reason":{"oneOf":[{"type":"string","description":"Null when required is true. Otherwise below_threshold, the recorded chain exemption (for example LIGHTNING_NO_PAYEE_IDENTIFIER, LIGHTNING_BOLT12_BLINDED_PAYEE or LIGHTNING_LNURL_NAMES_NO_PAYEE), or unknown for legacy transfers without a recorded reason.","example":"below_threshold","uniqueKey":"travel_rule.not_required_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Null when required is true. Otherwise below_threshold, the recorded chain exemption (for example LIGHTNING_NO_PAYEE_IDENTIFIER, LIGHTNING_BOLT12_BLINDED_PAYEE or LIGHTNING_LNURL_NAMES_NO_PAYEE), or unknown for legacy transfers without a recorded reason.","example":"below_threshold","uniqueKey":"travel_rule.not_required_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.not_required_reason","typeLabel":"string | null"},"proof_state":{"type":"string","description":"not_required when the transfer is not required; otherwise confirmed or not_confirmed follows ownership_confirmed. With no verdict, requested means an active outbound ownership widget matches this transfer and subject; otherwise not_requested. A request is not completed proof.","enum":["not_required","confirmed","not_confirmed","requested","not_requested"],"example":"not_requested","uniqueKey":"travel_rule.proof_state","typeLabel":"enum\u003cstring>"},"cancel_reason":{"type":"string","description":"Recorded cancellation reason, empty when unspecified.","enum":["","user_cancelled","wrong_wallet","compliance_decision","other"],"uniqueKey":"travel_rule.cancel_reason","typeLabel":"enum\u003cstring>"},"cancelled_by":{"type":"string","description":"Recorded cancellation actor, or an empty string when none is recorded.","uniqueKey":"travel_rule.cancelled_by","typeLabel":"string"},"notify_on_answer":{"type":"boolean","description":"Saved team notification preference. Initially false.","uniqueKey":"travel_rule.notify_on_answer","typeLabel":"boolean"},"user_choice":{"oneOf":[{"type":"object","description":"Explicit user-choice state, or null when counterparty_choice=user was not requested.","required":["active","waiting","end_user_link","link_expires_at","emailed_to","email_available"],"properties":{"active":{"type":"boolean","description":"True when explicit user choice was requested.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.active","typeLabel":"boolean"},"waiting":{"type":"boolean","description":"True with no selected directory VASP while status is AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE or UNCONFIRMED_OWNERSHIP.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.waiting","typeLabel":"boolean"},"end_user_link":{"type":"string","description":"Latest open end-user link, or an empty string when none is available.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.end_user_link","typeLabel":"string"},"link_expires_at":{"oneOf":[{"type":"string","description":"Expiry of the open link, or null.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Expiry of the open link, or null.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.link_expires_at","typeLabel":"string\u003cdate-time> | null"},"emailed_to":{"type":"string","description":"Recorded recipient of the user-choice email, or an empty string.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.emailed_to","typeLabel":"string"},"email_available":{"type":"boolean","description":"Recorded availability of an end-user email for user choice.","isRequired":true,"uniqueKey":"travel_rule.user_choice.oneOf.0.email_available","typeLabel":"boolean"}},"uniqueKey":"travel_rule.user_choice.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.user_choice.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.user_choice","typeLabel":"object | null"},"proof_request":{"oneOf":[{"type":"object","description":"Latest application- and subject-scoped request if it matches this transfer counterparty wallet and chain; otherwise null. A standalone request is not attached to a transfer. Request status and proof verdict are separate from the saved transfer decision.","required":["request_id","status","expires_at","proof"],"properties":{"request_id":{"type":"string","description":"Identifier of the matching widget request. Does not expose its access token.","format":"uuid","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.request_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"COMPLETED when the request was completed; otherwise EXPIRED once expires_at has passed, or PENDING. This is the request status, not the proof verdict.","enum":["PENDING","COMPLETED","EXPIRED"],"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.status","typeLabel":"enum\u003cstring>"},"expires_at":{"type":"string","description":"Expiry of the widget request.","format":"date-time","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.expires_at","typeLabel":"string\u003cdate-time>"},"proof":{"oneOf":[{"type":"object","description":"Latest proof submitted for this request and matching wallet/chain, or null when none exists. Null after the wallet and its proofs are deleted; the saved transfer decision stays unchanged.","properties":{"proof_id":{"type":"string","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.proof_id","typeLabel":"string\u003cuuid>"},"method":{"type":"string","enum":["MESSAGE_SIGNING","SATOSHI_TEST","SCREENSHOT","SELF_DECLARATION"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PENDING","VERIFIED","REJECTED","EXPIRED"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.status","typeLabel":"enum\u003cstring>"},"wallet_address":{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.wallet_address","typeLabel":"string"},"chain":{"type":"string","description":"Canonical chain identifier, e.g. ETH, BTC, SOL, TRX.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.chain","typeLabel":"string"},"holder_name":{"type":"string","description":"Holder name from the submitting widget, never a reassigned holder. Empty when the submitting widget was deleted.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.holder_name","typeLabel":"string"},"is_ownership_verified":{"type":"boolean","description":"Whether the address book entry is ownership-verified, by this proof or another one.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.is_ownership_verified","typeLabel":"boolean"},"transaction_id":{"oneOf":[{"type":"string","format":"uuid","description":"The transaction whose Travel Rule transfer the widget session was minted for. Null for a session minted without a transaction_id.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The transaction whose Travel Rule transfer the widget session was minted for. Null for a session minted without a transaction_id.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.transaction_id","typeLabel":"string\u003cuuid> | null"},"file_name":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.file_name","typeLabel":"string | null"},"content_type":{"oneOf":[{"type":"string","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.content_type","typeLabel":"string | null"},"screenshot_url":{"oneOf":[{"type":"string","description":"Authorized /v3/media/preview/ URL with an expiring signed source for this proof screenshot. Returns a recompressed preview, not the original upload or an arbitrary public URL. Null when no eligible screenshot exists. Read the proof again for a fresh link.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Authorized /v3/media/preview/ URL with an expiring signed source for this proof screenshot. Returns a recompressed preview, not the original upload or an arbitrary public URL. Null when no eligible screenshot exists. Read the proof again for a fresh link.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.screenshot_url","typeLabel":"string | null"},"attempts":{"type":"integer","description":"Number of attempts made for this proof.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.attempts","typeLabel":"integer"},"failure_reason":{"type":"string","description":"Fixed failure code for this proof or its last attempt; empty when no documented failure applies. A PENDING proof can carry a failure code while another attempt remains possible.","enum":["","SIGNATURE_INVALID","SIGNATURE_UNSUPPORTED_SCHEME","SIGNATURE_LOOKUP_FAILED","DEPOSIT_NOT_FOUND","DEPOSIT_UNCONFIRMED","DEPOSIT_LOOKUP_FAILED","DEPOSIT_MISMATCH","DEPOSIT_STALE","TXID_REUSED","CHAIN_UNSUPPORTED","WINDOW_EXPIRED","OWNERSHIP_CHANGED","METHOD_SWITCHED","REVIEW_REJECTED","ABANDONED"],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.failure_reason","typeLabel":"enum\u003cstring>"},"method_chosen_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the end user chose this proof method, or null when unavailable.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the end user chose this proof method, or null when unavailable.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.method_chosen_at","typeLabel":"string\u003cdate-time> | null"},"decided_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_at","typeLabel":"string\u003cdate-time> | null"},"decided_by":{"type":"string","description":"Who closed the proof: review:\u003cuser identifier> for a console reviewer, review for an API-key decision, widget or sweeper when Didit closed it automatically. Empty while PENDING.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.decided_by","typeLabel":"string"},"review_note":{"type":"string","description":"The note sent with the decision. Empty when none.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.review_note","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"application_id":{"type":"string","description":"Application that owns the wallet and proof.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.application_id","typeLabel":"string\u003cuuid>"},"user_id":{"oneOf":[{"type":"string","description":"User in this application matching the submitting widget vendor_data. Null when no matching current user exists, or the submitting widget was deleted. Never the reassigned wallet holder.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"User in this application matching the submitting widget vendor_data. Null when no matching current user exists, or the submitting widget was deleted. Never the reassigned wallet holder.","format":"uuid","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.user_id","typeLabel":"string\u003cuuid> | null"},"holder_vendor_data":{"type":"string","description":"Holder identifier from the submitting widget, not the current wallet holder. Empty when the submitting widget was deleted.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.holder_vendor_data","typeLabel":"string"},"wallet_label":{"type":"string","description":"Exact current wallet label, including an empty string when no label is set. Not a name inferred from the holder or address.","uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0.wallet_label","typeLabel":"string"}},"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travel_rule.proof_request.oneOf.0.proof","typeLabel":"object | null"}},"uniqueKey":"travel_rule.proof_request.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"travel_rule.proof_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"travel_rule.proof_request","typeLabel":"object | null"}},"uniqueKey":"travel_rule","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","txn_id":"\u003cstring>","created":true,"travel_rule":{"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"AWAITING_COUNTERPARTY","direction":"INBOUND","rail":"INTERNAL","protocol":"\u003cstring>","ivms_version":"ivms101.2023","required":true,"ownership_confirmed":true,"deadline_at":"2023-11-07T05:31:56Z","timeline":[{"status":"\u003cstring>","at":"2023-11-07T05:31:56Z","detail":"\u003cstring>","name_match":{"score":50,"matched":true,"method":"none","strictness":"NONE","compared_with":"wallet_holder","transfer_name":"\u003cstring>","compared_name":"\u003cstring>","matched_names":["\u003cstring>"],"mismatched_names":["\u003cstring>"]},"reason":"\u003cstring>"}],"counterparty_vasp":{"name":"\u003cstring>","lei":"\u003cstring>","dd_score":123,"dd_score_breakdown":{},"dd_assessed_at":"2023-11-07T05:31:56Z"},"originator_data":{},"beneficiary_data":{},"name_match":{"score":50,"matched":true,"method":"none","strictness":"NONE","compared_with":"wallet_holder","transfer_name":"\u003cstring>","compared_name":"\u003cstring>","matched_names":["\u003cstring>"],"mismatched_names":["\u003cstring>"]},"data_match":{"matched":true,"mismatched_fields":["name"],"fields":{}},"mismatched_fields":["\u003cstring>"],"data_unmasked":{"at":"2023-11-07T05:31:56Z","reason":"ownership_confirmed","actor":"\u003cstring>"},"data_masked":true,"created_at":"2023-11-07T05:31:56Z","delivery":{"kind":"SEND","status":"QUEUED","rail":"INTERNAL","attempts":1,"last_error":"email undeliverable","next_attempt_at":"2023-11-07T05:31:56Z","delivered_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","failure":{"code":"email_undeliverable","message":"The message could not be delivered."},"route":"Email"},"discovery":[{"step":"internal_address_book","outcome":"match","reason":"\u003cstring>","vasp":"3c90c3cc-0d44-4b50-8888-8dd25736052a","rail":"\u003cstring>","at":"2023-11-07T05:31:56Z"}],"reason":"\u003cstring>","next_actions":[{"action":"select_counterparty_vasp","url":"\u003cstring>"}],"chain_details":{"chain":"\u003cstring>","shape":"utxo","originator":{"address":"\u003cstring>","memo":"\u003cstring>","source":"declared"},"beneficiary":{"address":"\u003cstring>","memo":"\u003cstring>","source":"declared"},"utxo":{"inputs":[{"address":"\u003cstring>","amount":"0.0125","txid":"\u003cstring>","vout":1}],"outputs":[{"address":"\u003cstring>","amount":"0.0125","txid":"\u003cstring>","vout":1}],"change_output_indexes":[123],"beneficiary_output_index":123},"lightning":{},"warnings":["declared_originator_not_an_input"],"not_applicable_reason":"LIGHTNING_NO_PAYEE_IDENTIFIER"},"deliveries":[{"uuid":"11111111-2222-4333-8444-555555555555","kind":"SEND","status":"DELIVERED","rail":"NETWORK","created_at":"2026-11-01T10:00:00Z","delivered_at":"2026-11-01T10:00:01Z","detail_lines":["Send","Delivered"],"attempts":1,"updated_at":"2026-11-01T10:00:01Z","next_attempt_at":null,"failure":null,"route":"Network"}],"deliveries_truncated":true,"not_required_reason":"below_threshold","proof_state":"not_requested","cancel_reason":"","cancelled_by":"\u003cstring>","notify_on_answer":true,"user_choice":{"active":true,"waiting":true,"end_user_link":"\u003cstring>","link_expires_at":"2023-11-07T05:31:56Z","emailed_to":"\u003cstring>","email_available":true},"proof_request":{"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"PENDING","expires_at":"2023-11-07T05:31:56Z","proof":{"proof_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","method":"MESSAGE_SIGNING","status":"PENDING","wallet_address":"\u003cstring>","chain":"\u003cstring>","holder_name":"\u003cstring>","is_ownership_verified":true,"transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","file_name":"\u003cstring>","content_type":"\u003cstring>","screenshot_url":"\u003cstring>","attempts":123,"failure_reason":"","method_chosen_at":"2023-11-07T05:31:56Z","decided_at":"2023-11-07T05:31:56Z","decided_by":"\u003cstring>","review_note":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","application_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","user_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","holder_vendor_data":"\u003cstring>","wallet_label":"\u003cstring>"}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"da979c45-884b-4049-a4cf-19bf88b30d10":{"description":"A required field (`chain`, `txid`, `wallet_address`, `amount`, `currency`) is missing, `originating_vasp.lei` is not a valid LEI, `originating_vasp.travel_address` is not a valid travel address, a memo, X-address or `utxo` the chain cannot carry, or `originator_data` / `beneficiary_data` that is not an object.","content":{"application/json":{"examples":{"Missing field":{"title":"Missing field","value":{"txid":["This field is required."]}},"Invalid LEI":{"title":"Invalid LEI","value":{"originating_vasp":{"lei":["Invalid LEI: expected 20 alphanumeric characters (ISO 17442)."]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7941e524-f359-44b3-9f2c-22522b012416":{"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":{"020faff0-0394-4c06-9271-4c2a538bea7c":{"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":"Register Inbound Sunrise Transfer API: Travel Rule - Didit Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/management-api/travel-rule/register-inbound","matchLevel":0},"es":{"href":"/es/management-api/travel-rule/register-inbound","matchLevel":1},"pt-BR":{"href":"/pt-br/management-api/travel-rule/register-inbound","matchLevel":1},"ja":{"href":"/ja/management-api/travel-rule/register-inbound","matchLevel":1},"de":{"href":"/de/management-api/travel-rule/register-inbound","matchLevel":1},"fr":{"href":"/fr/management-api/travel-rule/register-inbound","matchLevel":1},"it":{"href":"/it/management-api/travel-rule/register-inbound","matchLevel":1},"pt":{"href":"/pt/management-api/travel-rule/register-inbound","matchLevel":1},"ca":{"href":"/ca/management-api/travel-rule/register-inbound","matchLevel":1},"id":{"href":"/id/management-api/travel-rule/register-inbound","matchLevel":1},"ru":{"href":"/ru/management-api/travel-rule/register-inbound","matchLevel":1},"ko":{"href":"/ko/management-api/travel-rule/register-inbound","matchLevel":1},"zh":{"href":"/zh/management-api/travel-rule/register-inbound","matchLevel":1},"ar":{"href":"/ar/management-api/travel-rule/register-inbound","matchLevel":1},"hi":{"href":"/hi/management-api/travel-rule/register-inbound","matchLevel":1}}},"lastModified":"2026-11-11T12:16:37.912Z","gitLastModified":"2026-11-11T12:04:23.000Z","originalFileLocation":"management-api/travel-rule/register-inbound.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=\"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\">\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=\"Register Inbound Sunrise Transfer API: Travel Rule - Didit Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Didit Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.didit.me/management-api/travel-rule/register-inbound\">\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=Travel+Rule\u0026amp;title=Register+Inbound+Sunrise+Transfer+API%3A+Travel+Rule\u0026amp;description=Register+Travel+Rule+data+for+a+crypto+deposit+that+already+settled+on-chain+before+any+exchange+took+place+-+the+after-deposit+sunrise+flow.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=3d39d4a2ecd66700e1044f576734f6a4566b42063ec253b7a084f325ff3f6dec\">\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=\"Register Inbound Sunrise Transfer API: Travel Rule - Didit Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Travel+Rule\u0026amp;title=Register+Inbound+Sunrise+Transfer+API%3A+Travel+Rule\u0026amp;description=Register+Travel+Rule+data+for+a+crypto+deposit+that+already+settled+on-chain+before+any+exchange+took+place+-+the+after-deposit+sunrise+flow.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=3d39d4a2ecd66700e1044f576734f6a4566b42063ec253b7a084f325ff3f6dec\">\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/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/management-api/travel-rule/register-inbound.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.didit.me/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.didit.me/es/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.didit.me/pt-br/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.didit.me/ja/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.didit.me/de/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.didit.me/fr/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.didit.me/it/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.didit.me/pt/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.didit.me/ca/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"id\" href=\"https://docs.didit.me/id/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.didit.me/ru/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.didit.me/ko/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.didit.me/zh/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://docs.didit.me/ar/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hi\" href=\"https://docs.didit.me/hi/management-api/travel-rule/register-inbound\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.didit.me/management-api/travel-rule/register-inbound\">\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/management-api/travel-rule/register-inbound#webpage\",\"url\":\"https://docs.didit.me/management-api/travel-rule/register-inbound\",\"name\":\"Register Inbound Sunrise Transfer API: Travel Rule\",\"description\":\"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\",\"dateModified\":\"2026-11-11T12:04:23.000Z\",\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.didit.me/management-api/travel-rule/register-inbound#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.didit.me/management-api/travel-rule/register-inbound#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Travel Rule\",\"item\":\"https://docs.didit.me/management-api/travel-rule/get-settings\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Register Inbound Sunrise Transfer API: Travel Rule\",\"item\":\"https://docs.didit.me/management-api/travel-rule/register-inbound\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.didit.me/management-api/travel-rule/register-inbound#apireference\",\"headline\":\"Register Inbound Sunrise Transfer API: Travel Rule\",\"name\":\"Register Inbound Sunrise Transfer API: Travel Rule\",\"description\":\"Register Travel Rule data for a crypto deposit that already settled on-chain before any exchange took place - the after-deposit sunrise flow.\",\"url\":\"https://docs.didit.me/management-api/travel-rule/register-inbound\",\"mainEntityOfPage\":{\"@id\":\"https://docs.didit.me/management-api/travel-rule/register-inbound#webpage\"},\"dateModified\":\"2026-11-11T12:04:23.000Z\",\"keywords\":\"sunrise registration API, inbound travel rule transfer, after-deposit registration, travel rule backfill, unreachable VASP deposit, Didit Management API\",\"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":"/management-api/travel-rule/register-inbound.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","description":"Send a message or a document request to the counterparty VASP of a Travel Rule transfer, with optional attachments.","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","description":"Sandbox only: have the Didit Test VASP send your application an inbound Travel Rule transfer and watch your own decision, inbox and ownership flow run.","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"}]}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]},{"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/management-api/travel-rule/register-inbound"}]}]},"basePath":"","title":"Register Inbound Sunrise Transfer API: Travel Rule - Didit Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}