{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema/docs.json","name":"TXCloud","colors":{"primary":"#0066FF","light":"#4D94FF","dark":"#0052CC"},"logo":{"light":"https://mintcdn.com/walid-19/dOo9bJlHatsV9BB0/logo/light.svg?fit=max\u0026auto=format\u0026n=dOo9bJlHatsV9BB0\u0026q=85\u0026s=39b909666ef52947bd0e2660fab715d9","dark":"https://mintcdn.com/walid-19/dOo9bJlHatsV9BB0/logo/dark.svg?fit=max\u0026auto=format\u0026n=dOo9bJlHatsV9BB0\u0026q=85\u0026s=13c0585d614a34fcdc18e10fb8b9328d"},"favicon":"/favicon.svg","api":{"playground":{}},"background":{},"search":{"prompt":"Search TXCloud docs..."},"seo":{},"integrations":{"intercom":{"appId":"YOUR_INTERCOM_APP_ID"}},"banner":{"content":"New: French documentation now available! [Switch to French](/fr/introduction)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Contact Support","description":"Get help from our team","icon":"headset","href":"mailto:support@txcloud.io"},{"title":"Share on X","description":"Share this page on X","icon":"x-twitter","href":{"base":"https://x.com/intent/tweet","query":[{"key":"text","value":"Check out this TXCloud documentation: $title"},{"key":"url","value":"$url"}]}}]},"metadata":{"timestamp":false},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"fr","href":"fr/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"walid-19","hasAudioNarration":false,"actualSubdomain":"walid-19","customDomains":["docs.txcloud.thetekcircle.io"],"gitSource":{"type":"github","owner":"zawalid","repo":"txcloud-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae94404945b687fc8b7ee55:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":181},{"language":"default","tag":"FraudShield API","count":30},{"language":"default","tag":"Developer Tools API","count":29},{"language":"default","tag":"TransactionGuard API","count":28},{"language":"default","tag":"KYB API","count":26},{"language":"default","tag":"LendingRisk API","count":25},{"language":"en","tag":"Documentation","count":25},{"language":"fr","tag":"Documentation","count":25},{"language":"default","tag":"Identity API","count":20},{"language":"default","tag":"Watchlist API","count":19},{"language":"default","tag":"Rules","count":13},{"language":"default","tag":"Monitoring","count":12},{"language":"en","tag":"Guides","count":6},{"language":"en","tag":"SDKs","count":6},{"language":"fr","tag":"Guides","count":6},{"language":"fr","tag":"SDKs","count":6},{"language":"en","tag":"Resources","count":5},{"language":"fr","tag":"Ressources","count":5},{"language":"en","tag":"Getting Started","count":4},{"language":"en","tag":"Core Concepts","count":4},{"language":"fr","tag":"Demarrage","count":4},{"language":"fr","tag":"Concepts Cles","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":[],"page":{"pagePath":"api-reference/identity/sessions/create-session","slug":"/api-reference/identity/sessions/create-session","pageMetadata":{"title":"Create session","description":"Creates a verification session for multi-step document upload.\n\nSessions expire after 15 minutes of inactivity.\n\n**Flow:**\n1. Create session\n2. Upload document front\n3. Upload document back (if required)\n4. Upload selfie\n5. Complete session\n","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions","href":"/api-reference/identity/sessions/create-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a verification session for multi-step document upload.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Sessions expire after 15 minutes of inactivity.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Flow:\"\n })\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Create session\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Upload document front\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Upload document back (if required)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Upload selfie\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Complete session\"\n }), \"\\n\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create session","description":"Creates a verification session for multi-step document upload.\n\nSessions expire after 15 minutes of inactivity.\n\n**Flow:**\n1. Create session\n2. Upload document front\n3. Upload document back (if required)\n4. Upload selfie\n5. Complete session\n","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions","href":"/api-reference/identity/sessions/create-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createSession","tags":["Sessions"],"summary":"Create session","description":"Creates a verification session for multi-step document upload.\n\nSessions expire after 15 minutes of inactivity.\n\n**Flow:**\n1. Create session\n2. Upload document front\n3. Upload document back (if required)\n4. Upload selfie\n5. Complete session\n","requestBody":"340acd2f-f480-4c9f-91cb-7f0c2f59d55e","responses":{"201":"cb7fbdb6-ff74-4fa8-bc94-2f0787addb21"},"method":"post","type":"path","servers":["fd91b2e3-8535-4309-9927-d85b34823ce5","2dae14cd-ec75-4c17-b7b2-283527d39b11"],"security":["527f7df0-b792-4bd4-bfbe-625570cb7ea6"],"path":"/identity/sessions","baseUrlOptions":["https://api.txcloud.io/v1","https://sandbox.api.txcloud.io/v1"],"title":"Create session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_type","country"],"properties":{"document_type":{"type":"string","isRequired":true,"uniqueKey":"document_type","typeLabel":"string"},"country":{"type":"string","isRequired":true,"uniqueKey":"country","typeLabel":"string"},"checks":{"type":"array","items":{"type":"string","uniqueKey":"checks.items.[INDEX]","typeLabel":"string"},"uniqueKey":"checks","typeLabel":"string[]"},"metadata":{"type":"object","uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"document_type":"\u003cstring>","country":"\u003cstring>","checks":["\u003cstring>"],"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cb7fbdb6-ff74-4fa8-bc94-2f0787addb21":{"description":"Session created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"sess_a1b2c3d4e5f6","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["identity.session"],"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","ready","completed","expired"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"document_type":{"type":"string","uniqueKey":"document_type","typeLabel":"string"},"country":{"type":"string","uniqueKey":"country","typeLabel":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","uniqueKey":"documents.items.[INDEX].side","typeLabel":"string"},"uploaded":{"type":"boolean","uniqueKey":"documents.items.[INDEX].uploaded","typeLabel":"boolean"},"quality_score":{"type":"number","uniqueKey":"documents.items.[INDEX].quality_score","typeLabel":"number"}},"uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"documents","typeLabel":"object[]"},"selfie_uploaded":{"type":"boolean","uniqueKey":"selfie_uploaded","typeLabel":"boolean"},"expires_at":{"type":"string","format":"date-time","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"sess_a1b2c3d4e5f6","object":"identity.session","status":"pending","document_type":"\u003cstring>","country":"\u003cstring>","documents":[{"side":"\u003cstring>","uploaded":true,"quality_score":123}],"selfie_uploaded":true,"expires_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"527f7df0-b792-4bd4-bfbe-625570cb7ea6":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key as Bearer token","scopes":[]}}},"servers":{"fd91b2e3-8535-4309-9927-d85b34823ce5":{"url":"https://api.txcloud.io/v1","description":"Production"},"2dae14cd-ec75-4c17-b7b2-283527d39b11":{"url":"https://sandbox.api.txcloud.io/v1","description":"Sandbox (test environment)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key as Bearer token","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key as Bearer token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/identity.yaml"},"subdomain":"walid-19","siteName":"TXCloud","title":"Create session - TXCloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/identity/sessions/create-session","matchLevel":0},"fr":{"href":"/api-reference/identity/sessions/create-session","matchLevel":0}}},"originalFileLocation":"/api-reference/identity/sessions/create-session.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=\"Creates a verification session for multi-step document upload. Sessions expire after 15 minutes of inactivity. Flow: 1. Create session 2. Upload document front 3. Upload document back (if required) 4. Upload selfie 5. Complete session\">\u003cmeta data-mint-head name=\"application-name\" content=\"TXCloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_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/walid-19/NI5m9xntvcPy-VPT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create session - TXCloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a verification session for multi-step document upload. Sessions expire after 15 minutes of inactivity. Flow: 1. Create session 2. Upload document front 3. Upload document back (if required) 4. Upload selfie 5. Complete session\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TXCloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.txcloud.thetekcircle.io/api-reference/identity/sessions/create-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://walid-19.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+session\u0026amp;description=Creates+a+verification+session+for+multi-step+document+upload.%0A%0ASessions+expire+after+15+minutes+of+inactivity.%0A%0A**Flow%3A**%0A1.+Create+session%0A2.+Upload+document+\u0026amp;theme=8595969f6e4ef54691509431\u0026amp;signature=26fe4e28aa720798bcc926fb7986f8c5fe6610f54e02b607f116ecd7ead2fda8\">\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=\"Create session - TXCloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a verification session for multi-step document upload. Sessions expire after 15 minutes of inactivity. Flow: 1. Create session 2. Upload document front 3. Upload document back (if required) 4. Upload selfie 5. Complete session\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://walid-19.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+session\u0026amp;description=Creates+a+verification+session+for+multi-step+document+upload.%0A%0ASessions+expire+after+15+minutes+of+inactivity.%0A%0A**Flow%3A**%0A1.+Create+session%0A2.+Upload+document+\u0026amp;theme=8595969f6e4ef54691509431\u0026amp;signature=26fe4e28aa720798bcc926fb7986f8c5fe6610f54e02b607f116ecd7ead2fda8\">\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/walid-19/NI5m9xntvcPy-VPT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TXCloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.txcloud.thetekcircle.io/api-reference/identity/sessions/create-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/identity/sessions/create-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TXCloud\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TXCloud","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Overview","sidebarTitle":"Overview","icon":"code","href":"/api-reference/overview"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"API Errors","sidebarTitle":"Errors","href":"/api-reference/errors"},{"title":"Pagination","sidebarTitle":"Pagination","href":"/api-reference/pagination"}]},{"group":"Identity API","icon":"id-card","pages":[{"title":"Identity API","sidebarTitle":"Overview","icon":"id-card","href":"/api-reference/identity/overview"},{"group":"Verification","pages":[{"title":"Create verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verify","href":"/api-reference/identity/verification/create-verification"},{"title":"Extract document data","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/extract","href":"/api-reference/identity/verification/extract-document-data"},{"title":"Compare faces","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/face-match","href":"/api-reference/identity/verification/compare-faces"},{"title":"Check liveness","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/liveness","href":"/api-reference/identity/verification/check-liveness"},{"title":"Pre-validate document","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/validate","href":"/api-reference/identity/verification/pre-validate-document"}]},{"group":"Management","pages":[{"title":"List verifications","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications","href":"/api-reference/identity/management/list-verifications"},{"title":"Get verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications/{id}","href":"/api-reference/identity/management/get-verification"},{"title":"Delete verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml delete /identity/verifications/{id}","href":"/api-reference/identity/management/delete-verification"},{"title":"Retry verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verifications/{id}/retry","href":"/api-reference/identity/management/retry-verification"},{"title":"Cancel verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verifications/{id}/cancel","href":"/api-reference/identity/management/cancel-verification"},{"title":"Get audit trail","description":"Returns the complete audit trail for a verification.\n\nUse for compliance and investigation purposes.\n","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications/{id}/audit","href":"/api-reference/identity/management/get-audit-trail"}]},{"group":"Sessions","pages":[{"title":"Create session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions","href":"/api-reference/identity/sessions/create-session"},{"title":"Get session","description":"Retrieves session status and uploaded documents","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/sessions/{id}","href":"/api-reference/identity/sessions/get-session"},{"title":"Upload document to session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions/{id}/documents","href":"/api-reference/identity/sessions/upload-document-to-session"},{"title":"Complete session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions/{id}/complete","href":"/api-reference/identity/sessions/complete-session"}]},{"group":"Documents","pages":[{"title":"Get document metadata","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/documents/{id}","href":"/api-reference/identity/documents/get-document-metadata"},{"title":"Download document","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/documents/{id}/download","href":"/api-reference/identity/documents/download-document"}]},{"group":"Configuration","pages":[{"title":"List supported documents","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/supported-documents","href":"/api-reference/identity/configuration/list-supported-documents"},{"title":"List supported countries","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/countries","href":"/api-reference/identity/configuration/list-supported-countries"}]}]},{"group":"FraudShield API","icon":"shield-halved","pages":[{"title":"FraudShield API","sidebarTitle":"Overview","icon":"shield-halved","href":"/api-reference/fraud/overview"},{"group":"Duplicates","pages":[{"title":"Search for duplicates","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/duplicates/search","href":"/api-reference/fraud/duplicates/search-for-duplicates"},{"title":"Get duplicate cluster","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/duplicates/{id}","href":"/api-reference/fraud/duplicates/get-duplicate-cluster"},{"title":"Analyze synthetic identity","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/synthetic/analyze","href":"/api-reference/fraud/duplicates/analyze-synthetic-identity"}]},{"group":"Devices","pages":[{"title":"Register device fingerprint","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/devices","href":"/api-reference/fraud/devices/register-device-fingerprint"},{"title":"Get device profile","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}","href":"/api-reference/fraud/devices/get-device-profile"},{"title":"Get device history","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}/history","href":"/api-reference/fraud/devices/get-device-history"},{"title":"Get linked accounts","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}/linked-accounts","href":"/api-reference/fraud/devices/get-linked-accounts"},{"title":"Block device","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/devices/{id}/block","href":"/api-reference/fraud/devices/block-device"},{"title":"Unblock device","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/devices/{id}/block","href":"/api-reference/fraud/devices/unblock-device"}]},{"group":"Velocity","pages":[{"title":"Check velocity limits","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/velocity/check","href":"/api-reference/fraud/velocity/check-velocity-limits"},{"title":"List velocity rules","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/velocity/rules","href":"/api-reference/fraud/velocity/list-velocity-rules"},{"title":"Create velocity rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/velocity/rules","href":"/api-reference/fraud/velocity/create-velocity-rule"}]},{"group":"Blocklist","pages":[{"title":"List blocked entities","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/blocklist","href":"/api-reference/fraud/blocklist/list-blocked-entities"},{"title":"Add to blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/blocklist","href":"/api-reference/fraud/blocklist/add-to-blocklist"},{"title":"Remove from blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/blocklist/{id}","href":"/api-reference/fraud/blocklist/remove-from-blocklist"},{"title":"Check blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/blocklist/check","href":"/api-reference/fraud/blocklist/check-blocklist"}]},{"group":"Rules","pages":[{"title":"List fraud rules","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/rules","href":"/api-reference/fraud/rules/list-fraud-rules"},{"title":"Create fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/rules","href":"/api-reference/fraud/rules/create-fraud-rule"},{"title":"Get fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/rules/{id}","href":"/api-reference/fraud/rules/get-fraud-rule"},{"title":"Update fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml put /fraud/rules/{id}","href":"/api-reference/fraud/rules/update-fraud-rule"},{"title":"Delete fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/rules/{id}","href":"/api-reference/fraud/rules/delete-fraud-rule"},{"title":"Test fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/rules/test","href":"/api-reference/fraud/rules/test-fraud-rule"}]},{"group":"Signals","pages":[{"title":"List fraud signals","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/signals","href":"/api-reference/fraud/signals/list-fraud-signals"},{"title":"Report fraud signal","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals","href":"/api-reference/fraud/signals/report-fraud-signal"},{"title":"Get signal details","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/signals/{id}","href":"/api-reference/fraud/signals/get-signal-details"},{"title":"Confirm signal as fraud","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals/{id}/confirm","href":"/api-reference/fraud/signals/confirm-signal-as-fraud"},{"title":"Dismiss signal","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals/{id}/dismiss","href":"/api-reference/fraud/signals/dismiss-signal"}]},{"group":"Analytics","pages":[{"title":"Get fraud summary","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/analytics/summary","href":"/api-reference/fraud/analytics/get-fraud-summary"},{"title":"Get fraud trends","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/analytics/trends","href":"/api-reference/fraud/analytics/get-fraud-trends"}]}]},{"group":"TransactionGuard API","icon":"credit-card","pages":[{"title":"TransactionGuard API","sidebarTitle":"Overview","icon":"credit-card","href":"/api-reference/transactions/overview"},{"group":"Scoring","pages":[{"title":"Score transaction","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/score","href":"/api-reference/transactions/scoring/score-transaction"},{"title":"Report transaction outcome","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/report","href":"/api-reference/transactions/scoring/report-transaction-outcome"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions","href":"/api-reference/transactions/transactions/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/{id}","href":"/api-reference/transactions/transactions/get-transaction"},{"title":"Get risk signals","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/{id}/signals","href":"/api-reference/transactions/transactions/get-risk-signals"},{"title":"Submit review decision","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/{id}/review","href":"/api-reference/transactions/transactions/submit-review-decision"},{"title":"Flag as fraudulent","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/{id}/flag","href":"/api-reference/transactions/transactions/flag-as-fraudulent"}]},{"group":"Users","pages":[{"title":"Get user risk profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/profile","href":"/api-reference/transactions/users/get-user-risk-profile"},{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/history","href":"/api-reference/transactions/users/get-transaction-history"},{"title":"Get spending patterns","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/patterns","href":"/api-reference/transactions/users/get-spending-patterns"},{"title":"Adjust trust level","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/users/{id}/trust","href":"/api-reference/transactions/users/adjust-trust-level"}]},{"group":"Recipients","pages":[{"title":"Check recipient risk","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/recipients/check","href":"/api-reference/transactions/recipients/check-recipient-risk"},{"title":"Get recipient profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/recipients/{id}","href":"/api-reference/transactions/recipients/get-recipient-profile"},{"title":"Check merchant risk","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/merchants/check","href":"/api-reference/transactions/recipients/check-merchant-risk"},{"title":"Get merchant profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/merchants/{id}","href":"/api-reference/transactions/recipients/get-merchant-profile"},{"title":"Flag merchant","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/merchants/{id}/flag","href":"/api-reference/transactions/recipients/flag-merchant"}]},{"group":"Rules","pages":[{"title":"List rules","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/rules","href":"/api-reference/transactions/rules/list-rules"},{"title":"Create rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/rules","href":"/api-reference/transactions/rules/create-rule"},{"title":"Get rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/rules/{id}","href":"/api-reference/transactions/rules/get-rule"},{"title":"Update rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml put /transactions/rules/{id}","href":"/api-reference/transactions/rules/update-rule"},{"title":"Delete rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml delete /transactions/rules/{id}","href":"/api-reference/transactions/rules/delete-rule"},{"title":"Get limits","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/limits","href":"/api-reference/transactions/rules/get-limits"},{"title":"Update limits","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml put /transactions/limits","href":"/api-reference/transactions/rules/update-limits"}]},{"group":"Analytics","pages":[{"title":"Get summary","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/summary","href":"/api-reference/transactions/analytics/get-summary"},{"title":"Get risk distribution","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/risk-distribution","href":"/api-reference/transactions/analytics/get-risk-distribution"},{"title":"Get fraud rate","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/fraud-rate","href":"/api-reference/transactions/analytics/get-fraud-rate"},{"title":"Get top risks","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/top-risks","href":"/api-reference/transactions/analytics/get-top-risks"}]}]},{"group":"LendingRisk API","icon":"chart-line","pages":[{"title":"LendingRisk API","sidebarTitle":"Overview","icon":"chart-line","href":"/api-reference/lending/overview"},{"group":"Assessment","pages":[{"title":"Full credit assessment","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/assess","href":"/api-reference/lending/assessment/full-credit-assessment"},{"title":"Quick pre-qualification","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/prequalify","href":"/api-reference/lending/assessment/quick-pre-qualification"},{"title":"Get credit score only","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/score","href":"/api-reference/lending/assessment/get-credit-score-only"},{"title":"List assessments","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/assessments","href":"/api-reference/lending/assessment/list-assessments"},{"title":"Get assessment","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/assessments/{id}","href":"/api-reference/lending/assessment/get-assessment"}]},{"group":"Income","pages":[{"title":"Verify income","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/income/verify","href":"/api-reference/lending/income/verify-income"},{"title":"Analyze income stability","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/income/analyze","href":"/api-reference/lending/income/analyze-income-stability"},{"title":"Check affordability","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/affordability/check","href":"/api-reference/lending/income/check-affordability"},{"title":"Calculate DTI","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/dti/calculate","href":"/api-reference/lending/income/calculate-dti"}]},{"group":"Statements","pages":[{"title":"Upload bank statements","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/statements/upload","href":"/api-reference/lending/statements/upload-bank-statements"},{"title":"Analyze statements","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/statements/analyze","href":"/api-reference/lending/statements/analyze-statements"},{"title":"Get statement analysis","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}","href":"/api-reference/lending/statements/get-statement-analysis"},{"title":"Get transactions","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}/transactions","href":"/api-reference/lending/statements/get-transactions"},{"title":"Get insights","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}/insights","href":"/api-reference/lending/statements/get-insights"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/monitor/subscribe","href":"/api-reference/lending/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/lending.yaml delete /lending/monitor/{id}","href":"/api-reference/lending/monitoring/unsubscribe"},{"title":"List monitored borrowers","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/monitor","href":"/api-reference/lending/monitoring/list-monitored-borrowers"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/monitor/{id}/alerts","href":"/api-reference/lending/monitoring/get-alerts"}]},{"group":"Models","pages":[{"title":"List scoring models","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/models","href":"/api-reference/lending/models/list-scoring-models"},{"title":"Get model details","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/models/{id}","href":"/api-reference/lending/models/get-model-details"},{"title":"Score with model","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/models/{id}/score","href":"/api-reference/lending/models/score-with-model"}]},{"group":"Analytics","pages":[{"title":"Portfolio summary","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/summary","href":"/api-reference/lending/analytics/portfolio-summary"},{"title":"Score distribution","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/distribution","href":"/api-reference/lending/analytics/score-distribution"},{"title":"Default analysis","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/defaults","href":"/api-reference/lending/analytics/default-analysis"}]}]},{"group":"KYB API","icon":"building","pages":[{"title":"KYB API","sidebarTitle":"Overview","icon":"building","href":"/api-reference/kyb/overview"},{"group":"Verification","pages":[{"title":"Full business verification","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/verify","href":"/api-reference/kyb/verification/full-business-verification"},{"title":"Search businesses","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/search","href":"/api-reference/kyb/verification/search-businesses"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/verifications","href":"/api-reference/kyb/verification/list-verifications"},{"title":"Get verification","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/verifications/{id}","href":"/api-reference/kyb/verification/get-verification"}]},{"group":"Companies","pages":[{"title":"Get company profile","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}","href":"/api-reference/kyb/companies/get-company-profile"},{"title":"Get ownership structure","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/structure","href":"/api-reference/kyb/companies/get-ownership-structure"},{"title":"Get directors","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/directors","href":"/api-reference/kyb/companies/get-directors"},{"title":"Get beneficial owners","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/ubos","href":"/api-reference/kyb/companies/get-beneficial-owners"},{"title":"Get company documents","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/documents","href":"/api-reference/kyb/companies/get-company-documents"},{"title":"Get financials","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/financials","href":"/api-reference/kyb/companies/get-financials"},{"title":"Get company history","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/history","href":"/api-reference/kyb/companies/get-company-history"}]},{"group":"Documents","pages":[{"title":"Verify business document","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/documents/verify","href":"/api-reference/kyb/documents/verify-business-document"},{"title":"Extract document data","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/documents/extract","href":"/api-reference/kyb/documents/extract-document-data"},{"title":"Get document","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/documents/{id}","href":"/api-reference/kyb/documents/get-document"}]},{"group":"Screening","pages":[{"title":"Screen company \u0026 officers","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/screen","href":"/api-reference/kyb/screening/screen-company-\u0026-officers"},{"title":"Screen individual director","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/screen/directors","href":"/api-reference/kyb/screening/screen-individual-director"},{"title":"Get screening result","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/screen/{id}","href":"/api-reference/kyb/screening/get-screening-result"}]},{"group":"Risk","pages":[{"title":"Assess business risk","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/risk/assess","href":"/api-reference/kyb/risk/assess-business-risk"},{"title":"Get risk assessment","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/risk/{id}","href":"/api-reference/kyb/risk/get-risk-assessment"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/monitor/subscribe","href":"/api-reference/kyb/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml delete /kyb/monitor/{id}","href":"/api-reference/kyb/monitoring/unsubscribe"},{"title":"List monitored companies","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/monitor","href":"/api-reference/kyb/monitoring/list-monitored-companies"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/monitor/{id}/alerts","href":"/api-reference/kyb/monitoring/get-alerts"}]},{"group":"Registries","pages":[{"title":"List registries","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/registries","href":"/api-reference/kyb/registries/list-registries"},{"title":"Get registry for country","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/registries/{country}","href":"/api-reference/kyb/registries/get-registry-for-country"}]}]},{"group":"Watchlist API","icon":"magnifying-glass","pages":[{"title":"Watchlist API","sidebarTitle":"Overview","icon":"magnifying-glass","href":"/api-reference/watchlist/overview"},{"group":"Screening","pages":[{"title":"List screenings","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/screen","href":"/api-reference/watchlist/screening/list-screenings"},{"title":"Screen individual or entity","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/screen","href":"/api-reference/watchlist/screening/screen-individual-or-entity"},{"title":"Batch screening","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/screen/batch","href":"/api-reference/watchlist/screening/batch-screening"},{"title":"Get screening result","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/screen/{id}","href":"/api-reference/watchlist/screening/get-screening-result"}]},{"group":"Matches","pages":[{"title":"Get match details","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/matches/{id}","href":"/api-reference/watchlist/matches/get-match-details"},{"title":"Resolve match","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/matches/{id}/resolve","href":"/api-reference/watchlist/matches/resolve-match"},{"title":"List pending matches","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/matches","href":"/api-reference/watchlist/matches/list-pending-matches"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/monitor/subscribe","href":"/api-reference/watchlist/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml delete /watchlist/monitor/{id}","href":"/api-reference/watchlist/monitoring/unsubscribe"},{"title":"List monitored entities","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/monitor","href":"/api-reference/watchlist/monitoring/list-monitored-entities"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/monitor/{id}/alerts","href":"/api-reference/watchlist/monitoring/get-alerts"}]},{"group":"Lists","pages":[{"title":"List available watchlists","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/lists","href":"/api-reference/watchlist/lists/list-available-watchlists"},{"title":"Get watchlist details","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/lists/{id}","href":"/api-reference/watchlist/lists/get-watchlist-details"},{"title":"Create custom list","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/lists/custom","href":"/api-reference/watchlist/lists/create-custom-list"},{"title":"Add entry to custom list","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/lists/custom/{id}/entries","href":"/api-reference/watchlist/lists/add-entry-to-custom-list"},{"title":"Remove entry","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml delete /watchlist/lists/custom/{id}/entries/{entryId}","href":"/api-reference/watchlist/lists/remove-entry"}]},{"group":"Analytics","pages":[{"title":"Screening summary","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/analytics/summary","href":"/api-reference/watchlist/analytics/screening-summary"},{"title":"Hit rate analysis","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/analytics/hits","href":"/api-reference/watchlist/analytics/hit-rate-analysis"}]}]},{"group":"Developer Tools API","icon":"gear","pages":[{"title":"Developer Tools API","sidebarTitle":"Overview","icon":"gear","href":"/api-reference/devex/overview"},{"group":"Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/keys","href":"/api-reference/devex/keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/keys","href":"/api-reference/devex/keys/create-api-key"},{"title":"Get key details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/keys/{id}","href":"/api-reference/devex/keys/get-key-details"},{"title":"Revoke key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml delete /developers/keys/{id}","href":"/api-reference/devex/keys/revoke-key"},{"title":"Rotate key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/keys/{id}/rotate","href":"/api-reference/devex/keys/rotate-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks","href":"/api-reference/devex/webhooks/list-webhook-endpoints"},{"title":"Create webhook endpoint","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/webhooks","href":"/api-reference/devex/webhooks/create-webhook-endpoint"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/get-webhook-details"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml put /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml delete /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/delete-webhook"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/webhooks/{id}/test","href":"/api-reference/devex/webhooks/test-webhook"},{"title":"Get delivery logs","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks/{id}/logs","href":"/api-reference/devex/webhooks/get-delivery-logs"}]},{"group":"Usage","pages":[{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage","href":"/api-reference/devex/usage/get-usage-summary"},{"title":"Daily breakdown","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage/daily","href":"/api-reference/devex/usage/daily-breakdown"},{"title":"Usage by endpoint","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage/by-endpoint","href":"/api-reference/devex/usage/usage-by-endpoint"},{"title":"Get rate limits","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/limits","href":"/api-reference/devex/usage/get-rate-limits"},{"title":"Current billing period","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/billing/current","href":"/api-reference/devex/usage/current-billing-period"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/billing/invoices","href":"/api-reference/devex/usage/list-invoices"}]},{"group":"Logs","pages":[{"title":"List request logs","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/logs","href":"/api-reference/devex/logs/list-request-logs"},{"title":"Get log details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/logs/{id}","href":"/api-reference/devex/logs/get-log-details"},{"title":"List recent errors","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/errors","href":"/api-reference/devex/logs/list-recent-errors"}]},{"group":"Sandbox","pages":[{"title":"Reset sandbox","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/sandbox/reset","href":"/api-reference/devex/sandbox/reset-sandbox"},{"title":"List test fixtures","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/sandbox/fixtures","href":"/api-reference/devex/sandbox/list-test-fixtures"},{"title":"Simulate scenario","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/sandbox/simulate","href":"/api-reference/devex/sandbox/simulate-scenario"}]},{"group":"Account","pages":[{"title":"Get account info","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/account","href":"/api-reference/devex/account/get-account-info"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"openapi/devex.yaml put /developers/account/settings","href":"/api-reference/devex/account/update-settings"},{"title":"List team members","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/account/team","href":"/api-reference/devex/account/list-team-members"},{"title":"Invite team member","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/account/team","href":"/api-reference/devex/account/invite-team-member"}]}]}]}]},{"language":"fr","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/fr/introduction"}]},{"tab":"Reference API","groups":[{"group":"Apercu","pages":[{"title":"API Overview","sidebarTitle":"Overview","icon":"code","href":"/api-reference/overview"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"API Errors","sidebarTitle":"Errors","href":"/api-reference/errors"},{"title":"Pagination","sidebarTitle":"Pagination","href":"/api-reference/pagination"}]},{"group":"API Identity","icon":"id-card","pages":[{"title":"Identity API","sidebarTitle":"Overview","icon":"id-card","href":"/api-reference/identity/overview"},{"group":"Verification","pages":[{"title":"Create verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verify","href":"/api-reference/identity/verification/create-verification"},{"title":"Extract document data","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/extract","href":"/api-reference/identity/verification/extract-document-data"},{"title":"Compare faces","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/face-match","href":"/api-reference/identity/verification/compare-faces"},{"title":"Check liveness","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/liveness","href":"/api-reference/identity/verification/check-liveness"},{"title":"Pre-validate document","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/validate","href":"/api-reference/identity/verification/pre-validate-document"}]},{"group":"Management","pages":[{"title":"List verifications","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications","href":"/api-reference/identity/management/list-verifications"},{"title":"Get verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications/{id}","href":"/api-reference/identity/management/get-verification"},{"title":"Delete verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml delete /identity/verifications/{id}","href":"/api-reference/identity/management/delete-verification"},{"title":"Retry verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verifications/{id}/retry","href":"/api-reference/identity/management/retry-verification"},{"title":"Cancel verification","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/verifications/{id}/cancel","href":"/api-reference/identity/management/cancel-verification"},{"title":"Get audit trail","description":"Returns the complete audit trail for a verification.\n\nUse for compliance and investigation purposes.\n","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/verifications/{id}/audit","href":"/api-reference/identity/management/get-audit-trail"}]},{"group":"Sessions","pages":[{"title":"Create session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions","href":"/api-reference/identity/sessions/create-session"},{"title":"Get session","description":"Retrieves session status and uploaded documents","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/sessions/{id}","href":"/api-reference/identity/sessions/get-session"},{"title":"Upload document to session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions/{id}/documents","href":"/api-reference/identity/sessions/upload-document-to-session"},{"title":"Complete session","deprecated":null,"version":null,"openapi":"openapi/identity.yaml post /identity/sessions/{id}/complete","href":"/api-reference/identity/sessions/complete-session"}]},{"group":"Documents","pages":[{"title":"Get document metadata","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/documents/{id}","href":"/api-reference/identity/documents/get-document-metadata"},{"title":"Download document","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/documents/{id}/download","href":"/api-reference/identity/documents/download-document"}]},{"group":"Configuration","pages":[{"title":"List supported documents","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/supported-documents","href":"/api-reference/identity/configuration/list-supported-documents"},{"title":"List supported countries","deprecated":null,"version":null,"openapi":"openapi/identity.yaml get /identity/countries","href":"/api-reference/identity/configuration/list-supported-countries"}]}]},{"group":"API FraudShield","icon":"shield-halved","pages":[{"title":"FraudShield API","sidebarTitle":"Overview","icon":"shield-halved","href":"/api-reference/fraud/overview"},{"group":"Duplicates","pages":[{"title":"Search for duplicates","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/duplicates/search","href":"/api-reference/fraud/duplicates/search-for-duplicates"},{"title":"Get duplicate cluster","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/duplicates/{id}","href":"/api-reference/fraud/duplicates/get-duplicate-cluster"},{"title":"Analyze synthetic identity","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/synthetic/analyze","href":"/api-reference/fraud/duplicates/analyze-synthetic-identity"}]},{"group":"Devices","pages":[{"title":"Register device fingerprint","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/devices","href":"/api-reference/fraud/devices/register-device-fingerprint"},{"title":"Get device profile","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}","href":"/api-reference/fraud/devices/get-device-profile"},{"title":"Get device history","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}/history","href":"/api-reference/fraud/devices/get-device-history"},{"title":"Get linked accounts","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/devices/{id}/linked-accounts","href":"/api-reference/fraud/devices/get-linked-accounts"},{"title":"Block device","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/devices/{id}/block","href":"/api-reference/fraud/devices/block-device"},{"title":"Unblock device","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/devices/{id}/block","href":"/api-reference/fraud/devices/unblock-device"}]},{"group":"Velocity","pages":[{"title":"Check velocity limits","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/velocity/check","href":"/api-reference/fraud/velocity/check-velocity-limits"},{"title":"List velocity rules","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/velocity/rules","href":"/api-reference/fraud/velocity/list-velocity-rules"},{"title":"Create velocity rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/velocity/rules","href":"/api-reference/fraud/velocity/create-velocity-rule"}]},{"group":"Blocklist","pages":[{"title":"List blocked entities","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/blocklist","href":"/api-reference/fraud/blocklist/list-blocked-entities"},{"title":"Add to blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/blocklist","href":"/api-reference/fraud/blocklist/add-to-blocklist"},{"title":"Remove from blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/blocklist/{id}","href":"/api-reference/fraud/blocklist/remove-from-blocklist"},{"title":"Check blocklist","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/blocklist/check","href":"/api-reference/fraud/blocklist/check-blocklist"}]},{"group":"Rules","pages":[{"title":"List fraud rules","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/rules","href":"/api-reference/fraud/rules/list-fraud-rules"},{"title":"Create fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/rules","href":"/api-reference/fraud/rules/create-fraud-rule"},{"title":"Get fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/rules/{id}","href":"/api-reference/fraud/rules/get-fraud-rule"},{"title":"Update fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml put /fraud/rules/{id}","href":"/api-reference/fraud/rules/update-fraud-rule"},{"title":"Delete fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml delete /fraud/rules/{id}","href":"/api-reference/fraud/rules/delete-fraud-rule"},{"title":"Test fraud rule","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/rules/test","href":"/api-reference/fraud/rules/test-fraud-rule"}]},{"group":"Signals","pages":[{"title":"List fraud signals","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/signals","href":"/api-reference/fraud/signals/list-fraud-signals"},{"title":"Report fraud signal","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals","href":"/api-reference/fraud/signals/report-fraud-signal"},{"title":"Get signal details","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/signals/{id}","href":"/api-reference/fraud/signals/get-signal-details"},{"title":"Confirm signal as fraud","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals/{id}/confirm","href":"/api-reference/fraud/signals/confirm-signal-as-fraud"},{"title":"Dismiss signal","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml post /fraud/signals/{id}/dismiss","href":"/api-reference/fraud/signals/dismiss-signal"}]},{"group":"Analytics","pages":[{"title":"Get fraud summary","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/analytics/summary","href":"/api-reference/fraud/analytics/get-fraud-summary"},{"title":"Get fraud trends","deprecated":null,"version":null,"openapi":"openapi/fraud.yaml get /fraud/analytics/trends","href":"/api-reference/fraud/analytics/get-fraud-trends"}]}]},{"group":"API TransactionGuard","icon":"credit-card","pages":[{"title":"TransactionGuard API","sidebarTitle":"Overview","icon":"credit-card","href":"/api-reference/transactions/overview"},{"group":"Scoring","pages":[{"title":"Score transaction","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/score","href":"/api-reference/transactions/scoring/score-transaction"},{"title":"Report transaction outcome","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/report","href":"/api-reference/transactions/scoring/report-transaction-outcome"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions","href":"/api-reference/transactions/transactions/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/{id}","href":"/api-reference/transactions/transactions/get-transaction"},{"title":"Get risk signals","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/{id}/signals","href":"/api-reference/transactions/transactions/get-risk-signals"},{"title":"Submit review decision","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/{id}/review","href":"/api-reference/transactions/transactions/submit-review-decision"},{"title":"Flag as fraudulent","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/{id}/flag","href":"/api-reference/transactions/transactions/flag-as-fraudulent"}]},{"group":"Users","pages":[{"title":"Get user risk profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/profile","href":"/api-reference/transactions/users/get-user-risk-profile"},{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/history","href":"/api-reference/transactions/users/get-transaction-history"},{"title":"Get spending patterns","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/users/{id}/patterns","href":"/api-reference/transactions/users/get-spending-patterns"},{"title":"Adjust trust level","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/users/{id}/trust","href":"/api-reference/transactions/users/adjust-trust-level"}]},{"group":"Recipients","pages":[{"title":"Check recipient risk","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/recipients/check","href":"/api-reference/transactions/recipients/check-recipient-risk"},{"title":"Get recipient profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/recipients/{id}","href":"/api-reference/transactions/recipients/get-recipient-profile"},{"title":"Check merchant risk","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/merchants/check","href":"/api-reference/transactions/recipients/check-merchant-risk"},{"title":"Get merchant profile","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/merchants/{id}","href":"/api-reference/transactions/recipients/get-merchant-profile"},{"title":"Flag merchant","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/merchants/{id}/flag","href":"/api-reference/transactions/recipients/flag-merchant"}]},{"group":"Rules","pages":[{"title":"List rules","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/rules","href":"/api-reference/transactions/rules/list-rules"},{"title":"Create rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml post /transactions/rules","href":"/api-reference/transactions/rules/create-rule"},{"title":"Get rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/rules/{id}","href":"/api-reference/transactions/rules/get-rule"},{"title":"Update rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml put /transactions/rules/{id}","href":"/api-reference/transactions/rules/update-rule"},{"title":"Delete rule","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml delete /transactions/rules/{id}","href":"/api-reference/transactions/rules/delete-rule"},{"title":"Get limits","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/limits","href":"/api-reference/transactions/rules/get-limits"},{"title":"Update limits","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml put /transactions/limits","href":"/api-reference/transactions/rules/update-limits"}]},{"group":"Analytics","pages":[{"title":"Get summary","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/summary","href":"/api-reference/transactions/analytics/get-summary"},{"title":"Get risk distribution","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/risk-distribution","href":"/api-reference/transactions/analytics/get-risk-distribution"},{"title":"Get fraud rate","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/fraud-rate","href":"/api-reference/transactions/analytics/get-fraud-rate"},{"title":"Get top risks","deprecated":null,"version":null,"openapi":"openapi/transactions.yaml get /transactions/analytics/top-risks","href":"/api-reference/transactions/analytics/get-top-risks"}]}]},{"group":"API LendingRisk","icon":"chart-line","pages":[{"title":"LendingRisk API","sidebarTitle":"Overview","icon":"chart-line","href":"/api-reference/lending/overview"},{"group":"Assessment","pages":[{"title":"Full credit assessment","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/assess","href":"/api-reference/lending/assessment/full-credit-assessment"},{"title":"Quick pre-qualification","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/prequalify","href":"/api-reference/lending/assessment/quick-pre-qualification"},{"title":"Get credit score only","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/score","href":"/api-reference/lending/assessment/get-credit-score-only"},{"title":"List assessments","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/assessments","href":"/api-reference/lending/assessment/list-assessments"},{"title":"Get assessment","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/assessments/{id}","href":"/api-reference/lending/assessment/get-assessment"}]},{"group":"Income","pages":[{"title":"Verify income","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/income/verify","href":"/api-reference/lending/income/verify-income"},{"title":"Analyze income stability","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/income/analyze","href":"/api-reference/lending/income/analyze-income-stability"},{"title":"Check affordability","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/affordability/check","href":"/api-reference/lending/income/check-affordability"},{"title":"Calculate DTI","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/dti/calculate","href":"/api-reference/lending/income/calculate-dti"}]},{"group":"Statements","pages":[{"title":"Upload bank statements","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/statements/upload","href":"/api-reference/lending/statements/upload-bank-statements"},{"title":"Analyze statements","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/statements/analyze","href":"/api-reference/lending/statements/analyze-statements"},{"title":"Get statement analysis","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}","href":"/api-reference/lending/statements/get-statement-analysis"},{"title":"Get transactions","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}/transactions","href":"/api-reference/lending/statements/get-transactions"},{"title":"Get insights","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/statements/{id}/insights","href":"/api-reference/lending/statements/get-insights"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/monitor/subscribe","href":"/api-reference/lending/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/lending.yaml delete /lending/monitor/{id}","href":"/api-reference/lending/monitoring/unsubscribe"},{"title":"List monitored borrowers","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/monitor","href":"/api-reference/lending/monitoring/list-monitored-borrowers"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/monitor/{id}/alerts","href":"/api-reference/lending/monitoring/get-alerts"}]},{"group":"Models","pages":[{"title":"List scoring models","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/models","href":"/api-reference/lending/models/list-scoring-models"},{"title":"Get model details","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/models/{id}","href":"/api-reference/lending/models/get-model-details"},{"title":"Score with model","deprecated":null,"version":null,"openapi":"openapi/lending.yaml post /lending/models/{id}/score","href":"/api-reference/lending/models/score-with-model"}]},{"group":"Analytics","pages":[{"title":"Portfolio summary","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/summary","href":"/api-reference/lending/analytics/portfolio-summary"},{"title":"Score distribution","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/distribution","href":"/api-reference/lending/analytics/score-distribution"},{"title":"Default analysis","deprecated":null,"version":null,"openapi":"openapi/lending.yaml get /lending/analytics/defaults","href":"/api-reference/lending/analytics/default-analysis"}]}]},{"group":"API KYB","icon":"building","pages":[{"title":"KYB API","sidebarTitle":"Overview","icon":"building","href":"/api-reference/kyb/overview"},{"group":"Verification","pages":[{"title":"Full business verification","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/verify","href":"/api-reference/kyb/verification/full-business-verification"},{"title":"Search businesses","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/search","href":"/api-reference/kyb/verification/search-businesses"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/verifications","href":"/api-reference/kyb/verification/list-verifications"},{"title":"Get verification","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/verifications/{id}","href":"/api-reference/kyb/verification/get-verification"}]},{"group":"Companies","pages":[{"title":"Get company profile","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}","href":"/api-reference/kyb/companies/get-company-profile"},{"title":"Get ownership structure","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/structure","href":"/api-reference/kyb/companies/get-ownership-structure"},{"title":"Get directors","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/directors","href":"/api-reference/kyb/companies/get-directors"},{"title":"Get beneficial owners","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/ubos","href":"/api-reference/kyb/companies/get-beneficial-owners"},{"title":"Get company documents","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/documents","href":"/api-reference/kyb/companies/get-company-documents"},{"title":"Get financials","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/financials","href":"/api-reference/kyb/companies/get-financials"},{"title":"Get company history","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/companies/{id}/history","href":"/api-reference/kyb/companies/get-company-history"}]},{"group":"Documents","pages":[{"title":"Verify business document","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/documents/verify","href":"/api-reference/kyb/documents/verify-business-document"},{"title":"Extract document data","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/documents/extract","href":"/api-reference/kyb/documents/extract-document-data"},{"title":"Get document","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/documents/{id}","href":"/api-reference/kyb/documents/get-document"}]},{"group":"Screening","pages":[{"title":"Screen company \u0026 officers","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/screen","href":"/api-reference/kyb/screening/screen-company-\u0026-officers"},{"title":"Screen individual director","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/screen/directors","href":"/api-reference/kyb/screening/screen-individual-director"},{"title":"Get screening result","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/screen/{id}","href":"/api-reference/kyb/screening/get-screening-result"}]},{"group":"Risk","pages":[{"title":"Assess business risk","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/risk/assess","href":"/api-reference/kyb/risk/assess-business-risk"},{"title":"Get risk assessment","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/risk/{id}","href":"/api-reference/kyb/risk/get-risk-assessment"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml post /kyb/monitor/subscribe","href":"/api-reference/kyb/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml delete /kyb/monitor/{id}","href":"/api-reference/kyb/monitoring/unsubscribe"},{"title":"List monitored companies","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/monitor","href":"/api-reference/kyb/monitoring/list-monitored-companies"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/monitor/{id}/alerts","href":"/api-reference/kyb/monitoring/get-alerts"}]},{"group":"Registries","pages":[{"title":"List registries","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/registries","href":"/api-reference/kyb/registries/list-registries"},{"title":"Get registry for country","deprecated":null,"version":null,"openapi":"openapi/kyb.yaml get /kyb/registries/{country}","href":"/api-reference/kyb/registries/get-registry-for-country"}]}]},{"group":"API Watchlist","icon":"magnifying-glass","pages":[{"title":"Watchlist API","sidebarTitle":"Overview","icon":"magnifying-glass","href":"/api-reference/watchlist/overview"},{"group":"Screening","pages":[{"title":"List screenings","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/screen","href":"/api-reference/watchlist/screening/list-screenings"},{"title":"Screen individual or entity","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/screen","href":"/api-reference/watchlist/screening/screen-individual-or-entity"},{"title":"Batch screening","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/screen/batch","href":"/api-reference/watchlist/screening/batch-screening"},{"title":"Get screening result","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/screen/{id}","href":"/api-reference/watchlist/screening/get-screening-result"}]},{"group":"Matches","pages":[{"title":"Get match details","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/matches/{id}","href":"/api-reference/watchlist/matches/get-match-details"},{"title":"Resolve match","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/matches/{id}/resolve","href":"/api-reference/watchlist/matches/resolve-match"},{"title":"List pending matches","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/matches","href":"/api-reference/watchlist/matches/list-pending-matches"}]},{"group":"Monitoring","pages":[{"title":"Subscribe to monitoring","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/monitor/subscribe","href":"/api-reference/watchlist/monitoring/subscribe-to-monitoring"},{"title":"Unsubscribe","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml delete /watchlist/monitor/{id}","href":"/api-reference/watchlist/monitoring/unsubscribe"},{"title":"List monitored entities","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/monitor","href":"/api-reference/watchlist/monitoring/list-monitored-entities"},{"title":"Get alerts","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/monitor/{id}/alerts","href":"/api-reference/watchlist/monitoring/get-alerts"}]},{"group":"Lists","pages":[{"title":"List available watchlists","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/lists","href":"/api-reference/watchlist/lists/list-available-watchlists"},{"title":"Get watchlist details","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/lists/{id}","href":"/api-reference/watchlist/lists/get-watchlist-details"},{"title":"Create custom list","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/lists/custom","href":"/api-reference/watchlist/lists/create-custom-list"},{"title":"Add entry to custom list","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml post /watchlist/lists/custom/{id}/entries","href":"/api-reference/watchlist/lists/add-entry-to-custom-list"},{"title":"Remove entry","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml delete /watchlist/lists/custom/{id}/entries/{entryId}","href":"/api-reference/watchlist/lists/remove-entry"}]},{"group":"Analytics","pages":[{"title":"Screening summary","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/analytics/summary","href":"/api-reference/watchlist/analytics/screening-summary"},{"title":"Hit rate analysis","deprecated":null,"version":null,"openapi":"openapi/watchlist.yaml get /watchlist/analytics/hits","href":"/api-reference/watchlist/analytics/hit-rate-analysis"}]}]},{"group":"API Outils Developpeur","icon":"gear","pages":[{"title":"Developer Tools API","sidebarTitle":"Overview","icon":"gear","href":"/api-reference/devex/overview"},{"group":"Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/keys","href":"/api-reference/devex/keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/keys","href":"/api-reference/devex/keys/create-api-key"},{"title":"Get key details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/keys/{id}","href":"/api-reference/devex/keys/get-key-details"},{"title":"Revoke key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml delete /developers/keys/{id}","href":"/api-reference/devex/keys/revoke-key"},{"title":"Rotate key","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/keys/{id}/rotate","href":"/api-reference/devex/keys/rotate-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks","href":"/api-reference/devex/webhooks/list-webhook-endpoints"},{"title":"Create webhook endpoint","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/webhooks","href":"/api-reference/devex/webhooks/create-webhook-endpoint"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/get-webhook-details"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml put /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml delete /developers/webhooks/{id}","href":"/api-reference/devex/webhooks/delete-webhook"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/webhooks/{id}/test","href":"/api-reference/devex/webhooks/test-webhook"},{"title":"Get delivery logs","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/webhooks/{id}/logs","href":"/api-reference/devex/webhooks/get-delivery-logs"}]},{"group":"Usage","pages":[{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage","href":"/api-reference/devex/usage/get-usage-summary"},{"title":"Daily breakdown","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage/daily","href":"/api-reference/devex/usage/daily-breakdown"},{"title":"Usage by endpoint","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/usage/by-endpoint","href":"/api-reference/devex/usage/usage-by-endpoint"},{"title":"Get rate limits","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/limits","href":"/api-reference/devex/usage/get-rate-limits"},{"title":"Current billing period","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/billing/current","href":"/api-reference/devex/usage/current-billing-period"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/billing/invoices","href":"/api-reference/devex/usage/list-invoices"}]},{"group":"Logs","pages":[{"title":"List request logs","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/logs","href":"/api-reference/devex/logs/list-request-logs"},{"title":"Get log details","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/logs/{id}","href":"/api-reference/devex/logs/get-log-details"},{"title":"List recent errors","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/errors","href":"/api-reference/devex/logs/list-recent-errors"}]},{"group":"Sandbox","pages":[{"title":"Reset sandbox","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/sandbox/reset","href":"/api-reference/devex/sandbox/reset-sandbox"},{"title":"List test fixtures","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/sandbox/fixtures","href":"/api-reference/devex/sandbox/list-test-fixtures"},{"title":"Simulate scenario","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/sandbox/simulate","href":"/api-reference/devex/sandbox/simulate-scenario"}]},{"group":"Account","pages":[{"title":"Get account info","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/account","href":"/api-reference/devex/account/get-account-info"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"openapi/devex.yaml put /developers/account/settings","href":"/api-reference/devex/account/update-settings"},{"title":"List team members","deprecated":null,"version":null,"openapi":"openapi/devex.yaml get /developers/account/team","href":"/api-reference/devex/account/list-team-members"},{"title":"Invite team member","deprecated":null,"version":null,"openapi":"openapi/devex.yaml post /developers/account/team","href":"/api-reference/devex/account/invite-team-member"}]}]}]}]}]},"basePath":"","title":"Create session - TXCloud","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BcDCEkh6.js","dist-CwjSCXIK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-eKJ4rcii.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","AssistantPageLink-9EK5IAXV.js"]}