User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with * (for example *****3333). When only the last 4 digits are on file, the value is fully masked (****).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Truv","colors":{"primary":"#2C64E3","light":"#5A8AEF","dark":"#1E4BB8"},"logo":{"light":"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/dark.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=4a88c1e43db8b515ffb08e5f87aafa65","dark":"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/white.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=d611c5c17a34572abc853ebf93a96759","href":"/"},"favicon":"https://mintcdn.com/truv/z9uMK6PrkzslSpM_/favicon.ico?fit=max\u0026auto=format\u0026n=z9uMK6PrkzslSpM_\u0026q=85\u0026s=61f2e85e389d4ed41a43c6db75e7b406","api":{"openapi":"openapi.yaml","mdx":{"server":"https://prod.truv.com"}},"background":{"color":{"light":"#FFFFFF","dark":"#0F1117"}},"navbar":{"links":[{"href":"https://dashboard.truv.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Keys","href":"https://dashboard.truv.com"}},"footer":{"socials":{"twitter":"https://twitter.com/truv","linkedin":"https://www.linkedin.com/company/truv","github":"https://github.com/truvhq"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"truv","hasAudioNarration":false,"actualSubdomain":"truv","customDomains":["docs.truv.com"],"gitSource":{"type":"github","owner":"truvhq","repo":"mint-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aedd43714aa97ea2243a7a7","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Get Started","count":78},{"language":"default","tag":"Platform","count":71},{"language":"default","tag":"Mortgage","count":42},{"language":"default","tag":"Income \u0026 Employment","count":25},{"language":"default","tag":"Consumer Credit","count":25},{"language":"default","tag":"Implementation","count":23},{"language":"default","tag":"Financial Accounts","count":22},{"language":"default","tag":"Document Processing","count":19},{"language":"default","tag":"Public Sector","count":18}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@truv.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"coverage-search.css","content":".cw-widget{margin:0.5rem 0 1.5rem}.cw-widget *{margin:0;padding:0;box-sizing:border-box}.cw-sb{position:relative;margin-bottom:0.75rem}.cw-si{position:absolute;left:1rem;top:50%;transform:translateY(-50%);width:1.125rem;height:1.125rem;color:#9ca3af;pointer-events:none}.cw-input{width:100%;padding:0.875rem 2.5rem 0.875rem 2.75rem;font-size:1rem;font-family:inherit;border:1.5px solid #e5e7eb;border-radius:12px;background:#fff;color:#111827;outline:none;box-sizing:border-box;transition:border-color 0.15s, box-shadow 0.15s}.cw-input:focus{border-color:#818cf8;box-shadow:0 0 0 4px rgba(129, 140, 248, 0.15)}.cw-input::placeholder{color:#9ca3af}.cw-clear{position:absolute;right:0.75rem;top:50%;transform:translateY(-50%);display:flex;align-items:center;justify-content:center;background:none;border:none;cursor:pointer;padding:0;color:#9ca3af}.cw-ci{width:1.25rem;height:1.25rem}.cw-tabs{display:flex;flex-wrap:wrap;gap:0.5rem;margin-bottom:1rem}.cw-tab{padding:0.5rem 1rem;font-size:0.875rem;font-family:inherit;font-weight:500;border:1.5px solid #e5e7eb;border-radius:999px;background:#fff;color:#374151;cursor:pointer;transition:all 0.15s}.cw-tab:hover{border-color:#c7d2fe}.cw-tab-active{background:#eef2ff;border-color:#c7d2fe;color:#4338ca}.cw-ch{display:flex;justify-content:space-between;padding:0.5rem 0;font-size:0.8rem;color:#9ca3af;border-bottom:1px solid #f3f4f6}.cw-list{transition:opacity 0.15s}.cw-row{display:flex;align-items:center;justify-content:space-between;padding:0.5rem 0;margin:0!important;border-bottom:1px solid #f3f4f6}.cw-row-l{display:flex;align-items:center;gap:0.75rem;flex:1;min-width:0}.cw-logo{width:36px;height:36px;border-radius:8px;object-fit:contain;flex-shrink:0;background:#f9fafb}.cw-logo-empty{background:#f3f4f6}.cw-name{font-size:0.95rem;font-weight:500;color:#111827;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.cw-rate{display:flex;align-items:center;justify-content:center;width:28px;height:28px;border-radius:50%;flex-shrink:0}.cw-rate-high{background:#dcfce7}.cw-rate-unk{background:#f3f4f6;color:#9ca3af;font-size:0.85rem;font-weight:600}.cw-empty{text-align:center;padding:1.5rem 0!important;color:#6b7280;font-size:0.9rem}.cw-foot{text-align:center;margin-top:0.75rem}.cw-btn{padding:0.625rem 1.5rem;font-size:0.875rem;font-weight:500;font-family:inherit;border:1.5px solid #e5e7eb;border-radius:8px;background:#fff;color:#374151;cursor:pointer;transition:background 0.15s, border-color 0.15s}.cw-btn:hover{background:#f9fafb;border-color:#d1d5db}.dark .cw-input{background:#18181b;border-color:#3f3f46;color:#f4f4f5}.dark .cw-input:focus{border-color:#818cf8;box-shadow:0 0 0 4px rgba(129, 140, 248, 0.1)}.dark .cw-input::placeholder{color:#71717a}.dark .cw-clear{color:#71717a}.dark .cw-tab{background:#18181b;border-color:#3f3f46;color:#d4d4d8}.dark .cw-tab:hover{border-color:#6366f1}.dark .cw-tab-active{background:#1e1b4b;border-color:#6366f1;color:#a5b4fc}.dark .cw-ch{color:#71717a;border-color:#27272a}.dark .cw-row{border-color:#27272a}.dark .cw-logo{background:#27272a}.dark .cw-logo-empty{background:#3f3f46}.dark .cw-name{color:#f4f4f5}.dark .cw-rate-high{background:#052e16}.dark .cw-rate-high svg{fill:#4ade80}.dark .cw-rate-unk{background:#27272a;color:#71717a}.dark .cw-empty{color:#a1a1aa}.dark .cw-btn{background:#18181b;border-color:#3f3f46;color:#d4d4d8}.dark .cw-btn:hover{background:#27272a;border-color:#52525b}"},{"filePath":"custom.css","content":"div.eyebrow{display:none!important}img.nav-logo{height:44px!important}.truv-topbar-group{display:inline-flex;align-items:center;gap:4px}.truv-resources-dropdown{position:relative;display:inline-flex;align-items:center}.truv-resources-btn{display:inline-flex;align-items:center;gap:2px;padding:6px 12px;background:transparent;border:none;color:inherit;font-size:14px;font-weight:500;cursor:pointer;font-family:inherit;white-space:nowrap}.truv-resources-btn:hover{opacity:0.7}.truv-resources-menu{display:none;position:absolute;top:100%;right:0;margin-top:4px;min-width:160px;background:white;border:1px solid #e5e7eb;border-radius:8px;box-shadow:0 4px 12px rgba(0, 0, 0, 0.1);padding:4px;z-index:1000}.truv-resources-menu.open{display:block}.truv-resources-menu a{display:block;padding:8px 12px;color:#374151;text-decoration:none;font-size:14px;border-radius:6px;white-space:nowrap}.truv-resources-menu a:hover{background:#f3f4f6;color:#111827}.dark .truv-resources-menu,html[class*=\"dark\"] .truv-resources-menu{background:#1f2937;border-color:#374151}.dark .truv-resources-menu a,html[class*=\"dark\"] .truv-resources-menu a{color:#d1d5db}.dark .truv-resources-menu a:hover,html[class*=\"dark\"] .truv-resources-menu a:hover{background:#374151;color:#f9fafb}#content-area table th,#content-area table td{min-width:0}#content-area table code{white-space:nowrap}.coverage-table th,.coverage-table td{padding:10px 12px;text-align:left;vertical-align:middle}.coverage-table th:first-child,.coverage-table td:first-child{width:56px;text-align:center}.coverage-table th:nth-child(2),.coverage-table td:nth-child(2){width:110px}.coverage-table td:first-child img{display:block;margin:0 auto}:root{--mmd-line: #9CA3AF;--mmd-lifeline: #2C64E3;--mmd-node-fill: #EBF0FD;--mmd-node-border: #2C64E3;--mmd-node-text: #111827;--mmd-actor-fill: #2C64E3;--mmd-actor-border: #1E4BB8;--mmd-actor-text: #FFFFFF;--mmd-note-fill: #EBF0FD;--mmd-note-border: #5A8AEF;--mmd-note-text: #111827;--mmd-label-text: #111827;--mmd-label-bg: rgb(var(--background-light, 255 255 255))}.dark{--mmd-line: #9CA3AF;--mmd-lifeline: #5A8AEF;--mmd-node-fill: #16233B;--mmd-node-border: #5A8AEF;--mmd-node-text: #E5E7EB;--mmd-actor-fill: #2C64E3;--mmd-actor-border: #5A8AEF;--mmd-actor-text: #FFFFFF;--mmd-note-fill: #1E3A8A;--mmd-note-border: #5A8AEF;--mmd-note-text: #E5E7EB;--mmd-label-text: #E5E7EB;--mmd-label-bg: rgb(var(--background-dark, 15 17 23))}svg[id^=\"mermaid-\"] .messageLine0,svg[id^=\"mermaid-\"] .messageLine1,svg[id^=\"mermaid-\"] .loopLine,svg[id^=\"mermaid-\"] .flowchart-link,svg[id^=\"mermaid-\"] .edgePath .path{stroke:var(--mmd-line)!important}svg[id^=\"mermaid-\"] .actor-line{stroke:var(--mmd-lifeline)!important}svg[id^=\"mermaid-\"] marker path{fill:var(--mmd-line)!important;stroke:var(--mmd-line)!important}svg[id^=\"mermaid-\"] .node:not(.active):not(.error) rect,svg[id^=\"mermaid-\"] .node:not(.active):not(.error) circle,svg[id^=\"mermaid-\"] .node:not(.active):not(.error) polygon,svg[id^=\"mermaid-\"] .node:not(.active):not(.error) path{fill:var(--mmd-node-fill)!important;stroke:var(--mmd-node-border)!important}svg[id^=\"mermaid-\"] .node:not(.active):not(.error) .nodeLabel{fill:var(--mmd-node-text)!important;color:var(--mmd-node-text)!important}svg[id^=\"mermaid-\"] rect.actor{fill:var(--mmd-actor-fill)!important;stroke:var(--mmd-actor-border)!important}svg[id^=\"mermaid-\"] text.actor,svg[id^=\"mermaid-\"] text.actor tspan{fill:var(--mmd-actor-text)!important}svg[id^=\"mermaid-\"] .note{fill:var(--mmd-note-fill)!important;stroke:var(--mmd-note-border)!important}svg[id^=\"mermaid-\"] .noteText,svg[id^=\"mermaid-\"] .noteText tspan{fill:var(--mmd-note-text)!important}svg[id^=\"mermaid-\"] .messageText,svg[id^=\"mermaid-\"] .loopText,svg[id^=\"mermaid-\"] .loopText tspan,svg[id^=\"mermaid-\"] .labelText,svg[id^=\"mermaid-\"] .labelText tspan,svg[id^=\"mermaid-\"] .edgeLabel,svg[id^=\"mermaid-\"] .edgeLabel p{fill:var(--mmd-label-text)!important;color:var(--mmd-label-text)!important}svg[id^=\"mermaid-\"] .edgeLabel,svg[id^=\"mermaid-\"] .edgeLabel p,svg[id^=\"mermaid-\"] .edgeLabel span,svg[id^=\"mermaid-\"] .edgeLabel div,svg[id^=\"mermaid-\"] .edgeLabel foreignObject>div,svg[id^=\"mermaid-\"] .labelBkg,svg[id^=\"mermaid-\"] .edgeLabel rect,svg[id^=\"mermaid-\"] .labelBox{background-color:var(--mmd-label-bg)!important;fill:var(--mmd-label-bg)!important}svg[id^=\"mermaid-\"] .messageText,svg[id^=\"mermaid-\"] .loopText,svg[id^=\"mermaid-\"] .labelText{paint-order:stroke fill;stroke:var(--mmd-label-bg)!important;stroke-width:3px!important;stroke-linejoin:round}"}],"page":{"pagePath":"api-reference/users/users_read","slug":"/api-reference/users/users_read","pageMetadata":{"title":"Retrieve a user","openapi":"GET /v1/users/{user_id}/","description":"This endpoint retrieves a user.","href":"/api-reference/users/users_read"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint retrieves a user.\"\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":"Retrieve a user","openapi":"GET /v1/users/{user_id}/","description":"This endpoint retrieves a user.","href":"/api-reference/users/users_read"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/truv/9a81556fef08db13/coverage-search.js","/_mintlify/custom/truv/c15dff2b800bd197/dev-footer.js"],"openApiReferenceData":{"operation":{"operationId":"v1_users_read","summary":"Retrieve a user","description":"This endpoint retrieves a user.","parameters":["27c8a956-fe7a-4182-b22b-e0d60ea9d7d5","56c535e7-7688-479a-b629-45d2f90e0a85"],"responses":{"200":"6cbf4f01-826e-47c3-ab4a-f29ac0eb1d8f","401":"f4dd05dd-352c-402c-a18f-a406750963ca","403":"b3c059c4-21fb-4e84-bcee-03b18e268f8c","404":"107ba777-e77c-4242-9f0d-07a07f8f7dd0"},"tags":["Users"],"method":"get","type":"path","servers":["833b4f73-c154-490d-aa6d-bec739989c24"],"security":["35daf88f-977c-46f9-9de3-fafbcd723553"],"path":"/v1/users/{user_id}/","baseUrlOptions":["https://prod.truv.com"],"title":"Retrieve a user","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"27c8a956-fe7a-4182-b22b-e0d60ea9d7d5":{"name":"list_links","in":"query","description":"When set to true, adds the payload from the account links endpoint.","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"When set to true, adds the payload from the account links endpoint.","uniqueKey":"","typeLabel":"boolean"}},"56c535e7-7688-479a-b629-45d2f90e0a85":{"name":"show_fraud_reasons","in":"query","description":"Set to true to include `fraud_reasons` for each link returned in the response. Requires `list_links=true`.","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Set to true to include `fraud_reasons` for each link returned in the response. Requires `list_links=true`.","uniqueKey":"","typeLabel":"boolean"}},"69b6fb2f-6821-44d1-832e-b4f7be169327":{"name":"user_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"24d7e80942ce4ad58a93f70ce4115f5c"}},"responses":{"6cbf4f01-826e-47c3-ab4a-f29ac0eb1d8f":{"description":"","content":{"application/json":{"schema":{"required":["id","external_user_id","created_at","updated_at"],"type":"object","properties":{"id":{"description":"Unique identifier of the user.","type":"string","readOnly":true,"maxLength":32,"example":"24d7e80942ce4ad58a93f70ce4115f5c","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"external_user_id":{"oneOf":[{"description":"External user id.","type":"string","example":"12345","maxLength":512,"isRequired":true,"uniqueKey":"external_user_id.oneOf.0","typeLabel":"string"},{"description":"External user id.","type":"null","example":"12345","maxLength":512,"isRequired":true,"uniqueKey":"external_user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_user_id","typeLabel":"string | null"},"created_at":{"description":"Timestamp when the user was created.","type":"string","format":"date-time","readOnly":true,"example":"2022-05-04T11:30:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Timestamp when the user was updated last time.","type":"string","format":"date-time","readOnly":true,"example":"2022-05-04T12:00:00Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"first_name":{"oneOf":[{"description":"First name of the user.","type":"string","example":"John","maxLength":128,"uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"description":"First name of the user.","type":"null","example":"John","maxLength":128,"uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of the user.","type":"string","example":"Doe","maxLength":128,"uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of the user.","type":"null","example":"Doe","maxLength":128,"uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"email":{"oneOf":[{"description":"User's email.","type":"string","format":"email","example":"john.doe@example.com","maxLength":254,"uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"User's email.","type":"null","format":"email","example":"john.doe@example.com","maxLength":254,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"phone":{"oneOf":[{"description":"User's phone number in E.164 format (`+` followed by the country code and number).","type":"string","example":"+14155554193","maxLength":16,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"description":"User's phone number in E.164 format (`+` followed by the country code and number).","type":"null","example":"+14155554193","maxLength":16,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"ssn":{"oneOf":[{"description":"User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with `*` (for example `*****3333`). When only the last 4 digits are on file, the value is fully masked (`****`).","type":"string","example":"*****3333","uniqueKey":"ssn.oneOf.0","typeLabel":"string"},{"description":"User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with `*` (for example `*****3333`). When only the last 4 digits are on file, the value is fully masked (`****`).","type":"null","example":"*****3333","uniqueKey":"ssn.oneOf.1","typeLabel":"null"}],"uniqueKey":"ssn","typeLabel":"string | null"},"links":{"oneOf":[{"description":"List of account Links associated with the user.","type":"array","items":{"type":"object","properties":{"id":{"description":"Link ID","type":"string","example":"48427a36d43c4d5aa6324bc06c692456","maxLength":32,"uniqueKey":"links.oneOf.0.items.[INDEX].id","typeLabel":"string"},"access_token":{"description":"Access token for data refresh. Returns masked value (e.g., `****************************7610`) unless filtered by `user_id`, in which case the full token is returned.","type":"string","readOnly":true,"example":"****************************7610","maxLength":64,"uniqueKey":"links.oneOf.0.items.[INDEX].access_token","typeLabel":"string"},"created_at":{"description":"Link creation timestamp (ISO 8601)","type":"string","example":"2022-06-07T15:00:00Z","uniqueKey":"links.oneOf.0.items.[INDEX].created_at","typeLabel":"string"},"updated_at":{"description":"Link last update timestamp (ISO 8601)","type":"string","example":"2022-06-30T15:00:00Z","uniqueKey":"links.oneOf.0.items.[INDEX].updated_at","typeLabel":"string"},"deleted_at":{"oneOf":[{"description":"Link removal timestamp (ISO 8601)","type":"string","example":"2022-06-30T15:00:00Z","uniqueKey":"links.oneOf.0.items.[INDEX].deleted_at.oneOf.0","typeLabel":"string"},{"description":"Link removal timestamp (ISO 8601)","type":"null","example":"2022-06-30T15:00:00Z","uniqueKey":"links.oneOf.0.items.[INDEX].deleted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].deleted_at","typeLabel":"string | null"},"tracking_info":{"oneOf":[{"description":"Optional tracking information provided by a partner","type":"string","example":"user123456","maxLength":255,"uniqueKey":"links.oneOf.0.items.[INDEX].tracking_info.oneOf.0","typeLabel":"string"},{"description":"Optional tracking information provided by a partner","type":"null","example":"user123456","maxLength":255,"uniqueKey":"links.oneOf.0.items.[INDEX].tracking_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].tracking_info","typeLabel":"string | null"},"status":{"description":"Status of the last Task","type":"string","example":"new","uniqueKey":"links.oneOf.0.items.[INDEX].status","typeLabel":"string"},"user_external_id":{"oneOf":[{"description":"User external ID is information provided by a partner","type":"string","example":"user123456","uniqueKey":"links.oneOf.0.items.[INDEX].user_external_id.oneOf.0","typeLabel":"string"},{"description":"User external ID is information provided by a partner","type":"null","example":"user123456","uniqueKey":"links.oneOf.0.items.[INDEX].user_external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].user_external_id","typeLabel":"string | null"},"provider_id":{"description":"Data provider ID","type":"string","example":"adp","uniqueKey":"links.oneOf.0.items.[INDEX].provider_id","typeLabel":"string"},"provider":{"oneOf":[{"type":"object","properties":{"id":{"description":"Data provider ID.","type":"string","readOnly":true,"example":"adp","maxLength":64,"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0.id","typeLabel":"string"},"name":{"description":"Data provider name.","type":"string","readOnly":true,"example":"ADP","maxLength":128,"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0.name","typeLabel":"string"},"logo_url":{"oneOf":[{"description":"Data provider logo image.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"description":"Data provider logo image.","type":"null","uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0.logo_url","typeLabel":"string | null"}},"required":["id","name"],"uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"description":"Data provider ID.","type":"string","readOnly":true,"example":"adp","maxLength":64},"name":{"description":"Data provider name.","type":"string","readOnly":true,"example":"ADP","maxLength":128},"logo_url":{"oneOf":[{"description":"Data provider logo image.","type":"string"},{"description":"Data provider logo image.","type":"null"}]}},"required":["id","name"],"uniqueKey":"links.oneOf.0.items.[INDEX].provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].provider","typeLabel":"object | null"},"company_mapping":{"oneOf":[{"type":"object","properties":{"id":{"oneOf":[{"description":"Employer ID.","type":"string","readOnly":true,"example":"meta","maxLength":64,"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.id.oneOf.0","typeLabel":"string"},{"description":"Employer ID.","type":"null","readOnly":true,"example":"meta","maxLength":64,"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.id","typeLabel":"string | null"},"name":{"description":"Employer name.","type":"string","readOnly":true,"example":"Meta","maxLength":255,"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.name","typeLabel":"string"},"logo_url":{"oneOf":[{"description":"Employer logo image.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"description":"Employer logo image.","type":"null","uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0.logo_url","typeLabel":"string | null"}},"required":["id","name"],"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"oneOf":[{"description":"Employer ID.","type":"string","readOnly":true,"example":"meta","maxLength":64},{"description":"Employer ID.","type":"null","readOnly":true,"example":"meta","maxLength":64}]},"name":{"description":"Employer name.","type":"string","readOnly":true,"example":"Meta","maxLength":255},"logo_url":{"oneOf":[{"description":"Employer logo image.","type":"string"},{"description":"Employer logo image.","type":"null"}]}},"required":["id","name"],"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].company_mapping","typeLabel":"object | null"},"link_hash":{"oneOf":[{"description":"Unique hash for the user credentials used to create the link","type":"string","example":"bc917458a3da4b2c8cc8282aa1707aaa","uniqueKey":"links.oneOf.0.items.[INDEX].link_hash.oneOf.0","typeLabel":"string"},{"description":"Unique hash for the user credentials used to create the link","type":"null","example":"bc917458a3da4b2c8cc8282aa1707aaa","uniqueKey":"links.oneOf.0.items.[INDEX].link_hash.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].link_hash","typeLabel":"string | null"},"allowed_products":{"description":"List of all allowed products for this connection","type":"array","example":["income"],"items":{"type":"string","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education"],"uniqueKey":"links.oneOf.0.items.[INDEX].allowed_products.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"links.oneOf.0.items.[INDEX].allowed_products","typeLabel":"enum\u003cstring>[]"},"initial_product_type":{"oneOf":[{"description":"Initial product type","type":"string","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education",null],"example":"income","uniqueKey":"links.oneOf.0.items.[INDEX].initial_product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Initial product type","type":"null","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education",null],"example":"income","uniqueKey":"links.oneOf.0.items.[INDEX].initial_product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].initial_product_type","typeLabel":"enum\u003cstring> | null"},"data_source":{"description":"Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.","type":"string","enum":["payroll","docs","insurance","financial_accounts","tax","scoring_attributes","credit","education"],"example":"payroll","uniqueKey":"links.oneOf.0.items.[INDEX].data_source","typeLabel":"enum\u003cstring>"},"is_suspicious":{"description":"Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data","type":"boolean","uniqueKey":"links.oneOf.0.items.[INDEX].is_suspicious","typeLabel":"boolean"},"fraud_reasons":{"description":"Findings recorded for this link and its tasks. Included only when `show_fraud_reasons=true`. An empty array means no findings are available for this response.","type":"array","items":{"type":"object","description":"One recorded finding for a task or link.","required":["code","message","severity","document_ids","uploaded_file_ids","details","task_id","created_at"],"properties":{"code":{"description":"Machine-readable identifier for the type of finding.","type":"string","enum":["editing_software_detected","screenshot","design_software_detected","document_from_online_generator","office_software_detected","scanned_document","suspicious_producer","blocked_text_content","document_type_mismatch","ai_generated_content","invalid_content_credentials","malware_detected","modified_before_creation_date","future_date","modified_after_creation","anomalous_pdf_structure","invalid_date","has_only_images","insufficient_text","content_tampering_suspected","content_diff_between_versions","ssn_mismatch_between_documents","ssn_mismatch_with_applicant","inconsistent_payroll_taxes"],"example":"editing_software_detected","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable explanation of the finding.","type":"string","example":"Document metadata identifies editing software.","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].message","typeLabel":"string"},"severity":{"description":"Severity assigned to the finding. This value is not a confidence score. Use the task status to determine the current processing outcome. `high` - finding classified as fraud, `medium` - finding classified as suspicious, `low` - document-quality or validation finding, not a fraud finding.","type":"string","enum":["high","medium","low"],"example":"high","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"document_ids":{"description":"IDs of the documents associated with the finding. Empty when the finding does not refer to a specific document. These are Documents API IDs, which differ from Collections API `document_id` values.","type":"array","items":{"type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].document_ids.items.[INDEX]","typeLabel":"string"},"example":["d1f3a6e0b1c24f6c9b3e2a7d5c8e9f01"],"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].document_ids","typeLabel":"string[]"},"uploaded_file_ids":{"description":"IDs of the original files uploaded through a document collection. Empty when no associated collection upload is available. One uploaded file may contain multiple recognized documents.","type":"array","items":{"type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].uploaded_file_ids.items.[INDEX]","typeLabel":"string"},"example":["9ac0b2d4e6f84a1c8e3b5d7f9a1c3e5b"],"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].uploaded_file_ids","typeLabel":"string[]"},"details":{"description":"Additional information about the finding. Available fields depend on the reason code.","type":"object","additionalProperties":true,"example":{"software":["Adobe Photoshop 25.0 (Windows)"]},"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].details","typeLabel":"object"},"task_id":{"oneOf":[{"description":"ID of the task associated with the finding. `null` if the finding was recorded directly on the link without an associated task.","type":"string","example":"48427a36d43c4d5aa6324bc06c692456","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].task_id.oneOf.0","typeLabel":"string"},{"description":"ID of the task associated with the finding. `null` if the finding was recorded directly on the link without an associated task.","type":"null","example":"48427a36d43c4d5aa6324bc06c692456","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].task_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].task_id","typeLabel":"string | null"},"created_at":{"description":"Date and time the finding was recorded, in ISO 8601 format.","type":"string","format":"date-time","example":"2026-10-20T14:03:11Z","isRequired":true,"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links.oneOf.0.items.[INDEX].fraud_reasons","typeLabel":"object[]"},"is_dds_available":{"oneOf":[{"description":"This flag indicates if connected account supports deposit switching functionality. null - unknown, True - yes, False - No","type":"boolean","uniqueKey":"links.oneOf.0.items.[INDEX].is_dds_available.oneOf.0","typeLabel":"boolean"},{"description":"This flag indicates if connected account supports deposit switching functionality. null - unknown, True - yes, False - No","type":"null","uniqueKey":"links.oneOf.0.items.[INDEX].is_dds_available.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.items.[INDEX].is_dds_available","typeLabel":"boolean | null"}},"description":"Link's properties","uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"readOnly":true,"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"description":"List of account Links associated with the user.","type":"null","items":{"type":"object","properties":{"id":{"description":"Link ID","type":"string","example":"48427a36d43c4d5aa6324bc06c692456","maxLength":32},"access_token":{"description":"Access token for data refresh. Returns masked value (e.g., `****************************7610`) unless filtered by `user_id`, in which case the full token is returned.","type":"string","readOnly":true,"example":"****************************7610","maxLength":64},"created_at":{"description":"Link creation timestamp (ISO 8601)","type":"string","example":"2022-06-07T15:00:00Z"},"updated_at":{"description":"Link last update timestamp (ISO 8601)","type":"string","example":"2022-06-30T15:00:00Z"},"deleted_at":{"oneOf":[{"description":"Link removal timestamp (ISO 8601)","type":"string","example":"2022-06-30T15:00:00Z"},{"description":"Link removal timestamp (ISO 8601)","type":"null","example":"2022-06-30T15:00:00Z"}]},"tracking_info":{"oneOf":[{"description":"Optional tracking information provided by a partner","type":"string","example":"user123456","maxLength":255},{"description":"Optional tracking information provided by a partner","type":"null","example":"user123456","maxLength":255}]},"status":{"description":"Status of the last Task","type":"string","example":"new"},"user_external_id":{"oneOf":[{"description":"User external ID is information provided by a partner","type":"string","example":"user123456"},{"description":"User external ID is information provided by a partner","type":"null","example":"user123456"}]},"provider_id":{"description":"Data provider ID","type":"string","example":"adp"},"provider":{"oneOf":[{"type":"object","properties":{"id":{"description":"Data provider ID.","type":"string","readOnly":true,"example":"adp","maxLength":64},"name":{"description":"Data provider name.","type":"string","readOnly":true,"example":"ADP","maxLength":128},"logo_url":{"oneOf":[{"description":"Data provider logo image.","type":"string"},{"description":"Data provider logo image.","type":"null"}]}},"required":["id","name"]},{"type":"null","properties":{"id":{"description":"Data provider ID.","type":"string","readOnly":true,"example":"adp","maxLength":64},"name":{"description":"Data provider name.","type":"string","readOnly":true,"example":"ADP","maxLength":128},"logo_url":{"oneOf":[{"description":"Data provider logo image.","type":"string"},{"description":"Data provider logo image.","type":"null"}]}},"required":["id","name"]}]},"company_mapping":{"oneOf":[{"type":"object","properties":{"id":{"oneOf":[{"description":"Employer ID.","type":"string","readOnly":true,"example":"meta","maxLength":64},{"description":"Employer ID.","type":"null","readOnly":true,"example":"meta","maxLength":64}]},"name":{"description":"Employer name.","type":"string","readOnly":true,"example":"Meta","maxLength":255},"logo_url":{"oneOf":[{"description":"Employer logo image.","type":"string"},{"description":"Employer logo image.","type":"null"}]}},"required":["id","name"]},{"type":"null","properties":{"id":{"oneOf":[{"description":"Employer ID.","type":"string","readOnly":true,"example":"meta","maxLength":64},{"description":"Employer ID.","type":"null","readOnly":true,"example":"meta","maxLength":64}]},"name":{"description":"Employer name.","type":"string","readOnly":true,"example":"Meta","maxLength":255},"logo_url":{"oneOf":[{"description":"Employer logo image.","type":"string"},{"description":"Employer logo image.","type":"null"}]}},"required":["id","name"]}]},"link_hash":{"oneOf":[{"description":"Unique hash for the user credentials used to create the link","type":"string","example":"bc917458a3da4b2c8cc8282aa1707aaa"},{"description":"Unique hash for the user credentials used to create the link","type":"null","example":"bc917458a3da4b2c8cc8282aa1707aaa"}]},"allowed_products":{"description":"List of all allowed products for this connection","type":"array","example":["income"],"items":{"type":"string","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education"]}},"initial_product_type":{"oneOf":[{"description":"Initial product type","type":"string","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education",null],"example":"income"},{"description":"Initial product type","type":"null","enum":["income","employment","deposit_switch","pll","insurance","transactions","assets","credit","education",null],"example":"income"}]},"data_source":{"description":"Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.","type":"string","enum":["payroll","docs","insurance","financial_accounts","tax","scoring_attributes","credit","education"],"example":"payroll"},"is_suspicious":{"description":"Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data","type":"boolean"},"fraud_reasons":{"description":"Findings recorded for this link and its tasks. Included only when `show_fraud_reasons=true`. An empty array means no findings are available for this response.","type":"array","items":{"type":"object","description":"One recorded finding for a task or link.","required":["code","message","severity","document_ids","uploaded_file_ids","details","task_id","created_at"],"properties":{"code":{"description":"Machine-readable identifier for the type of finding.","type":"string","enum":["editing_software_detected","screenshot","design_software_detected","document_from_online_generator","office_software_detected","scanned_document","suspicious_producer","blocked_text_content","document_type_mismatch","ai_generated_content","invalid_content_credentials","malware_detected","modified_before_creation_date","future_date","modified_after_creation","anomalous_pdf_structure","invalid_date","has_only_images","insufficient_text","content_tampering_suspected","content_diff_between_versions","ssn_mismatch_between_documents","ssn_mismatch_with_applicant","inconsistent_payroll_taxes"],"example":"editing_software_detected"},"message":{"description":"Human-readable explanation of the finding.","type":"string","example":"Document metadata identifies editing software."},"severity":{"description":"Severity assigned to the finding. This value is not a confidence score. Use the task status to determine the current processing outcome. `high` - finding classified as fraud, `medium` - finding classified as suspicious, `low` - document-quality or validation finding, not a fraud finding.","type":"string","enum":["high","medium","low"],"example":"high"},"document_ids":{"description":"IDs of the documents associated with the finding. Empty when the finding does not refer to a specific document. These are Documents API IDs, which differ from Collections API `document_id` values.","type":"array","items":{"type":"string"},"example":["d1f3a6e0b1c24f6c9b3e2a7d5c8e9f01"]},"uploaded_file_ids":{"description":"IDs of the original files uploaded through a document collection. Empty when no associated collection upload is available. One uploaded file may contain multiple recognized documents.","type":"array","items":{"type":"string"},"example":["9ac0b2d4e6f84a1c8e3b5d7f9a1c3e5b"]},"details":{"description":"Additional information about the finding. Available fields depend on the reason code.","type":"object","additionalProperties":true,"example":{"software":["Adobe Photoshop 25.0 (Windows)"]}},"task_id":{"oneOf":[{"description":"ID of the task associated with the finding. `null` if the finding was recorded directly on the link without an associated task.","type":"string","example":"48427a36d43c4d5aa6324bc06c692456"},{"description":"ID of the task associated with the finding. `null` if the finding was recorded directly on the link without an associated task.","type":"null","example":"48427a36d43c4d5aa6324bc06c692456"}]},"created_at":{"description":"Date and time the finding was recorded, in ISO 8601 format.","type":"string","format":"date-time","example":"2026-10-20T14:03:11Z"}}}},"is_dds_available":{"oneOf":[{"description":"This flag indicates if connected account supports deposit switching functionality. null - unknown, True - yes, False - No","type":"boolean"},{"description":"This flag indicates if connected account supports deposit switching functionality. null - unknown, True - yes, False - No","type":"null"}]}},"description":"Link's properties"},"readOnly":true,"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"voie_report_id":{"oneOf":[{"description":"GSE accepted income and employment verification report ID","type":"string","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"voie_report_id.oneOf.0","typeLabel":"string"},{"description":"GSE accepted income and employment verification report ID","type":"null","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"voie_report_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"voie_report_id","typeLabel":"string | null"},"voa_report_id":{"oneOf":[{"description":"Verification of Assets report ID","type":"string","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"voa_report_id.oneOf.0","typeLabel":"string"},{"description":"Verification of Assets report ID","type":"null","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"voa_report_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"voa_report_id","typeLabel":"string | null"},"income_insights_report_id":{"oneOf":[{"description":"Income insights report ID","type":"string","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"income_insights_report_id.oneOf.0","typeLabel":"string"},{"description":"Income insights report ID","type":"null","example":"b19c454a98594b4084b71e3b62873d29","maxLength":32,"uniqueKey":"income_insights_report_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"income_insights_report_id","typeLabel":"string | null"},"aim_check_report_id":{"oneOf":[{"description":"AIM check report ID","type":"string","example":"FM-1234-39aa1486ccca4bc19cda071ffc1ba392","maxLength":64,"uniqueKey":"aim_check_report_id.oneOf.0","typeLabel":"string"},{"description":"AIM check report ID","type":"null","example":"FM-1234-39aa1486ccca4bc19cda071ffc1ba392","maxLength":64,"uniqueKey":"aim_check_report_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"aim_check_report_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"24d7e80942ce4ad58a93f70ce4115f5c","external_user_id":"12345","created_at":"2022-05-04T11:30:00Z","updated_at":"2022-05-04T12:00:00Z","first_name":"John","last_name":"Doe","email":"john.doe@example.com","phone":"+14155554193","ssn":"*****3333","links":[{"id":"48427a36d43c4d5aa6324bc06c692456","access_token":"****************************7610","created_at":"2022-06-07T15:00:00Z","updated_at":"2022-06-30T15:00:00Z","deleted_at":"2022-06-30T15:00:00Z","tracking_info":"user123456","status":"new","user_external_id":"user123456","provider_id":"adp","provider":{"id":"adp","name":"ADP","logo_url":"\u003cstring>"},"company_mapping":{"id":"meta","name":"Meta","logo_url":"\u003cstring>"},"link_hash":"bc917458a3da4b2c8cc8282aa1707aaa","allowed_products":["income"],"initial_product_type":"income","data_source":"payroll","is_suspicious":true,"fraud_reasons":[{"code":"editing_software_detected","message":"Document metadata identifies editing software.","severity":"high","document_ids":["d1f3a6e0b1c24f6c9b3e2a7d5c8e9f01"],"uploaded_file_ids":["9ac0b2d4e6f84a1c8e3b5d7f9a1c3e5b"],"details":{"software":["Adobe Photoshop 25.0 (Windows)"]},"task_id":"48427a36d43c4d5aa6324bc06c692456","created_at":"2026-10-20T14:03:11Z"}],"is_dds_available":true}],"voie_report_id":"b19c454a98594b4084b71e3b62873d29","voa_report_id":"b19c454a98594b4084b71e3b62873d29","income_insights_report_id":"b19c454a98594b4084b71e3b62873d29","aim_check_report_id":"FM-1234-39aa1486ccca4bc19cda071ffc1ba392"}}},"exampleType":"generated"}},"exampleType":"generated"},"f4dd05dd-352c-402c-a18f-a406750963ca":{"description":"HTTP 401 Unauthorized","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"error":{"description":"","type":"object","properties":{"code":{"description":"","type":"string","example":"authentication_failed","uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"","type":"string","example":"No such token","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"authentication_failed","message":"No such token"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b3c059c4-21fb-4e84-bcee-03b18e268f8c":{"description":"HTTP 403 Forbidden","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"error":{"description":"","type":"object","properties":{"code":{"description":"","type":"string","example":"not_authenticated","uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"","type":"string","example":"Authentication credentials were not provided.","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_authenticated","message":"Authentication credentials were not provided."}}}},"exampleType":"generated"}},"exampleType":"generated"},"107ba777-e77c-4242-9f0d-07a07f8f7dd0":{"description":"HTTP 404 Not Found","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"detail":{"description":"","type":"string","example":"Not Found.","uniqueKey":"detail","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"Not Found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"35daf88f-977c-46f9-9de3-fafbcd723553":{"ClientID":{"type":"apiKey","description":"Client ID","name":"X-Access-Client-Id","in":"header","scopes":[],"schemeName":"ClientID"},"AccessKey":{"type":"apiKey","description":"Client Access Key","name":"X-Access-Secret","in":"header","scopes":[],"schemeName":"AccessKey"}}},"servers":{"833b4f73-c154-490d-aa6d-bec739989c24":{"url":"https://prod.truv.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Client ID","name":"X-Access-Client-Id","in":"header","scopes":[],"schemeName":"ClientID"},"schema":{"title":"X-Access-Client-Id","type":"string","description":"Client ID","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ClientID","name":"X-Access-Client-Id"},{"scheme":{"type":"apiKey","description":"Client Access Key","name":"X-Access-Secret","in":"header","scopes":[],"schemeName":"AccessKey"},"schema":{"title":"X-Access-Secret","type":"string","description":"Client Access Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessKey","name":"X-Access-Secret"}],"title":"ClientID \u0026 AccessKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"truv","siteName":"Truv","title":"Retrieve a user - Truv","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-24T17:37:29.012Z","originalFileLocation":"api-reference/users/users_read.mdx"},"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=\"This endpoint retrieves a user.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Truv\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_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/truv/PBlsvTBzkVYuAN1i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a user - Truv\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint retrieves a user.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Truv\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.truv.com/api-reference/users/users_read\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://truv.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Retrieve+a+user\u0026amp;description=This+endpoint+retrieves+a+user.\u0026amp;theme=1723ee55d07f48855b7cbd7f\u0026amp;signature=6f634ae8735395f0dadc475c9bf17cdb160718d0f589637411c3f68f6a9413a3\">\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=\"Retrieve a user - Truv\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint retrieves a user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://truv.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Retrieve+a+user\u0026amp;description=This+endpoint+retrieves+a+user.\u0026amp;theme=1723ee55d07f48855b7cbd7f\u0026amp;signature=6f634ae8735395f0dadc475c9bf17cdb160718d0f589637411c3f68f6a9413a3\">\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/truv/PBlsvTBzkVYuAN1i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Truv\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2C64E3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.truv.com/api-reference/users/users_read\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/users_read.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.truv.com/#organization\",\"name\":\"Truv\",\"url\":\"https://docs.truv.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/dark.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=4a88c1e43db8b515ffb08e5f87aafa65\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.truv.com#website\",\"name\":\"Truv\",\"url\":\"https://docs.truv.com\",\"publisher\":{\"@id\":\"https://docs.truv.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.truv.com/api-reference/users/users_read#webpage\",\"url\":\"https://docs.truv.com/api-reference/users/users_read\",\"name\":\"Retrieve a user\",\"description\":\"This endpoint retrieves a user.\",\"dateModified\":\"2026-02-24T17:37:29.012Z\",\"isPartOf\":{\"@id\":\"https://docs.truv.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.truv.com/api-reference/users/users_read#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.truv.com/api-reference/users/users_read#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.truv.com/api-reference/data-structure\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Users\",\"item\":\"https://docs.truv.com/api-reference/users/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a user\",\"item\":\"https://docs.truv.com/api-reference/users/users_read\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.truv.com/api-reference/users/users_read#apireference\",\"headline\":\"Retrieve a user\",\"name\":\"Retrieve a user\",\"description\":\"This endpoint retrieves a user.\",\"url\":\"https://docs.truv.com/api-reference/users/users_read\",\"mainEntityOfPage\":{\"@id\":\"https://docs.truv.com/api-reference/users/users_read#webpage\"},\"dateModified\":\"2026-02-24T17:37:29.012Z\",\"publisher\":{\"@id\":\"https://docs.truv.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.truv.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Truv\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Truv","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/developers/home"}]},{"tab":"Mortgage","pages":[{"title":"Mortgage","href":"/mortgage/overview"}]},{"tab":"Public Sector","pages":[{"title":"Public Sector","href":"/government/overview"}]},{"tab":"Consumer Credit","pages":[{"title":"Consumer Credit","href":"/credit/overview"}]},{"tab":"Retail Banking","pages":[{"title":"Retail Banking","href":"/banking/overview"}]},{"tab":"Screening","pages":[{"title":"Screening","href":"/screening/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors \u0026 Rate Limits","href":"/api-reference/errors"},{"title":"Security","href":"/api-reference/security"},{"title":"OpenAPI Spec","sidebarTitle":"OpenAPI Spec","href":"/api-reference/openapi"},{"title":"SDK Overview","href":"/developers/sdks/overview"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Postman Collection","href":"/api-reference/postman"},{"title":"Report Sizes","href":"/api-reference/report-sizes"}]},{"group":"Platform","pages":[{"title":"Data Structure","sidebarTitle":"Data Structure","href":"/api-reference/data-structure"},{"title":"Data Processing","sidebarTitle":"Data Processing","href":"/api-reference/data-processing"},{"group":"Orders","pages":[{"title":"The Orders object","href":"/api-reference/orders/object"},{"title":"Order Webhook Events","href":"/api-reference/orders/events"},{"title":"Create an order","openapi":"POST /v1/orders/","href":"/api-reference/orders/orders_create"},{"title":"Create orders as a batch","openapi":"POST /v1/orders/batch/","href":"/api-reference/orders/orders_batch_create"},{"title":"Get order batch job status","openapi":"GET /v1/orders/batch/{id}/","href":"/api-reference/orders/orders_batch_status"},{"title":"List orders","openapi":"GET /v1/orders/","href":"/api-reference/orders/orders_list"},{"title":"Get list of orders by SSN","openapi":"POST /v1/orders/lookup/","href":"/api-reference/orders/orders_list_lookup"},{"title":"Retrieve an order","openapi":"GET /v1/orders/{id}/","href":"/api-reference/orders/orders_read"},{"title":"Update an order","openapi":"PATCH /v1/orders/{id}/","href":"/api-reference/orders/orders_partial_update"},{"title":"Cancel an order","openapi":"POST /v1/orders/{id}/cancel/","href":"/api-reference/orders/orders_cancel_create"},{"title":"Create a data refresh order","openapi":"POST /v1/orders/{id}/","href":"/api-reference/orders/orders_create_refresh_order"},{"title":"Add new employer to the existing order","openapi":"POST /v1/orders/{id}/employers/","href":"/api-reference/orders/order-add-new-employer"},{"title":"Retrieve events for an order","openapi":"GET /v1/orders/{id}/events/","href":"/api-reference/orders/orders_events_list"},{"title":"Retrieve self-certification results for an order","openapi":"GET /v1/orders/{id}/certifications/","href":"/api-reference/orders/orders_certifications_results"},{"title":"Retrieve an order invoice","openapi":"GET /v1/orders/{id}/invoice/","href":"/api-reference/orders/order_group_invoice_detail"}]},{"group":"Users","pages":[{"title":"The Users object","href":"/api-reference/users/object"},{"title":"Create a user","openapi":"POST /v1/users/","href":"/api-reference/users/users_create"},{"title":"List all users","openapi":"GET /v1/users/","description":"The endpoint returns a list of users.","href":"/api-reference/users/users_list"},{"title":"Retrieve a user","openapi":"GET /v1/users/{user_id}/","href":"/api-reference/users/users_read"},{"title":"Update a user","openapi":"PATCH /v1/users/{user_id}/","description":"The endpoint updates a user.","href":"/api-reference/users/users_partial_update"},{"title":"Delete a user","openapi":"DELETE /v1/users/{user_id}/","href":"/api-reference/users/users_delete"}]},{"group":"Bridge Token","pages":[{"title":"The Bridge Token object","href":"/api-reference/bridge-token/object"},{"title":"Create a bridge token","openapi":"POST /v1/users/{user_id}/tokens/","href":"/api-reference/bridge-token/users_tokens"}]},{"group":"Tasks","pages":[{"title":"The Tasks object","href":"/api-reference/tasks/object"},{"title":"Task Lifecycle","href":"/api-reference/tasks/lifecycle"},{"title":"Task Webhook Events","href":"/api-reference/tasks/events"},{"title":"List all tasks","openapi":"GET /v1/tasks/","href":"/api-reference/tasks/tasks_list"},{"title":"Retrieve a task","openapi":"GET /v1/tasks/{id}/","href":"/api-reference/tasks/tasks_read"}]},{"group":"Data Refresh","pages":[{"title":"The Task Refresh object","href":"/api-reference/refresh/object"},{"title":"Create a data refresh task","openapi":"POST /v1/refresh/tasks/","href":"/api-reference/refresh/refresh_task_create"},{"title":"Retrieve a data refresh status","openapi":"GET /v1/refresh/tasks/{task_id}/","href":"/api-reference/refresh/refresh_task"}]},{"group":"Account Links","pages":[{"title":"The Account Links object","href":"/api-reference/links/object"},{"title":"Account Link Webhook Events","href":"/api-reference/links/events"},{"title":"List all links","openapi":"GET /v1/links/","href":"/api-reference/links/links-list"},{"title":"Retrieve a link","openapi":"GET /v1/links/{link_id}/","href":"/api-reference/links/links-item"},{"title":"Retrieve a link token","openapi":"POST /v1/link-access-tokens/","href":"/api-reference/links/link_exchange_token_flow"},{"title":"Delete a link","openapi":"DELETE /v1/links/{link_id}/","href":"/api-reference/links/delete_link_by_link_id"}]},{"group":"Companies","pages":[{"title":"The Companies object","href":"/api-reference/companies/object"},{"title":"Search companies","openapi":"POST /v1/companies/","href":"/api-reference/companies/company_mapping"},{"title":"Get company information","openapi":"GET /v1/companies/{company_mapping_id}/","href":"/api-reference/companies/company_info"},{"title":"Search companies with autocomplete","openapi":"GET /v1/company-mappings-search/","href":"/api-reference/companies/company_autocomplete_search"}]},{"group":"Data Providers","pages":[{"title":"The Data Providers object","href":"/api-reference/data-providers/object"},{"title":"List all data providers","openapi":"GET /v1/providers/","href":"/api-reference/data-providers/providers-list"},{"title":"Retrieve a data provider","openapi":"GET /v1/providers/{id}/","href":"/api-reference/data-providers/providers-detail"}]},{"group":"UX Customization","pages":[{"title":"The Templates object","href":"/api-reference/templates/object"},{"title":"Create a customization template","openapi":"POST /v1/templates/","href":"/api-reference/templates/templates_create"},{"title":"List all customization templates","openapi":"GET /v1/templates/","href":"/api-reference/templates/templates_list"},{"title":"Retrieve a customization template","openapi":"GET /v1/templates/{template_id}/","href":"/api-reference/templates/templates_read"},{"title":"Update a customization template","openapi":"PATCH /v1/templates/{template_id}/","href":"/api-reference/templates/templates_partial_update"},{"title":"Delete a customization template","openapi":"DELETE /v1/templates/{template_id}/","href":"/api-reference/templates/templates_delete"}]},{"group":"Sandbox","pages":[{"title":"The Sandbox Scenario object","href":"/api-reference/sandbox/object"},{"title":"Create a sandbox scenario","openapi":"POST /v1/sandbox/scenarios/","href":"/api-reference/sandbox/v1_sandbox_scenarios_create"},{"title":"List sandbox scenarios","openapi":"GET /v1/sandbox/scenarios/","href":"/api-reference/sandbox/v1_sandbox_scenarios_list"},{"title":"Retrieve a sandbox scenario","openapi":"GET /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_read"},{"title":"Update a sandbox scenario","openapi":"PATCH /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_partial_update"},{"title":"Delete a sandbox scenario","openapi":"DELETE /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_delete"},{"title":"Resolve a sandbox scenario","openapi":"POST /v1/sandbox/scenarios/resolve/","href":"/api-reference/sandbox/v1_sandbox_scenarios_resolve"},{"title":"Upload a sandbox document","openapi":"POST /v1/sandbox/documents/","href":"/api-reference/sandbox/v1_sandbox_documents_create"},{"title":"List sandbox documents","openapi":"GET /v1/sandbox/documents/","href":"/api-reference/sandbox/v1_sandbox_documents_list"},{"title":"Retrieve a sandbox document","openapi":"GET /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_read"},{"title":"Update a sandbox document","openapi":"PATCH /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_partial_update"},{"title":"Delete a sandbox document","openapi":"DELETE /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_delete"}]},{"group":"Key Management","hidden":true,"pages":[{"title":"The Key Management object","href":"/api-reference/keys/object"},{"title":"Create an API key","openapi":"POST /v1/keys/","href":"/api-reference/keys/keys-create"},{"title":"Deactivate an API key","openapi":"POST /v1/keys/deactivate/","href":"/api-reference/keys/keys-deactivate"}]},{"group":"Webhook Endpoints","pages":[{"title":"The Webhook Endpoint object","href":"/api-reference/webhooks/object"},{"title":"Create a webhook endpoint","openapi":"POST /v1/webhooks/","href":"/api-reference/webhooks/webhooks_create"},{"title":"List all webhook endpoints","openapi":"GET /v1/webhooks/","href":"/api-reference/webhooks/webhooks_list"},{"title":"Retrieve a webhook endpoint","openapi":"GET /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_read"},{"title":"Update a webhook endpoint","openapi":"PATCH /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_partial_update"},{"title":"Delete a webhook endpoint","openapi":"DELETE /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_delete"},{"title":"List webhook request history","openapi":"GET /v1/webhook-requests/","href":"/api-reference/webhooks/webhook_requests_list"}]}]},{"group":"Income \u0026 Employment","pages":[{"group":"User Income and Employment Report","pages":[{"title":"The User Income \u0026 Employment Reports object","href":"/api-reference/user-income-and-employment-reports/object"},{"title":"Create an income and employment report","openapi":"POST /v1/users/{user_id}/reports/","href":"/api-reference/user-income-and-employment-reports/users_reports"},{"title":"Retrieve an income and employment report","openapi":"GET /v1/users/{user_id}/reports/{report_id}/","href":"/api-reference/user-income-and-employment-reports/users_get_report"}]},{"group":"Link Income and Employment Report","pages":[{"title":"The Link Income \u0026 Employment Reports object","href":"/api-reference/account-link-income-and-employment-reports/object"},{"title":"Retrieve an income and employment report for a link","openapi":"GET /v1/links/{link_id}/income/report/","href":"/api-reference/account-link-income-and-employment-reports/link_detail_reports_income"},{"title":"Retrieve an employment history report for a link","openapi":"GET /v1/links/{link_id}/employment/report/","href":"/api-reference/account-link-income-and-employment-reports/link_detail_reports_employment"}]},{"group":"Benefit Letters","pages":[{"title":"List all benefit letters","openapi":"GET /v1/links/{link_id}/benefit_letters/","href":"/api-reference/benefit-letters/benefit-letters"},{"title":"Retrieve benefit letter","openapi":"GET /v1/links/{link_id}/benefit_letters/{benefit_letter_id}/","href":"/api-reference/benefit-letters/benefit-letter"}]},{"group":"Employment","pages":[{"title":"The Employment object","href":"/api-reference/employment/object"},{"title":"Employment Webhook Events","href":"/api-reference/employment/events"},{"title":"List all employments","openapi":"GET /v1/links/{link_id}/employments/","href":"/api-reference/employment/link-employments"},{"title":"Retrieve an employment","openapi":"GET /v1/links/{link_id}/employment/","href":"/api-reference/employment/link-last-employment"}]},{"group":"Identity","pages":[{"title":"The Identity object","href":"/api-reference/identity/object"},{"title":"Identity Webhook Events","href":"/api-reference/identity/events"},{"title":"Retrieve an identity","openapi":"GET /v1/links/{link_id}/identity/","href":"/api-reference/identity/link-identity"}]},{"group":"Pay Statements","pages":[{"title":"The Pay Statements object","href":"/api-reference/statements/object"},{"title":"Pay Statement Webhook Events","href":"/api-reference/statements/events"},{"title":"List all statements","openapi":"GET /v1/links/{link_id}/statements/","href":"/api-reference/statements/link-statements"},{"title":"Retrieve a statement","openapi":"GET /v1/links/{link_id}/statements/{statement_id}/","href":"/api-reference/statements/retrieve-statement"}]},{"group":"Shifts","pages":[{"title":"The Shifts object","href":"/api-reference/shifts/object"},{"title":"Shift Webhook Events","href":"/api-reference/shifts/events"},{"title":"List all shifts","openapi":"GET /v1/links/{link_id}/shifts/","href":"/api-reference/shifts/link-shifts"}]},{"group":"Tax Documents","pages":[{"title":"The Tax Documents object","href":"/api-reference/tax/object"},{"title":"List all tax documents","openapi":"GET /v1/links/{link_id}/tax/","href":"/api-reference/tax/tax-documents"},{"title":"Retrieve tax document","openapi":"GET /v1/links/{link_id}/tax/{tax_id}/","href":"/api-reference/tax/tax-document"}]}]},{"group":"Financial Accounts","pages":[{"group":"User Assets Report","pages":[{"title":"The User Asset Reports object","href":"/api-reference/user-asset-verification-reports/object"},{"title":"Create an assets report","openapi":"POST /v1/users/{user_id}/assets/reports/","href":"/api-reference/user-asset-verification-reports/assets-report-create"},{"title":"Retrieve an assets report","openapi":"GET /v1/users/{user_id}/assets/reports/{report_id}/","href":"/api-reference/user-asset-verification-reports/assets-report-retrieve"}]},{"group":"Bank Income Report","pages":[{"title":"The Bank Income Report Object","href":"/api-reference/bank-income-insights/object"},{"title":"Retrieve the most recent bank income report","openapi":"GET /v1/links/{link_id}/income/transactions/reports/","href":"/api-reference/bank-income-insights/bank-income-report-retrieve"}]},{"group":"User Income Insights Report","pages":[{"title":"The User Income Insights object","href":"/api-reference/income-insights/object"},{"title":"Create a user bank income insights report","openapi":"POST /v1/users/{user_id}/income_insights/reports/","href":"/api-reference/income-insights/income-insights-report-create"},{"title":"Retrieve a user bank income insights report","openapi":"GET /v1/users/{user_id}/income_insights/reports/{report_id}/","href":"/api-reference/income-insights/income-insights-report-retrieve"}]},{"group":"Auth","pages":[{"title":"The Auth object","href":"/api-reference/auth/object"},{"title":"Retrieve auth data","openapi":"GET /v1/links/{link_id}/auth/","href":"/api-reference/auth/bank-auth-get"}]},{"group":"Balances","pages":[{"title":"The Balances object","href":"/api-reference/balances/object"},{"title":"List all balances","openapi":"GET /v1/links/{link_id}/balances/","href":"/api-reference/balances/balances-list"}]},{"group":"Transactions","pages":[{"title":"The Transactions object","href":"/api-reference/transactions/object"},{"title":"List all bank transactions","openapi":"GET /v1/links/{link_id}/transactions/","href":"/api-reference/transactions/link-bank-data-transactions"}]},{"group":"Recurring Transactions","pages":[{"title":"Retrieve recurring transactions (inflows and outflows) for a user","openapi":"GET /v1/users/{user_id}/transactions/recurring/","href":"/api-reference/recurring-transactions/applicant-recurring-transactions"}]},{"group":"Bank Statements","pages":[{"title":"List all bank statements","openapi":"GET /v1/links/{link_id}/bank_statements/","href":"/api-reference/bank-statements/link-bank-statements"}]},{"group":"Investments","pages":[{"title":"List all investment holdings","openapi":"GET /v1/links/{link_id}/investments/","href":"/api-reference/investments/link-investments-list"}]},{"group":"Liabilities","pages":[{"title":"The Liabilities object","href":"/api-reference/liabilities/object"},{"title":"Retrieve liabilities","openapi":"GET /v1/links/{link_id}/liabilities/","href":"/api-reference/liabilities/link_liabilities"}]},{"group":"Scoring Attributes Reports","pages":[{"title":"The Scoring Attributes Report object","href":"/api-reference/scoring-attributes/object"},{"title":"Create a scoring attributes report","openapi":"POST /v1/scoring_attributes/reports","href":"/api-reference/scoring-attributes/scoring-attributes-report-create"},{"title":"Retrieve a scoring attributes report","openapi":"GET /v1/scoring_attributes/reports/{report_id}","href":"/api-reference/scoring-attributes/scoring-attributes-report-retrieve"}]}]},{"group":"Document Processing","pages":[{"group":"Document Collections","pages":[{"title":"The Document Collections object","href":"/api-reference/document-collections/object"},{"title":"Document Collection Webhook Events","href":"/api-reference/document-collections/events"},{"title":"Create a new document collection","openapi":"POST /v1/documents/collections/","href":"/api-reference/document-collections/collections_create"},{"title":"Get document collection details","openapi":"GET /v1/documents/collections/{collection_id}/","href":"/api-reference/document-collections/collections_retrieve"},{"title":"List all document collections","openapi":"GET /v1/documents/collections/","href":"/api-reference/document-collections/collections_list"},{"title":"Upload files to existing collection","openapi":"POST /v1/documents/collections/{collection_id}/upload/","href":"/api-reference/document-collections/collections_upload"},{"title":"Get uploaded file details","openapi":"GET /v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/","href":"/api-reference/document-collections/collections_uploaded_file_retrieve"},{"title":"Finalize a collection","openapi":"POST /v1/documents/collections/{collection_id}/finalize/","href":"/api-reference/document-collections/collections_finalize_create"},{"title":"Get collection finalization results","openapi":"GET /v1/documents/collections/{collection_id}/finalize/","href":"/api-reference/document-collections/collections_finalize_retrieve"},{"title":"Delete an uploaded file","openapi":"DELETE /v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/","href":"/api-reference/document-collections/collections_uploaded_file_delete"},{"title":"Delete a document collection","openapi":"DELETE /v1/documents/collections/{collection_id}/","href":"/api-reference/document-collections/collections_delete"}]},{"group":"Uploaded Documents","pages":[{"title":"The Uploaded Documents object","href":"/api-reference/uploaded-documents/object"},{"title":"List all documents","openapi":"GET /v1/links/{link_id}/documents/","href":"/api-reference/uploaded-documents/list-documents"},{"title":"Retrieve document","openapi":"GET /v1/links/{link_id}/documents/{doc_id}/","href":"/api-reference/uploaded-documents/retrieve-document"}]},{"group":"Parsed Documents","pages":[{"title":"The Parsed Documents object","href":"/api-reference/parsed-documents/object"},{"title":"List all parsed documents","openapi":"GET /v1/links/{link_id}/parsed-documents/","href":"/api-reference/parsed-documents/list-parsed-documents"},{"title":"Retrieve parsed document","openapi":"GET /v1/links/{link_id}/parsed-documents/{doc_id}/","href":"/api-reference/parsed-documents/retrieve-parsed-document"}]}]},{"group":"Direct Deposit Switch","pages":[{"group":"Bank Accounts","pages":[{"title":"The Bank Accounts object","href":"/api-reference/bank-accounts/object"},{"title":"List all bank accounts","openapi":"GET /v1/links/{link_id}/bank_accounts/","href":"/api-reference/bank-accounts/link-bank-accounts"},{"title":"Bank Account Webhook Events","href":"/api-reference/bank-accounts/events"}]},{"group":"Deposit Switch","pages":[{"title":"The Deposit Switch object","href":"/api-reference/deposit-switch/object"},{"title":"Retrieve a direct deposit switch report for a link","openapi":"GET /v1/links/{link_id}/direct_deposit/report/","href":"/api-reference/deposit-switch/link_detail_reports_dds"},{"title":"Retrieve a paycheck linked loan report","openapi":"GET /v1/links/{link_id}/pll/report/","href":"/api-reference/deposit-switch/link_detail_reports_pll"}]},{"group":"User deposit switch report","pages":[{"title":"The User Deposit Switch Object","href":"/api-reference/dds-reports/object"},{"title":"Retrieve a deposit switch report","openapi":"GET /v1/users/{user_id}/deposit_switch/report/","href":"/api-reference/dds-reports/dds-report-retrieve"}]}]},{"group":"Insurance Verification","pages":[{"group":"Link Insurance Report","pages":[{"title":"The Insurance object","href":"/api-reference/insurance/object"},{"title":"Retrieve an auto insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/auto/","href":"/api-reference/insurance/link_detail_reports_insurance_auto"},{"title":"Retrieve a home insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/home/","href":"/api-reference/insurance/link_detail_reports_insurance_home"},{"title":"Retrieve an insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/","href":"/api-reference/insurance/link_detail_reports_insurance"}]}]}]}]},"basePath":"","title":"Retrieve a user - Truv","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}