{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Checkr Money","colors":{"primary":"#2C64E3","light":"#4A7FF7","dark":"#1A4FCC"},"logo":{"light":"https://mintcdn.com/checkrmoney/_HEqG_a_UJ268Pb6/logo-checkr-money-dark.svg?fit=max\u0026auto=format\u0026n=_HEqG_a_UJ268Pb6\u0026q=85\u0026s=a21903c67a2acd7c1f0463abdfeab7f7","dark":"https://mintcdn.com/checkrmoney/_HEqG_a_UJ268Pb6/logo-checkr-money-white.svg?fit=max\u0026auto=format\u0026n=_HEqG_a_UJ268Pb6\u0026q=85\u0026s=9ef87234e3fb0180b1ce6acfedc7c4b1"},"favicon":"https://mintcdn.com/checkrmoney/_HEqG_a_UJ268Pb6/favicon.ico?fit=max\u0026auto=format\u0026n=_HEqG_a_UJ268Pb6\u0026q=85\u0026s=eb89a4021140af51373e4740fd621722","navbar":{"links":[{"href":"mailto:support@mytruv.com","label":"Contact support"},{"href":"https://app.checkrmoney.com/login","label":"Log in"}],"primary":{"type":"button","label":"Sign up for free","href":"https://app.checkrmoney.com"}},"contextual":{"options":["copy","view","claude","chatgpt","mcp","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Sign up for free","icon":"user-plus","href":"https://app.checkrmoney.com"},{"anchor":"Download iOS app","icon":"apple","href":"https://apps.apple.com/us/app/id6757509490"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"checkrmoney","hasAudioNarration":false,"actualSubdomain":"checkrmoney","customDomains":["help.checkrmoney.com"],"gitSource":{"type":"github","owner":"truvhq","repo":"mytruv-help-docs","deployBranch":"rebrand/checkr-money","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad251c273563d02ea7a39b9","collectionId":"89066943-8f34-43b1-ae28-f287367c251f","liveDeploymentHistoryId":"6ad251c273563d02ea7a39b9","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad251c273563d02ea7a39b9","clientVersion":"0.0.3869","searchFilterCounts":[{"language":"default","tag":"Help Center","count":90},{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Get Started","count":15},{"language":"default","tag":"Transactions \u0026 Spending","count":15},{"language":"default","tag":"Accounts","count":13},{"language":"default","tag":"Account \u0026 Settings","count":11},{"language":"default","tag":"AI Assistant","count":11},{"language":"default","tag":"Troubleshooting","count":9},{"language":"default","tag":"Billing","count":8},{"language":"default","tag":"Bills \u0026 Subscriptions","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"editor-nav-generations","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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"global.css","content":".navbar a[href=\"https://app.checkrmoney.com\"],header a[class*=btn],header a[class*=button],nav a[class*=button],nav button{border-radius:9999px!important}header [class*=TabList],header [class*=tab-list],header [class*=tabs-container],header [role=tablist],header nav[aria-label*=Tabs i],header nav[aria-label*=tab i]{justify-content:center!important;margin:0 auto!important}header [role=tab],header [role=tab] *,header [role=tab][aria-selected=true],header [role=tab][aria-selected=true] *,header [role=tab][data-state=active],header [role=tab][data-state=active] *,header nav a[aria-current=page],header nav a[aria-current=page] *{font-weight:400!important}header [role=tab][aria-selected=true],header [role=tab][data-state=active],header nav a[aria-current=page]{background:rgba(0,0,0,.06);border-radius:9999px;color:#171717!important}:is([data-theme=\"dark\"], .dark) header [role=tab][aria-selected=true],:is([data-theme=\"dark\"], .dark) header [role=tab][data-state=active],:is([data-theme=\"dark\"], .dark) header nav a[aria-current=page]{background:rgba(255,255,255,.08);color:rgba(255,255,255,.95)!important}.mytruv-card-grid{display:grid;grid-template-columns:repeat(auto-fit,minmax(280px,1fr));gap:16px;margin:24px 0}.mytruv-card{position:relative;display:flex;flex-direction:column;gap:12px;padding:24px;background:#fff;border:1px solid rgba(0,0,0,.08);border-radius:24px;color:inherit;text-decoration:none;transition:box-shadow .2s ease,transform .2s ease,border-color .2s ease}.mytruv-card:hover{border-color:rgba(0,0,0,.18);box-shadow:0 6px 20px -8px rgba(0,0,0,.12);transform:translateY(-1px)}:is([data-theme=\"dark\"], .dark) .mytruv-card{background:rgba(255,255,255,.04);border-color:rgba(255,255,255,.08)}:is([data-theme=\"dark\"], .dark) .mytruv-card:hover{border-color:rgba(255,255,255,.2);box-shadow:0 6px 20px -8px rgba(0,0,0,.4)}.mytruv-card__icon{display:inline-flex;align-items:center;justify-content:center;width:32px;height:32px;color:#171717}:is([data-theme=\"dark\"], .dark) .mytruv-card:hover .mytruv-card__arrow,:is([data-theme=\"dark\"], .dark) .mytruv-card__icon{color:rgba(255,255,255,.92)}.mytruv-card__icon img,.mytruv-card__icon svg{width:28px;height:28px}.mytruv-card__title{font-size:1.0625rem;font-weight:500;line-height:1.25;letter-spacing:-.01em;color:inherit;margin:0}.mytruv-card__body{font-size:.9375rem;line-height:1.45;color:rgba(0,0,0,.6);margin:0}:is([data-theme=\"dark\"], .dark) .mytruv-card__body{color:rgba(255,255,255,.65)}.mytruv-card__arrow{position:absolute;top:20px;right:20px;color:rgba(0,0,0,.35);transition:color .2s ease,transform .2s ease}.mytruv-card:hover .mytruv-card__arrow{color:#171717;transform:translate(2px,-2px)}:is([data-theme=\"dark\"], .dark) .mytruv-card__arrow{color:rgba(255,255,255,.4)}.card-group{gap:16px!important;margin:24px 0!important}.card{border-radius:24px!important;border:1px solid rgba(0,0,0,.08)!important;background:#fff!important;margin:0!important;ring:0!important;transition:box-shadow .2s ease,transform .2s ease,border-color .2s ease!important}.card:hover{border-color:rgba(0,0,0,.18)!important;box-shadow:0 6px 20px -8px rgba(0,0,0,.12)!important;transform:translateY(-1px)}:is([data-theme=\"dark\"], .dark) .card{background:rgba(255,255,255,.04)!important;border-color:rgba(255,255,255,.08)!important}:is([data-theme=\"dark\"], .dark) .card:hover{border-color:rgba(255,255,255,.2)!important;box-shadow:0 6px 20px -8px rgba(0,0,0,.4)!important}.card [data-component-part=card-content-container]{padding:24px!important}.card [data-component-part=card-icon]{width:32px;height:32px;display:inline-flex;align-items:center;justify-content:center}.card [data-component-part=card-icon] svg{width:28px!important;height:28px!important;background-color:#171717!important}:is([data-theme=\"dark\"], .dark) .card [data-component-part=card-icon] svg{background-color:rgba(255,255,255,.92)!important}.card [data-component-part=card-title]{font-size:1.0625rem!important;font-weight:500!important;line-height:1.25!important;letter-spacing:-.01em!important;margin:12px 0 0!important}.card [data-component-part=card-content]{font-size:.9375rem!important;line-height:1.45!important;color:rgba(0,0,0,.6)!important;margin-top:4px!important}:is([data-theme=\"dark\"], .dark) .card [data-component-part=card-content]{color:rgba(255,255,255,.65)!important}.card #card-link-arrow-icon{display:block!important;top:20px!important;right:20px!important;color:rgba(0,0,0,.35)!important;transition:color .2s ease,transform .2s ease!important}.card:hover #card-link-arrow-icon{color:#171717!important;transform:translate(2px,-2px)}:is([data-theme=\"dark\"], .dark) .card #card-link-arrow-icon{color:rgba(255,255,255,.4)!important}:is([data-theme=\"dark\"], .dark) .card:hover #card-link-arrow-icon{color:rgba(255,255,255,.92)!important}.mytruv-cta-row{display:flex;flex-wrap:wrap;gap:12px;margin:20px 0 28px}.mytruv-cta{display:inline-flex;align-items:center;justify-content:center;padding:10px 20px;border-radius:9999px;border:1px solid rgba(0,0,0,.12);background:#fff;color:#171717;font-size:.9375rem;font-weight:500;text-decoration:none;transition:background .15s ease,border-color .15s ease,transform .15s ease}.mytruv-cta:hover{background:rgba(0,0,0,.04);border-color:rgba(0,0,0,.2);transform:translateY(-1px)}.mytruv-cta--primary{background:#2c64e3;border-color:#2c64e3;color:#fff}.mytruv-cta--primary:hover{background:#1a4fcc;border-color:#1a4fcc;color:#fff}:is([data-theme=\"dark\"], .dark) .mytruv-cta{background:rgba(255,255,255,.06);border-color:rgba(255,255,255,.14);color:rgba(255,255,255,.95)}:is([data-theme=\"dark\"], .dark) .mytruv-cta:hover{background:rgba(255,255,255,.1);border-color:rgba(255,255,255,.24)}:is([data-theme=\"dark\"], .dark) .mytruv-cta--primary{background:#4a7ff7;border-color:#4a7ff7;color:#fff}:is([data-theme=\"dark\"], .dark) .mytruv-cta--primary:hover{background:#2c64e3;border-color:#2c64e3}"}],"page":{"pagePath":"api-reference/user/object","slug":"/api-reference/user/object","pageMetadata":{"title":"The User object","description":"Authenticated user's name and contact details.","href":"/api-reference/user/object"},"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: \"Authenticated user’s name and contact details.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The User object represents the Checkr Money user who owns the access token. It carries their name and contact details.`}),`\n`,_jsx(Heading,{level:`2`,id:`attributes`,children:`Attributes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Attribute`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Type`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`first_name`}),_jsx(_components.td,{style:{textAlign:`left`},children:`string`}),_jsx(_components.td,{style:{textAlign:`left`},children:`User’s first name. May be null`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`last_name`}),_jsx(_components.td,{style:{textAlign:`left`},children:`string`}),_jsx(_components.td,{style:{textAlign:`left`},children:`User’s last name. May be null`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`email`}),_jsx(_components.td,{style:{textAlign:`left`},children:`string`}),_jsx(_components.td,{style:{textAlign:`left`},children:`User’s email address. May be null`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`phone`}),_jsx(_components.td,{style:{textAlign:`left`},children:`string`}),_jsx(_components.td,{style:{textAlign:`left`},children:`User’s phone number. May be null`})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/user/get-user`,children:`Get user profile`})}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`example-response`,children:`Example response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"last_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Doe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"jane@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"phone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+1-555-123-4567\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The User object","description":"Authenticated user's name and contact details.","href":"/api-reference/user/object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Attributes","slug":"attributes","depth":2,"children":[]},{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Example response","slug":"example-response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"checkrmoney","siteName":"Checkr Money","title":"The User object - Checkr Money","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T16:33:14.582Z","originalFileLocation":"api-reference/user/object.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Authenticated user\u0026#x27;s name and contact details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Checkr Money\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_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/checkrmoney/u5x_RIFwkOtJudIM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The User object - Checkr Money\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticated user\u0026#x27;s name and contact details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Checkr Money\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.checkrmoney.com/api-reference/user/object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"The User object - Checkr Money\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticated user\u0026#x27;s name and contact details.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/checkrmoney/u5x_RIFwkOtJudIM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Checkr Money\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2C64E3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.checkrmoney.com/api-reference/user/object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/user/object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.checkrmoney.com/#organization\",\"name\":\"Checkr Money\",\"url\":\"https://help.checkrmoney.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/checkrmoney/_HEqG_a_UJ268Pb6/logo-checkr-money-dark.svg?fit=max\u0026auto=format\u0026n=_HEqG_a_UJ268Pb6\u0026q=85\u0026s=a21903c67a2acd7c1f0463abdfeab7f7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.checkrmoney.com#website\",\"name\":\"Checkr Money\",\"url\":\"https://help.checkrmoney.com\",\"publisher\":{\"@id\":\"https://help.checkrmoney.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.checkrmoney.com/api-reference/user/object#webpage\",\"url\":\"https://help.checkrmoney.com/api-reference/user/object\",\"name\":\"The User object\",\"description\":\"Authenticated user's name and contact details.\",\"dateModified\":\"2026-10-16T16:33:14.582Z\",\"isPartOf\":{\"@id\":\"https://help.checkrmoney.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.checkrmoney.com/api-reference/user/object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.checkrmoney.com/api-reference/user/object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkr Money\",\"item\":\"https://help.checkrmoney.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The User object\",\"item\":\"https://help.checkrmoney.com/api-reference/user/object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://help.checkrmoney.com/api-reference/user/object#article\",\"headline\":\"The User object\",\"name\":\"The User object\",\"description\":\"Authenticated user's name and contact details.\",\"url\":\"https://help.checkrmoney.com/api-reference/user/object\",\"mainEntityOfPage\":{\"@id\":\"https://help.checkrmoney.com/api-reference/user/object#webpage\"},\"dateModified\":\"2026-10-16T16:33:14.582Z\",\"publisher\":{\"@id\":\"https://help.checkrmoney.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.checkrmoney.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Checkr Money\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Checkr Money","nav":{"global":{"anchors":[{"anchor":"Sign up for free","icon":"user-plus","href":"https://app.checkrmoney.com"},{"anchor":"Download iOS app","icon":"apple","href":"https://apps.apple.com/us/app/id6757509490"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","groups":[{"group":"Overview","icon":"book","pages":[{"title":"API Overview","description":"Read-only API for accessing your Checkr Money financial data programmatically.","href":"/api-reference/overview"},{"title":"Errors","description":"API error codes and handling guidance","href":"/api-reference/errors"},{"title":"Pagination","description":"How to paginate through large result sets","href":"/api-reference/pagination"}]},{"group":"User","icon":"user","pages":[{"title":"The User object","description":"Authenticated user's name and contact details.","href":"/api-reference/user/object"},{"title":"Get User","openapi":"GET /v1/user","description":"Get the current user's profile.\n\nReturns the authenticated user's profile including name, email, phone,\nand lifecycle status flags (onboarding, bank connection, subscription, trial).\nCreates the user record if it does not yet exist.\n\nPAT (public API) callers receive a trimmed response with only contact fields.","href":"/api-reference/user/get-user"}]},{"group":"Balances","icon":"wallet","pages":[{"title":"The Balances object","description":"Aggregated account balances across all connected financial institutions.","href":"/api-reference/balances/object"},{"title":"Get Balances","openapi":"GET /v2/links/balances","description":"Get aggregated account balances (v2, ClickHouse-backed).\n\nReads from ClickHouse instead of Core API for improved performance.","href":"/api-reference/balances/get-balances"}]},{"group":"Transactions","icon":"receipt","pages":[{"title":"The Transactions object","description":"Bank transaction history from connected financial accounts.","href":"/api-reference/transactions/object"},{"title":"Get Transactions","openapi":"GET /v2/users/transactions","description":"Get bank transactions across all connected accounts (v2, ClickHouse-backed).\n\nReturns transactions within the specified date range from all linked bank accounts.\nReads from ClickHouse instead of Core API for improved performance.\nSupports pagination, category/type/account/amount/merchant filtering, and sorting.\n\nThe ``daily_totals`` array in the response reflects the same active filters.\nWhen ``transaction_type=DEBIT`` is applied, all daily net totals will be negative\n(debits only, no credits to offset them) — this is intentional and arithmetically consistent.","href":"/api-reference/transactions/get-transactions"},{"title":"Get Transaction","openapi":"GET /v2/users/transactions/{transaction_id}","description":"Fetch a single transaction by id, including hidden and deleted rows.\n\nUnlike the list endpoint, this resolves transactions the user has hidden or\ndeleted so the detail page can render a customized row reached by direct\nURL. Scoped to the authenticated applicant; an unknown or cross-tenant id\nreturns 404 and never leaks another user's row.\n\nReturns the same ``BankTransactionsReport`` shape as the list endpoint, with\na single transaction, its owning account (when still connected), and the\nmatching merchant logo.","href":"/api-reference/transactions/get-transaction"},{"title":"Get Transactions Summary","openapi":"GET /v2/users/transactions/summary","description":"Return aggregate statistics for transactions matching the given filters (v2, ClickHouse-backed).\n\nReturns total count, income, spending, net total, average, and the largest overall,\nexpense, and income transactions. Accepts the same filter params as the list endpoint.","href":"/api-reference/transactions/get-transactions-summary"},{"title":"List Transaction Categories","openapi":"GET /v2/users/transactions/categories","description":"List the standard catalog followed by the user's custom categories.","href":"/api-reference/transactions/list-transaction-categories"},{"title":"Export Transactions","openapi":"GET /v2/users/transactions/export","description":"Export transactions as a CSV file (v2, ClickHouse-backed).\n\nReturns up to 10,000 rows matching the given filters. Accepts the same filter\nand sort params as the list endpoint. Response is a downloadable ``text/csv`` file.","href":"/api-reference/transactions/export-transactions"}]},{"group":"Spending","icon":"chart-pie","pages":[{"title":"The Spending Analysis object","description":"Categorized spending breakdown with summary statistics.","href":"/api-reference/spending/object"},{"title":"Get Spending Analysis","openapi":"GET /v2/users/spending","description":"Get spending analysis for the authenticated user (v2, ClickHouse-backed).\n\nReturns categorized spending breakdown with totals. Returns empty lists when no transactions match.\nReads from ClickHouse instead of Core API for improved performance and correctness.\n\n**Double aggregation**: Use ``group_by=time_period`` with ``secondary_group_by=category``\nor ``secondary_group_by=merchant`` to get a breakdown within each time period (top 10 + \"Other\").\n\nThe ``end_date`` is capped at today if it is in the future or omitted.\n\n**Note:** Transactions from ``INVESTMENT``-type accounts (brokerage, crypto, IRA, etc.) are\nalways excluded — stock purchases, short sales, dividend reinvestments, and margin interest\nare not personal spending. Passing an investment ``account_id`` in ``account_ids`` will\ntherefore return empty results for that account.\n\nDEBIT transfers to investment platforms (Wealthfront, Robinhood, Fidelity, Schwab, Vanguard,\nCoinbase, etc.) are also excluded even when the investment account itself is not connected.\nThe matching uses merchant name and description patterns, guarded against known false\npositives (e.g. \"Les Schwab Tires\", \"Fidelity Life Insurance\"). CREDITs from these platforms\n(withdrawals, dividends) are kept — they are real cashflow into the user's spending accounts.","href":"/api-reference/spending/get-spending"}]},{"group":"Income","icon":"money-bill-wave","pages":[{"title":"The Income object","description":"Aggregated income report combining payroll and bank account sources.","href":"/api-reference/income/object"},{"title":"Get Income","openapi":"GET /v1/users/income","description":"Get aggregated income report from all payroll and bank sources.\n\nAggregates income data from all connected payroll providers and bank accounts.\nBank income is converted to the same format as payroll employment records.\nDuplicate income sources (visible from both payroll and bank) are deduplicated\nusing fuzzy name matching, with preference given to payroll data.\n\nEach employment record includes:\n- ``data_source``: ``'payroll'`` or ``'financial_accounts'``\n- ``provider``: data provider name (e.g. ``'adp'``, ``'chase'``)\n- ``company``: employer / income source details, including ``logo_url`` when a company logo is available\n- ``statements``: pay statements filtered to the requested date range\n- ``income``, ``pay_rate``, ``pay_frequency``: compensation details","href":"/api-reference/income/get-income"},{"title":"The Payroll Report object","description":"Full income report for one connected payroll account.","href":"/api-reference/income/payroll-report"},{"title":"Get Payroll Report","openapi":"GET /v1/links/{link_id}/report","description":"Get the income report for a specific payroll link.\n\nReturns the Truv IncomeCheck report for the given link with sensitive fields\n(pdf_report, access_token, bank_accounts, derived_fields) removed.\nValidates that the link belongs to the authenticated user.","href":"/api-reference/income/get-payroll-report"}]},{"group":"Recurring Transactions","icon":"rotate","pages":[{"title":"The Recurring Transactions object","description":"Recurring income deposits and recurring expenses identified across connected accounts.","href":"/api-reference/recurring/object"},{"title":"Get Recurring Transactions","openapi":"GET /v2/users/recurring-transactions","description":"Get recurring transactions (v2, ClickHouse-backed outflows + Core API inflows).\n\nReads outflows from local ClickHouse detection results.\nProxies inflows from Core API (income detection is a separate pipeline).\n\nThe response includes an ``accounts`` list covering every account\nreferenced by an inflow or outflow, so clients can display the source\naccount (name, mask) on each row without an extra lookup. Match each\nitem's ``account_id`` against ``accounts[].id``.\n\nReturns empty lists if no recurring detection data exists yet.","href":"/api-reference/recurring/get-recurring-transactions"}]},{"group":"Balance History","icon":"chart-line","pages":[{"title":"The Balance History object","description":"Historical balance time series showing assets, liabilities, and net worth over time.","href":"/api-reference/balance-history/object"},{"title":"Get Balance History","openapi":"GET /v2/users/balance-history","description":"Get historical balance time series (v2, ClickHouse-backed).\n\nReconstructs asset and liability balances over time using local ClickHouse data,\neliminating the round-trip to the Truv Core API. Returns the same response shape as v1.","href":"/api-reference/balance-history/get-balance-history"}]},{"group":"Liabilities","icon":"credit-card","pages":[{"title":"The Liabilities object","description":"Credit card balances, loan amounts, and other liabilities from connected accounts.","href":"/api-reference/liabilities/object"},{"title":"Get Liabilities","openapi":"GET /v2/links/liabilities","description":"Get aggregated liabilities (v2, ClickHouse-backed).\n\nReads from ClickHouse instead of Core API for improved performance.","href":"/api-reference/liabilities/get-liabilities"}]},{"group":"Credit","icon":"gauge","pages":[{"title":"The Credit Snapshot object","description":"Credit score and credit report for the user's connected credit history.","href":"/api-reference/credit/object"},{"title":"Get Credit Snapshot","openapi":"GET /v1/credit/snapshot","description":"Get the credit report snapshot for the authenticated user.\n\nResolves the user's connected credit link and returns the latest credit\nsnapshot, with the full credit profile in ``payload``. Returns 404 if the\nuser has no credit link.","href":"/api-reference/credit/get-credit-snapshot"},{"title":"List Credit Snapshots","openapi":"GET /v1/credit/snapshots","description":"List the authenticated user's stored credit snapshots, newest first.\n\nEach item carries the full credit profile payload. Follow ``next`` until it\nis null; a user with no snapshots gets an empty list.","href":"/api-reference/credit/list-credit-snapshots"}]},{"group":"Account Links","icon":"link","pages":[{"title":"The Links object","description":"Connected financial institutions and payroll providers.","href":"/api-reference/links/object"},{"title":"Get Links","openapi":"GET /v1/links","description":"List all connected account links.\n\nReturns all financial institution and payroll links for the authenticated user.\nSupports optional filtering by link status and data source type.\n\nstatus reflects the last stable status, so a refresh in flight does not flip a\nlink out of its last committed status; is_refreshing flags links currently\nrefreshing.","href":"/api-reference/links/get-links"}]}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/changelog"}]}]},"title":"The User object - Checkr Money","buildId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","deploymentId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","dynamics":[],"chunks":[]}