using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest
{
VaspId = "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11",
});
Console.WriteLine(JsonSerializer.Serialize(result));
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest
{
VaspId = "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11",
});
Console.WriteLine(JsonSerializer.Serialize(result));
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.
Profile values taken from the directory entry: vasp_id, legal_name, lei, jurisdiction, compliance_email, domains. Nothing is written until the claim is made.
{"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":"6af21c0674471b0cd9b93587","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"ca","tag":"Referència de l'API","count":432},{"language":"de","tag":"API-Referenz","count":432},{"language":"es","tag":"Referencia de la API","count":432},{"language":"fr","tag":"Référence API","count":432},{"language":"id","tag":"Referensi API","count":432},{"language":"it","tag":"Riferimento API","count":432},{"language":"ja","tag":"APIリファレンス","count":432},{"language":"pt-BR","tag":"Referência da API","count":432},{"language":"pt","tag":"Referência da API","count":432},{"language":"ru","tag":"Справочник API","count":432},{"language":"ar","tag":"مرجع API","count":431},{"language":"hi","tag":"API संदर्भ","count":431},{"language":"ko","tag":"API 레퍼런스","count":431},{"language":"zh","tag":"API 参考","count":431},{"language":"en","tag":"API Reference","count":424},{"language":"en","tag":"Database Validation","count":129},{"language":"ca","tag":"Validació en bases de dades","count":129},{"language":"de","tag":"Datenbankvalidierung","count":129},{"language":"es","tag":"Validación de base de datos","count":129},{"language":"fr","tag":"Validation en base de données","count":129},{"language":"id","tag":"Validasi Database","count":129},{"language":"it","tag":"Validazione su database","count":129},{"language":"ja","tag":"データベース検証","count":129},{"language":"pt-BR","tag":"Validação de banco de dados","count":129},{"language":"pt","tag":"Validação de base de dados","count":129},{"language":"ru","tag":"Проверка по базам данных","count":129},{"language":"ar","tag":"التحقق من قواعد البيانات","count":128},{"language":"hi","tag":"डेटाबेस सत्यापन","count":128},{"language":"ko","tag":"데이터베이스 검증","count":128},{"language":"zh","tag":"数据库核验","count":128},{"language":"ca","tag":"Primers passos","count":93},{"language":"de","tag":"Erste Schritte","count":93},{"language":"es","tag":"Primeros pasos","count":93},{"language":"ja","tag":"はじめに","count":93},{"language":"ko","tag":"시작하기","count":93},{"language":"pt-BR","tag":"Primeiros passos","count":93},{"language":"ru","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":"ko","tag":"인증","count":85},{"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":"Integrate / SDKs","count":62},{"language":"ar","tag":"التكامل / SDKs","count":62},{"language":"ca","tag":"Integració / SDK","count":62},{"language":"de","tag":"Integrieren / SDKs","count":62},{"language":"es","tag":"Integración / SDKs","count":62},{"language":"fr","tag":"Intégrer / SDK","count":62},{"language":"hi","tag":"इंटीग्रेट करें / SDK","count":62},{"language":"id","tag":"Integrasi / SDK","count":62},{"language":"it","tag":"Integrazione / SDK","count":62},{"language":"ja","tag":"連携 / SDK","count":62},{"language":"ko","tag":"연동 / SDK","count":62},{"language":"pt-BR","tag":"Integração / SDKs","count":62},{"language":"pt","tag":"Integrar / SDKs","count":62},{"language":"ru","tag":"Интеграция / SDK","count":62},{"language":"zh","tag":"集成 / SDK","count":62},{"language":"en","tag":"Travel Rule","count":55},{"language":"ar","tag":"Travel Rule","count":55},{"language":"ca","tag":"Travel Rule","count":55},{"language":"de","tag":"Travel Rule","count":55},{"language":"es","tag":"Travel Rule","count":55},{"language":"fr","tag":"Travel Rule","count":55},{"language":"hi","tag":"Travel Rule","count":55},{"language":"id","tag":"Travel Rule","count":55},{"language":"it","tag":"Travel Rule","count":55},{"language":"ja","tag":"トラベルルール","count":55},{"language":"ko","tag":"Travel Rule","count":55},{"language":"pt-BR","tag":"Travel Rule","count":55},{"language":"pt","tag":"Travel Rule","count":55},{"language":"ru","tag":"Travel Rule","count":55},{"language":"zh","tag":"Travel Rule","count":55},{"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":"Authentication","count":37},{"language":"ar","tag":"المصادقة","count":37},{"language":"ca","tag":"Autenticació","count":37},{"language":"de","tag":"Authentifizierung","count":37},{"language":"es","tag":"Autenticación","count":37},{"language":"fr","tag":"Authentification","count":37},{"language":"hi","tag":"प्रमाणीकरण","count":37},{"language":"id","tag":"Autentikasi","count":37},{"language":"it","tag":"Autenticazione","count":37},{"language":"ja","tag":"認証","count":37},{"language":"pt-BR","tag":"Autenticação","count":37},{"language":"pt","tag":"Autenticação","count":37},{"language":"ru","tag":"Аутентификация","count":37},{"language":"zh","tag":"身份认证","count":37},{"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-BR","tag":"Verificações de usuários e empresas","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":28}]},"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":"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":"llms-txt-v2","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":"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":"comment-mode","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/claim-workspace","slug":"/management-api/travel-rule/claim-workspace","pageMetadata":{"title":"Claim a Directory Entry API - Travel Rule Free Join","sidebarTitle":"Claim a Directory Entry","description":"Claim a directory entry: Claims the directory entry this workspace is.","keywords":["travel rule free account","counterparty VASP join","claim workspace","Didit Management API"],"openapi":"openapi-25.json POST /v3/travel-rule/workspace/claim/","href":"/management-api/travel-rule/claim-workspace"},"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: \"Claim a directory entry: Claims the directory entry this workspace is.\"\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:`Claim a Directory Entry API Prompt`,prompt:`Claims the directory entry this workspace is. When the work email is at a domain the entry lists, the claim is proved and applies at once: the VASP profile and Travel Rule settings are filled from the entry and Travel Rule is turned on, so the next transfer to it routes over the Didit network. Otherwise the claim waits for review (\\`pending_review\\`).\n\nEndpoint:\nPOST https://verification.didit.me/v3/travel-rule/workspace/claim/\n\nAuthentication:\nUse the x-api-key header with the API key returned when the account was created.\n\nRequest body (application/json):\n{\"vasp_id\": \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\"}\n\nFailure modes:\n- 400 - No directory entry has this id.\n- 404 - This application did not join free, so it has no free workspace.\n\nGuide: /transaction-monitoring/travel-rule-interoperability#email-pickup.`})})}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":"Claim a Directory Entry API - Travel Rule Free Join","sidebarTitle":"Claim a Directory Entry","description":"Claim a directory entry: Claims the directory entry this workspace is.","keywords":["travel rule free account","counterparty VASP join","claim workspace","Didit Management API"],"openapi":"openapi-25.json POST /v3/travel-rule/workspace/claim/","href":"/management-api/travel-rule/claim-workspace"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[19,69,"jsx:_jsx}=arguments["],[171,4204,"undefined;const AgentPromptAccordion=()=>null;function _crea"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/didit-0f962782/75622e87c9213fdc/snippets/data/database-validation-coverage.js","/_mintlify/custom/didit-0f962782/4ac7d3c2a19a354d/database-validation-playground.js"],"openApiReferenceData":{"operation":{"summary":"Claim a directory entry","description":"Claim a directory entry: Claims the directory entry this workspace is.","operationId":"claimTravelRuleWorkspace","x-didit-sdk":{"resource":"travel_rule.workspace","method":"claim","auth":"api_key","server":true},"tags":["Travel Rule"],"security":["87720ed7-fd5b-4bb6-bd5a-11f7d4e182fb"],"requestBody":"89b2b301-ad04-4946-8a43-d1eca503a12a","x-codeSamples":[{"lang":"curl","label":"curl","source":"curl -X POST https://verification.didit.me/v3/travel-rule/workspace/claim/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp_id\": \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\"}'"},{"lang":"python","label":"Python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.claim(\n vasp_id=\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\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.workspace.claim({\n vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\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.Workspace.Claim(ctx, didit.TravelRuleWorkspaceClaimRequest{\n\tVASPID: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"lang":"java","label":"Java","source":"import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceClaimRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().claim(TravelRuleWorkspaceClaimRequest.builder()\n .vaspId(\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\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->workspace->claim([\n 'vasp_id' => '0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11',\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.workspace.claim(vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\nputs result.to_h"},{"lang":"csharp","label":".NET","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest\n{\n VaspId = \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"responses":{"200":"8364eeeb-ab69-4fe2-bf3a-eca3a6b10c2a","400":"bf0360a7-3e14-4491-a583-e3b79040e6f7","404":"ffc5c8fb-4918-43ec-9be4-97e4b6f53713"},"method":"post","type":"path","servers":["4e6542eb-58fc-460e-bd2a-3d7c451cb2b5"],"path":"/v3/travel-rule/workspace/claim/","baseUrlOptions":["https://verification.didit.me"],"title":"Claim a directory entry","codeSamples":[{"label":"curl","lang":"curl","source":"curl -X POST https://verification.didit.me/v3/travel-rule/workspace/claim/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp_id\": \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\"}'"},{"label":"Python","lang":"python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.claim(\n vasp_id=\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\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.workspace.claim({\n vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\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.Workspace.Claim(ctx, didit.TravelRuleWorkspaceClaimRequest{\n\tVASPID: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"label":"Java","lang":"java","source":"import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceClaimRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().claim(TravelRuleWorkspaceClaimRequest.builder()\n .vaspId(\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\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->workspace->claim([\n 'vasp_id' => '0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11',\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.workspace.claim(vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\nputs result.to_h"},{"label":".NET","lang":"csharp","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest\n{\n VaspId = \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.vasp_id":"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11"}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vasp_id"],"properties":{"vasp_id":{"type":"string","format":"uuid","description":"The directory entry this workspace is. Read ids from `GET /v3/travel-rule/vasps/`.","isRequired":true,"uniqueKey":"vasp_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"vasp_id":"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11"},"examples":{"Example":{"title":"Example","value":{"vasp_id":"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"8364eeeb-ab69-4fe2-bf3a-eca3a6b10c2a":{"description":"The workspace with its claim status.","content":{"application/json":{"schema":{"type":"object","description":"The free Travel Rule workspace of an application that joined free.","properties":{"joined_free":{"type":"boolean","uniqueKey":"joined_free","typeLabel":"boolean"},"work_email":{"type":"string","format":"email","uniqueKey":"work_email","typeLabel":"string\u003cemail>"},"joined_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"joined_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"joined_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"joined_at","typeLabel":"string\u003cdate-time> | null"},"claim":{"type":"object","properties":{"status":{"type":"string","enum":["unclaimed","pending_review","claimed","rejected"],"uniqueKey":"claim.status","typeLabel":"enum\u003cstring>"},"proved_by_domain":{"type":"boolean","uniqueKey":"claim.proved_by_domain","typeLabel":"boolean"},"claimed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"claim.claimed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"claim.claimed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim.claimed_at","typeLabel":"string\u003cdate-time> | null"},"reviewed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"claim.reviewed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"claim.reviewed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim.reviewed_at","typeLabel":"string\u003cdate-time> | null"},"review_note":{"type":"string","uniqueKey":"claim.review_note","typeLabel":"string"},"vasp_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"claim.vasp_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"claim.vasp_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim.vasp_id","typeLabel":"string\u003cuuid> | null"},"vasp_name":{"type":"string","uniqueKey":"claim.vasp_name","typeLabel":"string"}},"uniqueKey":"claim","typeLabel":"object"},"prefill":{"type":"object","description":"Profile values taken from the directory entry: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. Nothing is written until the claim is made.","uniqueKey":"prefill","typeLabel":"object"},"domain":{"type":"object","properties":{"domain":{"type":"string","uniqueKey":"domain.domain","typeLabel":"string"},"status":{"type":"string","enum":["unverified","code_sent","verified"],"uniqueKey":"domain.status","typeLabel":"enum\u003cstring>"},"verified_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"domain.verified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"domain.verified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain.verified_at","typeLabel":"string\u003cdate-time> | null"},"txt":{"type":"object","description":"The TXT record to publish for the DNS proof. Empty until a proof has been started.","properties":{"host":{"type":"string","example":"didit-tr-verify.example.com","uniqueKey":"domain.txt.host","typeLabel":"string"},"value":{"type":"string","uniqueKey":"domain.txt.value","typeLabel":"string"}},"uniqueKey":"domain.txt","typeLabel":"object"}},"uniqueKey":"domain","typeLabel":"object"},"billing_enabled":{"type":"boolean","description":"Receiving Travel Rule data is free. Sending is billed only after billing is enabled.","uniqueKey":"billing_enabled","typeLabel":"boolean"},"billing_enabled_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"billing_enabled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"billing_enabled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_enabled_at","typeLabel":"string\u003cdate-time> | null"},"didit_network":{"type":"object","description":"Whether the Didit network lists this VASP and, when not, each condition it still misses.","uniqueKey":"didit_network","typeLabel":"object"},"settings":{"type":"object","properties":{"is_enabled":{"type":"boolean","description":"Whether the managed Travel Rule negotiation flow is active for outbound `travelRule` transactions on this application.","uniqueKey":"settings.is_enabled","typeLabel":"boolean"},"jurisdiction":{"type":"string","maxLength":8,"description":"Your VASP's operating jurisdiction code. Default `\"EU\"`. Didit maps it to the regime it stamps on your Travel Rule transactions as `travel_rule_regime` (for example `EU` or an EU member code becomes `eu`), which transaction rules can key on. Other Didit customers see it as your jurisdiction in the VASP directory once the Didit network lists your profile.","uniqueKey":"settings.jurisdiction","typeLabel":"string"},"name_matching_strictness":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"How strictly beneficiary names must match before a transfer can reach COMPLETED. `CONTAINS` accepts one name whose words all appear in the other.","uniqueKey":"settings.name_matching_strictness","typeLabel":"enum\u003cstring>"},"confirmation_timeout_hours":{"type":"integer","minimum":1,"description":"Hours an AWAITING_COUNTERPARTY transfer may remain unconfirmed before the periodic sweeper expires it. Default 48.","uniqueKey":"settings.confirmation_timeout_hours","typeLabel":"integer"},"timeout_outcome":{"type":"string","enum":["HOLD","REJECT","PROCEED"],"description":"What happens to the underlying transaction when a transfer expires. Default HOLD. sunrise_policy and non_responsive_policy take precedence when they apply and are set.","uniqueKey":"settings.timeout_outcome","typeLabel":"enum\u003cstring>"},"threshold_amount":{"type":"string","description":"Decimal string, in your application's default currency. Minimum transfer amount that triggers a managed exchange; transfers below it resolve straight to NOT_APPLICABLE. Didit compares the transaction amount converted to your default currency, or the `amount_in_default_currency` you send; when no converted amount is available, the threshold does not apply. Defaults to \"0.00\" (EU TFR applies no minimum amount).","uniqueKey":"settings.threshold_amount","typeLabel":"string"},"ownership_validation_mode":{"type":"string","enum":["FULL","SIMPLIFIED","AUTOMATED"],"description":"How much proof a wallet's ownership takes. `FULL` always needs a proof (signed message, test deposit or reviewed screenshot), never the end user's word. `SIMPLIFIED` accepts a self-declaration below `simplified_validation_threshold` and a proof above it. `AUTOMATED` lets the address book and earlier proofs answer on their own, self-declarations included while `allow_self_declaration` is true. Default `AUTOMATED`.","uniqueKey":"settings.ownership_validation_mode","typeLabel":"enum\u003cstring>"},"simplified_validation_threshold":{"type":"string","description":"Decimal string, default \"0.00\". In `SIMPLIFIED` mode a transfer below this amount (in the threshold currency) accepts a self-declaration. A transfer with no amount in that currency counts as above it.","uniqueKey":"settings.simplified_validation_threshold","typeLabel":"string"},"data_sharing_fields":{"type":"object","description":"The fields Didit sends to the counterparty VASP about your own users, per entity type. The `name` and the `wallet_address` are always sent, whatever the list says. An entity type you never chose shares every field. An empty list is a choice too: it shares the name and the wallet only.","properties":{"individual":{"type":"array","items":{"type":"string","enum":["name","wallet_address","address","national_id","customer_identification","date_of_birth","place_of_birth"],"uniqueKey":"settings.data_sharing_fields.individual.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Fields shared about a natural person.","uniqueKey":"settings.data_sharing_fields.individual","typeLabel":"enum\u003cstring>[]"},"company":{"type":"array","items":{"type":"string","enum":["name","wallet_address","address","national_id","customer_identification"],"uniqueKey":"settings.data_sharing_fields.company.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Fields shared about a legal person.","uniqueKey":"settings.data_sharing_fields.company","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"settings.data_sharing_fields","typeLabel":"object"},"matching_rules":{"type":"object","description":"How strictly each field of the counterparty's data is compared with what you hold, per entity type. A field you leave out keeps its default. `NONE` skips the comparison, `STRICT` needs exactly the same words, `CONTAINS` accepts one value whose words all appear in the other, `DEFAULT` is the standard subset match, and `FUZZY` accepts close spellings (and, for dates of birth, a swapped day and month).","properties":{"individual":{"type":"object","description":"Rules for a natural person.","properties":{"name":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"Default: follows `name_matching_strictness`.","uniqueKey":"settings.matching_rules.individual.name","typeLabel":"enum\u003cstring>"},"date_of_birth":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"Default `NONE`.","uniqueKey":"settings.matching_rules.individual.date_of_birth","typeLabel":"enum\u003cstring>"},"address":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"Default `NONE`.","uniqueKey":"settings.matching_rules.individual.address","typeLabel":"enum\u003cstring>"},"account":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"The wallet the exchange was routed by. Default `STRICT`.","uniqueKey":"settings.matching_rules.individual.account","typeLabel":"enum\u003cstring>"}},"uniqueKey":"settings.matching_rules.individual","typeLabel":"object"},"company":{"type":"object","description":"Rules for a legal person.","properties":{"name":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"Default: follows `name_matching_strictness`.","uniqueKey":"settings.matching_rules.company.name","typeLabel":"enum\u003cstring>"},"address":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"Default `NONE`.","uniqueKey":"settings.matching_rules.company.address","typeLabel":"enum\u003cstring>"},"account":{"type":"string","enum":["NONE","STRICT","CONTAINS","DEFAULT","FUZZY"],"description":"The wallet the exchange was routed by. Default `STRICT`.","uniqueKey":"settings.matching_rules.company.account","typeLabel":"enum\u003cstring>"}},"uniqueKey":"settings.matching_rules.company","typeLabel":"object"}},"uniqueKey":"settings.matching_rules","typeLabel":"object"},"legal_name":{"type":"string","description":"Your VASP's legal name. Required (non-blank) to set is_enabled to true.","uniqueKey":"settings.legal_name","typeLabel":"string"},"lei":{"type":"string","description":"Your Legal Entity Identifier, surfaced in the VASP directory.","uniqueKey":"settings.lei","typeLabel":"string"},"compliance_email":{"type":"string","format":"email","description":"Compliance contact email for your VASP profile. The Didit network lists your profile only once this address is confirmed through an emailed link (POST /v3/travel-rule/settings/compliance-email/confirmation/); changing it needs a new confirmation.","uniqueKey":"settings.compliance_email","typeLabel":"string\u003cemail>"},"is_discoverable":{"type":"boolean","description":"Whether your VASP profile can be listed in the Didit network: found in GET /v3/travel-rule/vasps/ by other Didit customers and reached on the INTERNAL rail. Listing also needs a live application, Travel Rule on, a legal name and a confirmed compliance email; didit_network says which are missing. Default true.","uniqueKey":"settings.is_discoverable","typeLabel":"boolean"},"inbound_auto_accept":{"type":"boolean","description":"When true, an inbound TRP inquiry whose beneficiary wallet is a verified address-book entry with a matching name is approved automatically. When false, that inquiry waits in ON_HOLD for you to approve or deny it with the ownership endpoint. INTERNAL-rail and after-deposit transfers are not affected. Default true.","uniqueKey":"settings.inbound_auto_accept","typeLabel":"boolean"},"allow_self_declaration":{"type":"boolean","description":"When true, the wallet-ownership widget offers self-declaration as a fallback proof method. Default true.","uniqueKey":"settings.allow_self_declaration","typeLabel":"boolean"},"allow_screenshot_proof":{"type":"boolean","description":"When true, the wallet-ownership widget offers screenshot upload as an ownership evidence method. Default true.","uniqueKey":"settings.allow_screenshot_proof","typeLabel":"boolean"},"auto_wallet_verification":{"type":"boolean","description":"When true, submitting an outbound Travel Rule transfer that needs end-user proof of wallet control auto-mints a wallet-ownership widget session bound to the transaction and exposes it in the transaction's action_required block. Default true.","uniqueKey":"settings.auto_wallet_verification","typeLabel":"boolean"},"vasp_attribution_enabled":{"type":"boolean","description":"When true, an outbound Travel Rule transfer that no rail can route is attributed through blockchain analytics: the destination wallet is resolved to its owning VASP, the entity is recorded on the transfer and in the VASP directory, and the rails are re-run once with the attributed name. Default true.","uniqueKey":"settings.vasp_attribution_enabled","typeLabel":"boolean"},"counterparty_screening_enabled":{"type":"boolean","description":"Opt-in sanctions and adverse-media screening of counterparty VASPs, billed per screening at the Company AML Screening price. When on, Didit screens the counterparty an outbound exchange reaches (reusing a screening younger than 30 days) and you can screen one with POST /v3/travel-rule/vasps/{vasp_id}/screening/. Default false: nothing is screened or billed.","uniqueKey":"settings.counterparty_screening_enabled","typeLabel":"boolean"},"sunrise_policy":{"type":"string","enum":["","HOLD","REJECT","PROCEED"],"description":"What an expired transfer does to its transaction when the counterparty is a directory entry in a jurisdiction on sunrise_jurisdictions, which does not enforce the Travel Rule yet: HOLD moves it to review, REJECT declines it, PROCEED leaves its status untouched. Empty (the default) follows timeout_outcome. Applies before non_responsive_policy.","uniqueKey":"settings.sunrise_policy","typeLabel":"enum\u003cstring>"},"sunrise_jurisdictions":{"type":"array","items":{"type":"string","uniqueKey":"settings.sunrise_jurisdictions.items.[INDEX]","typeLabel":"string"},"readOnly":true,"description":"Read-only. The countries (ISO 3166 alpha-2) Didit treats as in a Travel Rule sunrise period, where sunrise_policy applies. Currently CO, KH and VN. Any other jurisdiction, and an empty or unknown one, follows timeout_outcome.","uniqueKey":"settings.sunrise_jurisdictions","typeLabel":"string[]"},"non_responsive_policy":{"type":"string","enum":["","HOLD","REJECT","PROCEED"],"description":"What an expired transfer does to its transaction when the counterparty is a directory entry whose responsiveness is UNRESPONSIVE: HOLD, REJECT or PROCEED, as for timeout_outcome. Empty (the default) follows timeout_outcome. sunrise_policy applies first when both fit.","uniqueKey":"settings.non_responsive_policy","typeLabel":"enum\u003cstring>"},"travel_address":{"type":"string","description":"Read-only. Your VASP's own travel address - the encoded inbound TRP inquiry endpoint other VASPs use to reach you. Empty while `is_enabled` is false.","uniqueKey":"settings.travel_address","typeLabel":"string"},"disabled_networks":{"type":"array","items":{"type":"string","enum":["GTR","TRUST","VERIFYVASP","SYGNA"],"uniqueKey":"settings.disabled_networks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Networks opted out of platform membership. Does not disable your connected own memberships or provision unavailable networks.","default":[],"uniqueKey":"settings.disabled_networks","typeLabel":"enum\u003cstring>[]"},"networks":{"type":"object","readOnly":true,"description":"Per network, how this application would send and why it cannot. No network, including GTR, is included by default: a network is reachable through your own connected membership, or through Didit's membership once Didit's membership of that network is live and your own participant on it is active. Not a live health or delivery check.","properties":{"gtr":{"type":"object","description":"How Travel Rule messages on one network would be sent for this application, and why they cannot be. Configuration status, not a live health or delivery check.","properties":{"rail":{"type":"string","enum":["GTR","TRUST","VERIFYVASP","SYGNA"],"uniqueKey":"settings.networks.gtr.rail","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["own","didit","off","unavailable"],"description":"own: the application's connected membership is used; didit: Didit's membership carries the application as its own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable: nothing can send on this network yet (see state and reason).","uniqueKey":"settings.networks.gtr.mode","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["own_membership","live_through_didit","off","didit_onboarding","questionnaire_needed","questionnaire_in_review","request_access","request_sent","unavailable","error"],"description":"own_membership: your connected membership sends; live_through_didit: your own participant on Didit's membership sends; off: you switched platform routing off; didit_onboarding: Didit's own membership of this network is not live yet, so it cannot carry anyone; questionnaire_needed / questionnaire_in_review: the due-diligence questionnaire must be submitted or is with Didit; request_access: the questionnaire is approved, request the network; request_sent: your participant is being onboarded; unavailable: see reason; error: see reason.","uniqueKey":"settings.networks.gtr.state","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["own_membership_connected","platform_network_switched_off","own_membership_only","sandbox_application","didit_membership_not_live","participant_suspended","participant_rejected","questionnaire_not_submitted","questionnaire_submitted","questionnaire_changes_requested","questionnaire_rejected","participant_not_requested","participant_active","participant_key_missing","participant_key_unresolved","provisioning_failed","questionnaire_pending","submitted_to_network"],"description":"Machine-readable detail of state. own_membership_only: Didit does not carry applications on this network (TRUST), connect your own membership; sandbox_application: sandbox transfers never reach a network; provisioning_failed: the network refused the registration, the participant's last_error says why and requesting the network again retries.","uniqueKey":"settings.networks.gtr.reason","typeLabel":"enum\u003cstring>"},"platform_available":{"type":"boolean","description":"Whether Didit's own membership of this network is configured; not a live health check.","uniqueKey":"settings.networks.gtr.platform_available","typeLabel":"boolean"},"connected":{"type":"boolean","description":"Whether a connected customer membership exists. Credentials are validated locally; network validation occurs on a live exchange.","uniqueKey":"settings.networks.gtr.connected","typeLabel":"boolean"},"participant":{"oneOf":[{"type":"object","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership.","uniqueKey":"settings.networks.gtr.participant.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it.","uniqueKey":"settings.networks.gtr.participant.oneOf.0.status","typeLabel":"enum\u003cstring>"},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own.","uniqueKey":"settings.networks.gtr.participant.oneOf.0.participant_code","typeLabel":"string"},"requested_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.gtr.participant.oneOf.0.requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.gtr.participant.oneOf.0.requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.gtr.participant.oneOf.0.requested_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.gtr.participant.oneOf.0.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.gtr.participant.oneOf.0.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.gtr.participant.oneOf.0.activated_at","typeLabel":"string\u003cdate-time> | null"},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise.","uniqueKey":"settings.networks.gtr.participant.oneOf.0.last_error","typeLabel":"string"}},"uniqueKey":"settings.networks.gtr.participant.oneOf.0","typeLabel":"object"},{"type":"null","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership."},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it."},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own."},"requested_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise."}},"uniqueKey":"settings.networks.gtr.participant.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.gtr.participant","typeLabel":"object | null"},"vasps_reachable":{"type":"integer","description":"Directory VASPs reachable on this network.","uniqueKey":"settings.networks.gtr.vasps_reachable","typeLabel":"integer"},"routed_30d":{"type":"integer","description":"This application's transfers carried on this network in the last 30 days.","uniqueKey":"settings.networks.gtr.routed_30d","typeLabel":"integer"}},"uniqueKey":"settings.networks.gtr","typeLabel":"object"},"trust":{"type":"object","description":"How Travel Rule messages on one network would be sent for this application, and why they cannot be. Configuration status, not a live health or delivery check.","properties":{"rail":{"type":"string","enum":["GTR","TRUST","VERIFYVASP","SYGNA"],"uniqueKey":"settings.networks.trust.rail","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["own","didit","off","unavailable"],"description":"own: the application's connected membership is used; didit: Didit's membership carries the application as its own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable: nothing can send on this network yet (see state and reason).","uniqueKey":"settings.networks.trust.mode","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["own_membership","live_through_didit","off","didit_onboarding","questionnaire_needed","questionnaire_in_review","request_access","request_sent","unavailable","error"],"description":"own_membership: your connected membership sends; live_through_didit: your own participant on Didit's membership sends; off: you switched platform routing off; didit_onboarding: Didit's own membership of this network is not live yet, so it cannot carry anyone; questionnaire_needed / questionnaire_in_review: the due-diligence questionnaire must be submitted or is with Didit; request_access: the questionnaire is approved, request the network; request_sent: your participant is being onboarded; unavailable: see reason; error: see reason.","uniqueKey":"settings.networks.trust.state","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["own_membership_connected","platform_network_switched_off","own_membership_only","sandbox_application","didit_membership_not_live","participant_suspended","participant_rejected","questionnaire_not_submitted","questionnaire_submitted","questionnaire_changes_requested","questionnaire_rejected","participant_not_requested","participant_active","participant_key_missing","participant_key_unresolved","provisioning_failed","questionnaire_pending","submitted_to_network"],"description":"Machine-readable detail of state. own_membership_only: Didit does not carry applications on this network (TRUST), connect your own membership; sandbox_application: sandbox transfers never reach a network; provisioning_failed: the network refused the registration, the participant's last_error says why and requesting the network again retries.","uniqueKey":"settings.networks.trust.reason","typeLabel":"enum\u003cstring>"},"platform_available":{"type":"boolean","description":"Whether Didit's own membership of this network is configured; not a live health check.","uniqueKey":"settings.networks.trust.platform_available","typeLabel":"boolean"},"connected":{"type":"boolean","description":"Whether a connected customer membership exists. Credentials are validated locally; network validation occurs on a live exchange.","uniqueKey":"settings.networks.trust.connected","typeLabel":"boolean"},"participant":{"oneOf":[{"type":"object","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership.","uniqueKey":"settings.networks.trust.participant.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it.","uniqueKey":"settings.networks.trust.participant.oneOf.0.status","typeLabel":"enum\u003cstring>"},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own.","uniqueKey":"settings.networks.trust.participant.oneOf.0.participant_code","typeLabel":"string"},"requested_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.trust.participant.oneOf.0.requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.trust.participant.oneOf.0.requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.trust.participant.oneOf.0.requested_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.trust.participant.oneOf.0.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.trust.participant.oneOf.0.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.trust.participant.oneOf.0.activated_at","typeLabel":"string\u003cdate-time> | null"},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise.","uniqueKey":"settings.networks.trust.participant.oneOf.0.last_error","typeLabel":"string"}},"uniqueKey":"settings.networks.trust.participant.oneOf.0","typeLabel":"object"},{"type":"null","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership."},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it."},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own."},"requested_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise."}},"uniqueKey":"settings.networks.trust.participant.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.trust.participant","typeLabel":"object | null"},"vasps_reachable":{"type":"integer","description":"Directory VASPs reachable on this network.","uniqueKey":"settings.networks.trust.vasps_reachable","typeLabel":"integer"},"routed_30d":{"type":"integer","description":"This application's transfers carried on this network in the last 30 days.","uniqueKey":"settings.networks.trust.routed_30d","typeLabel":"integer"}},"uniqueKey":"settings.networks.trust","typeLabel":"object"},"verifyvasp":{"type":"object","description":"How Travel Rule messages on one network would be sent for this application, and why they cannot be. Configuration status, not a live health or delivery check.","properties":{"rail":{"type":"string","enum":["GTR","TRUST","VERIFYVASP","SYGNA"],"uniqueKey":"settings.networks.verifyvasp.rail","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["own","didit","off","unavailable"],"description":"own: the application's connected membership is used; didit: Didit's membership carries the application as its own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable: nothing can send on this network yet (see state and reason).","uniqueKey":"settings.networks.verifyvasp.mode","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["own_membership","live_through_didit","off","didit_onboarding","questionnaire_needed","questionnaire_in_review","request_access","request_sent","unavailable","error"],"description":"own_membership: your connected membership sends; live_through_didit: your own participant on Didit's membership sends; off: you switched platform routing off; didit_onboarding: Didit's own membership of this network is not live yet, so it cannot carry anyone; questionnaire_needed / questionnaire_in_review: the due-diligence questionnaire must be submitted or is with Didit; request_access: the questionnaire is approved, request the network; request_sent: your participant is being onboarded; unavailable: see reason; error: see reason.","uniqueKey":"settings.networks.verifyvasp.state","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["own_membership_connected","platform_network_switched_off","own_membership_only","sandbox_application","didit_membership_not_live","participant_suspended","participant_rejected","questionnaire_not_submitted","questionnaire_submitted","questionnaire_changes_requested","questionnaire_rejected","participant_not_requested","participant_active","participant_key_missing","participant_key_unresolved","provisioning_failed","questionnaire_pending","submitted_to_network"],"description":"Machine-readable detail of state. own_membership_only: Didit does not carry applications on this network (TRUST), connect your own membership; sandbox_application: sandbox transfers never reach a network; provisioning_failed: the network refused the registration, the participant's last_error says why and requesting the network again retries.","uniqueKey":"settings.networks.verifyvasp.reason","typeLabel":"enum\u003cstring>"},"platform_available":{"type":"boolean","description":"Whether Didit's own membership of this network is configured; not a live health check.","uniqueKey":"settings.networks.verifyvasp.platform_available","typeLabel":"boolean"},"connected":{"type":"boolean","description":"Whether a connected customer membership exists. Credentials are validated locally; network validation occurs on a live exchange.","uniqueKey":"settings.networks.verifyvasp.connected","typeLabel":"boolean"},"participant":{"oneOf":[{"type":"object","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership.","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it.","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.status","typeLabel":"enum\u003cstring>"},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own.","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.participant_code","typeLabel":"string"},"requested_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.requested_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.activated_at","typeLabel":"string\u003cdate-time> | null"},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise.","uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0.last_error","typeLabel":"string"}},"uniqueKey":"settings.networks.verifyvasp.participant.oneOf.0","typeLabel":"object"},{"type":"null","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership."},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it."},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own."},"requested_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise."}},"uniqueKey":"settings.networks.verifyvasp.participant.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.verifyvasp.participant","typeLabel":"object | null"},"vasps_reachable":{"type":"integer","description":"Directory VASPs reachable on this network.","uniqueKey":"settings.networks.verifyvasp.vasps_reachable","typeLabel":"integer"},"routed_30d":{"type":"integer","description":"This application's transfers carried on this network in the last 30 days.","uniqueKey":"settings.networks.verifyvasp.routed_30d","typeLabel":"integer"}},"uniqueKey":"settings.networks.verifyvasp","typeLabel":"object"},"sygna":{"type":"object","description":"How Travel Rule messages on one network would be sent for this application, and why they cannot be. Configuration status, not a live health or delivery check.","properties":{"rail":{"type":"string","enum":["GTR","TRUST","VERIFYVASP","SYGNA"],"uniqueKey":"settings.networks.sygna.rail","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["own","didit","off","unavailable"],"description":"own: the application's connected membership is used; didit: Didit's membership carries the application as its own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable: nothing can send on this network yet (see state and reason).","uniqueKey":"settings.networks.sygna.mode","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["own_membership","live_through_didit","off","didit_onboarding","questionnaire_needed","questionnaire_in_review","request_access","request_sent","unavailable","error"],"description":"own_membership: your connected membership sends; live_through_didit: your own participant on Didit's membership sends; off: you switched platform routing off; didit_onboarding: Didit's own membership of this network is not live yet, so it cannot carry anyone; questionnaire_needed / questionnaire_in_review: the due-diligence questionnaire must be submitted or is with Didit; request_access: the questionnaire is approved, request the network; request_sent: your participant is being onboarded; unavailable: see reason; error: see reason.","uniqueKey":"settings.networks.sygna.state","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["own_membership_connected","platform_network_switched_off","own_membership_only","sandbox_application","didit_membership_not_live","participant_suspended","participant_rejected","questionnaire_not_submitted","questionnaire_submitted","questionnaire_changes_requested","questionnaire_rejected","participant_not_requested","participant_active","participant_key_missing","participant_key_unresolved","provisioning_failed","questionnaire_pending","submitted_to_network"],"description":"Machine-readable detail of state. own_membership_only: Didit does not carry applications on this network (TRUST), connect your own membership; sandbox_application: sandbox transfers never reach a network; provisioning_failed: the network refused the registration, the participant's last_error says why and requesting the network again retries.","uniqueKey":"settings.networks.sygna.reason","typeLabel":"enum\u003cstring>"},"platform_available":{"type":"boolean","description":"Whether Didit's own membership of this network is configured; not a live health check.","uniqueKey":"settings.networks.sygna.platform_available","typeLabel":"boolean"},"connected":{"type":"boolean","description":"Whether a connected customer membership exists. Credentials are validated locally; network validation occurs on a live exchange.","uniqueKey":"settings.networks.sygna.connected","typeLabel":"boolean"},"participant":{"oneOf":[{"type":"object","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership.","uniqueKey":"settings.networks.sygna.participant.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it.","uniqueKey":"settings.networks.sygna.participant.oneOf.0.status","typeLabel":"enum\u003cstring>"},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own.","uniqueKey":"settings.networks.sygna.participant.oneOf.0.participant_code","typeLabel":"string"},"requested_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.sygna.participant.oneOf.0.requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.sygna.participant.oneOf.0.requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.sygna.participant.oneOf.0.requested_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"settings.networks.sygna.participant.oneOf.0.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"settings.networks.sygna.participant.oneOf.0.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.sygna.participant.oneOf.0.activated_at","typeLabel":"string\u003cdate-time> | null"},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise.","uniqueKey":"settings.networks.sygna.participant.oneOf.0.last_error","typeLabel":"string"}},"uniqueKey":"settings.networks.sygna.participant.oneOf.0","typeLabel":"object"},{"type":"null","description":"This application's own participant on the network, or null when it has none.","properties":{"mode":{"type":"string","enum":["platform","own"],"description":"platform: carried by Didit's membership; own: onboarded under the application's own membership."},"status":{"type":"string","enum":["not_requested","questionnaire_pending","submitted_to_network","active","suspended","rejected"],"description":"not_requested: never requested, or the network refused the first request (see last_error); questionnaire_pending: waiting for the due-diligence questionnaire to be approved; submitted_to_network: handed to the network's onboarding; active: the network gave this application its own participant code; suspended / rejected: Didit suspended or rejected it."},"participant_code":{"type":"string","description":"The code the network gave this application (for GTR, its VASP code). Outbound messages carry this code, never Didit's own."},"requested_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"last_error":{"type":"string","description":"The network's answer when it refused the registration; empty otherwise."}},"uniqueKey":"settings.networks.sygna.participant.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.networks.sygna.participant","typeLabel":"object | null"},"vasps_reachable":{"type":"integer","description":"Directory VASPs reachable on this network.","uniqueKey":"settings.networks.sygna.vasps_reachable","typeLabel":"integer"},"routed_30d":{"type":"integer","description":"This application's transfers carried on this network in the last 30 days.","uniqueKey":"settings.networks.sygna.routed_30d","typeLabel":"integer"}},"uniqueKey":"settings.networks.sygna","typeLabel":"object"}},"uniqueKey":"settings.networks","typeLabel":"object"},"didit_network":{"type":"object","readOnly":true,"description":"Whether the Didit network lists your VASP profile, so other Didit customers find it in the directory and reach it on the INTERNAL rail, and each condition it still misses.","properties":{"listed":{"type":"boolean","uniqueKey":"settings.didit_network.listed","typeLabel":"boolean"},"missing":{"type":"array","items":{"type":"string","enum":["travel_rule_off","sandbox_application","not_discoverable","legal_name_missing","compliance_email_missing","compliance_email_unconfirmed","excluded_by_staff","internal_organization"],"uniqueKey":"settings.didit_network.missing.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Empty when listed. compliance_email_unconfirmed: send the confirmation with POST /v3/travel-rule/settings/compliance-email/confirmation/ and open the emailed link. excluded_by_staff: Didit marked the application as a test, demo or internal one.","uniqueKey":"settings.didit_network.missing","typeLabel":"enum\u003cstring>[]"},"compliance_email_confirmed":{"type":"boolean","description":"Whether the current compliance_email was confirmed through the emailed link.","uniqueKey":"settings.didit_network.compliance_email_confirmed","typeLabel":"boolean"}},"uniqueKey":"settings.didit_network","typeLabel":"object"}},"uniqueKey":"settings","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"joined_free":true,"work_email":"jsmith@example.com","joined_at":"2023-11-07T05:31:56Z","claim":{"status":"unclaimed","proved_by_domain":true,"claimed_at":"2023-11-07T05:31:56Z","reviewed_at":"2023-11-07T05:31:56Z","review_note":"\u003cstring>","vasp_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","vasp_name":"\u003cstring>"},"prefill":{},"domain":{"domain":"\u003cstring>","status":"unverified","verified_at":"2023-11-07T05:31:56Z","txt":{"host":"didit-tr-verify.example.com","value":"\u003cstring>"}},"billing_enabled":true,"billing_enabled_at":"2023-11-07T05:31:56Z","didit_network":{},"settings":{"is_enabled":true,"jurisdiction":"\u003cstring>","name_matching_strictness":"NONE","confirmation_timeout_hours":2,"timeout_outcome":"HOLD","threshold_amount":"\u003cstring>","ownership_validation_mode":"FULL","simplified_validation_threshold":"\u003cstring>","data_sharing_fields":{"individual":["name"],"company":["name"]},"matching_rules":{"individual":{"name":"NONE","date_of_birth":"NONE","address":"NONE","account":"NONE"},"company":{"name":"NONE","address":"NONE","account":"NONE"}},"legal_name":"\u003cstring>","lei":"\u003cstring>","compliance_email":"jsmith@example.com","is_discoverable":true,"inbound_auto_accept":true,"allow_self_declaration":true,"allow_screenshot_proof":true,"auto_wallet_verification":true,"vasp_attribution_enabled":true,"counterparty_screening_enabled":true,"sunrise_policy":"","sunrise_jurisdictions":["\u003cstring>"],"non_responsive_policy":"","travel_address":"\u003cstring>","disabled_networks":[],"networks":{"gtr":{"rail":"GTR","mode":"own","state":"own_membership","reason":"own_membership_connected","platform_available":true,"connected":true,"participant":{"mode":"platform","status":"not_requested","participant_code":"\u003cstring>","requested_at":"2023-11-07T05:31:56Z","activated_at":"2023-11-07T05:31:56Z","last_error":"\u003cstring>"},"vasps_reachable":123,"routed_30d":123},"trust":{"rail":"GTR","mode":"own","state":"own_membership","reason":"own_membership_connected","platform_available":true,"connected":true,"participant":{"mode":"platform","status":"not_requested","participant_code":"\u003cstring>","requested_at":"2023-11-07T05:31:56Z","activated_at":"2023-11-07T05:31:56Z","last_error":"\u003cstring>"},"vasps_reachable":123,"routed_30d":123},"verifyvasp":{"rail":"GTR","mode":"own","state":"own_membership","reason":"own_membership_connected","platform_available":true,"connected":true,"participant":{"mode":"platform","status":"not_requested","participant_code":"\u003cstring>","requested_at":"2023-11-07T05:31:56Z","activated_at":"2023-11-07T05:31:56Z","last_error":"\u003cstring>"},"vasps_reachable":123,"routed_30d":123},"sygna":{"rail":"GTR","mode":"own","state":"own_membership","reason":"own_membership_connected","platform_available":true,"connected":true,"participant":{"mode":"platform","status":"not_requested","participant_code":"\u003cstring>","requested_at":"2023-11-07T05:31:56Z","activated_at":"2023-11-07T05:31:56Z","last_error":"\u003cstring>"},"vasps_reachable":123,"routed_30d":123}},"didit_network":{"listed":true,"missing":["travel_rule_off"],"compliance_email_confirmed":true}}}}},"exampleType":"generated"}},"exampleType":"generated"},"bf0360a7-3e14-4491-a583-e3b79040e6f7":{"description":"No directory entry has this id.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ffc5c8fb-4918-43ec-9be4-97e4b6f53713":{"description":"This application did not join free, so it has no free workspace.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"87720ed7-fd5b-4bb6-bd5a-11f7d4e182fb":{"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":{"4e6542eb-58fc-460e-bd2a-3d7c451cb2b5":{"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":"Claim a Directory Entry API - Travel Rule Free Join - Didit Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/management-api/travel-rule/claim-workspace","matchLevel":0},"es":{"href":"/es/management-api/travel-rule/claim-workspace","matchLevel":1},"pt-BR":{"href":"/pt-br/management-api/travel-rule/claim-workspace","matchLevel":1},"ja":{"href":"/ja/management-api/travel-rule/claim-workspace","matchLevel":1},"de":{"href":"/de/management-api/travel-rule/claim-workspace","matchLevel":1},"fr":{"href":"/fr/management-api/travel-rule/claim-workspace","matchLevel":1},"it":{"href":"/it/management-api/travel-rule/claim-workspace","matchLevel":1},"pt":{"href":"/pt/management-api/travel-rule/claim-workspace","matchLevel":1},"ca":{"href":"/ca/management-api/travel-rule/claim-workspace","matchLevel":1},"id":{"href":"/id/management-api/travel-rule/claim-workspace","matchLevel":1},"ru":{"href":"/ru/management-api/travel-rule/claim-workspace","matchLevel":1},"ko":{"href":"/ko/management-api/travel-rule/claim-workspace","matchLevel":1},"zh":{"href":"/zh/management-api/travel-rule/claim-workspace","matchLevel":1},"ar":{"href":"/ar/management-api/travel-rule/claim-workspace","matchLevel":1},"hi":{"href":"/hi/management-api/travel-rule/claim-workspace","matchLevel":1}}},"lastModified":"2026-11-06T08:23:30.700Z","gitLastModified":"2026-11-01T10:56:28.000Z","originalFileLocation":"management-api/travel-rule/claim-workspace.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=\"Claim a directory entry: Claims the directory entry this workspace is.\">\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=\"Claim a Directory Entry API - Travel Rule Free Join - Didit Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Claim a directory entry: Claims the directory entry this workspace is.\">\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/claim-workspace\">\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=Claim+a+Directory+Entry+API+-+Travel+Rule+Free+Join\u0026amp;description=Claim+a+directory+entry%3A+Claims+the+directory+entry+this+workspace+is.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=f7c9cf4adf959423c29b02beecbe8f215229a9e129ae1229999bc4ee6d062934\">\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=\"Claim a Directory Entry API - Travel Rule Free Join - Didit Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Claim a directory entry: Claims the directory entry this workspace is.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Travel+Rule\u0026amp;title=Claim+a+Directory+Entry+API+-+Travel+Rule+Free+Join\u0026amp;description=Claim+a+directory+entry%3A+Claims+the+directory+entry+this+workspace+is.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=f7c9cf4adf959423c29b02beecbe8f215229a9e129ae1229999bc4ee6d062934\">\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/claim-workspace\">\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/claim-workspace.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.didit.me/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.didit.me/es/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.didit.me/pt-br/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.didit.me/ja/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.didit.me/de/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.didit.me/fr/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.didit.me/it/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.didit.me/pt/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.didit.me/ca/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"id\" href=\"https://docs.didit.me/id/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.didit.me/ru/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.didit.me/ko/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.didit.me/zh/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://docs.didit.me/ar/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hi\" href=\"https://docs.didit.me/hi/management-api/travel-rule/claim-workspace\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.didit.me/management-api/travel-rule/claim-workspace\">\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/claim-workspace#webpage\",\"url\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace\",\"name\":\"Claim a Directory Entry API - Travel Rule Free Join\",\"description\":\"Claim a directory entry: Claims the directory entry this workspace is.\",\"dateModified\":\"2026-11-01T10:56:28.000Z\",\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace#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\":\"Claim a Directory Entry API - Travel Rule Free Join\",\"item\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace#apireference\",\"headline\":\"Claim a Directory Entry API - Travel Rule Free Join\",\"name\":\"Claim a Directory Entry API - Travel Rule Free Join\",\"description\":\"Claim a directory entry: Claims the directory entry this workspace is.\",\"url\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.didit.me/management-api/travel-rule/claim-workspace#webpage\"},\"dateModified\":\"2026-11-01T10:56:28.000Z\",\"keywords\":\"travel rule free account, counterparty VASP join, claim workspace, 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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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":"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":"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":"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":"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":"Send Travel Rule Message API","sidebarTitle":"Send a Travel Rule Message","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/messages/","href":"/management-api/travel-rule/create-message"},{"title":"Register Inbound Sunrise Transfer API: Travel Rule","sidebarTitle":"Register Inbound (Sunrise) Transfer","openapi":"openapi-25.json POST /v3/travel-rule/inbound/","href":"/management-api/travel-rule/register-inbound"},{"title":"Trigger Test VASP Inbound Transfer API","sidebarTitle":"Trigger Test VASP Inbound Transfer","openapi":"openapi-25.json POST /v3/travel-rule/test-vasp/inbound/","href":"/management-api/travel-rule/trigger-test-vasp-inbound"},{"title":"VASP Directory Search API: Travel Rule Routes","sidebarTitle":"Search the VASP Directory","openapi":"openapi-25.json GET /v3/travel-rule/vasps/","href":"/management-api/travel-rule/search-vasps"},{"title":"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","description":"Read the free Travel Rule workspace of an application that joined free: directory claim, domain proof, billing and its listing on the Didit network.","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","description":"Email a domain verification code: Emails a single-use code to the workspace's work address to prove it controls the email domain.","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":"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":"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":"Bank iD Verification API","sidebarTitle":"Bank iD","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-cz/","href":"/api-reference/digital-id-wallets/bankid-cz"},{"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 - DVS - Birth Certificate Verification API","sidebarTitle":"Australia - DVS - Birth Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/birth-certificate"},{"title":"Australia - DVS - Centrelink Card Verification API","sidebarTitle":"Australia - DVS - Centrelink Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/centrelink-card"},{"title":"Australia - DVS - ImmiCard Verification API","sidebarTitle":"Australia - DVS - ImmiCard","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/immicard"},{"title":"Australia - DVS - Travel Document Verification API","sidebarTitle":"Australia - DVS - Travel Document","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/travel-document"},{"title":"Australia - DVS – Change of Name Certificate API","sidebarTitle":"Australia - DVS – Change of Name Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/change-of-name-certificate"},{"title":"Australia - DVS – Citizenship Certificate API","sidebarTitle":"Australia - DVS – Citizenship Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/citizenship-certificate"},{"title":"Australia - DVS – Marriage Certificate API","sidebarTitle":"Australia - DVS – Marriage Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/marriage-certificate"},{"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"},{"title":"DVS - Australia Driver Licence Verification API","sidebarTitle":"DVS - Australia Driver Licence","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/driver-licence"},{"title":"DVS - Australia Medicare Card Verification API","sidebarTitle":"DVS - Australia Medicare Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/medicare-card"},{"title":"DVS - Australia Passport Verification API: ID Match","sidebarTitle":"DVS - Australia Passport","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/passport"},{"title":"DVS - Australia Visa Verification API: Data Match","sidebarTitle":"DVS - Australia Visa","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/visa"}]},{"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":"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]},{"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/claim-workspace"}]}]},"basePath":"","title":"Claim a Directory Entry API - Travel Rule Free Join - Didit Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}