How the DebtWise API is structured and which environments are available.
The DebtWise API suite is the primary means for developers to offer debt management tools within their existing applications.The DebtWise API follows REST architecture, with most operations performed via GET, POST, PATCH, and DELETE requests. All requests must include a Content-Type of application/json and the body must be a valid JSON. Communication is served over HTTPS TLS v1.2+ to ensure data privacy.
Environments
There are two environments to work with the DebtWise API: Sandbox and Production. The Sandbox environment is unrestricted and uses test data. All testing should be done in the Sandbox environment. When you are ready to launch into Production, reach out our support team to request Production environment access.
Environment
Base URL
Sandbox (test data)
https://staging.debt-wise.com
Production (live data)
https://app.debt-wise.com
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DebtWise","description":"The DebtWise API suite is the primary means for developers to offer debt management tools within their existing applications.","colors":{"primary":"#ffa88b","light":"#ffc7b3","dark":"#e0764f"},"favicon":"https://mintcdn.com/debt-wise/d5fuLwwFfRt0Np1t/favicon.png?fit=max\u0026auto=format\u0026n=d5fuLwwFfRt0Np1t\u0026q=85\u0026s=c7ab339192363819178f6608e01ae4ce","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"mailto:support@debt-wise.com","label":"Support"}],"primary":{"type":"button","label":"debt-wise.com","href":"https://debt-wise.com"}},"footer":{"socials":{"website":"https://debt-wise.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"debt-wise","hasAudioNarration":false,"actualSubdomain":"debt-wise","customDomains":["docs.debt-wise.com"],"gitSource":{"type":"github","owner":"habitualmoney","repo":"debt-wise-server","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ab4477c4ded1b207f4c0565","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":50},{"language":"default","tag":"Schemas","count":19},{"language":"default","tag":"Equifax","count":7},{"language":"default","tag":"Overview","count":6},{"language":"default","tag":"Debt Payoff Plan","count":5},{"language":"default","tag":"Users","count":5},{"language":"default","tag":"Accounts","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Debt Payoff Plan Payments","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"How the DebtWise API is structured and which environments are available.","href":"/api-reference/introduction"},"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: \"How the DebtWise API is structured and which environments are available.\"\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={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The DebtWise API suite is the primary means for developers to offer debt management tools within their existing applications.`}),`\n`,_jsxs(_components.p,{children:[`The DebtWise API follows REST architecture, with most operations performed via `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, and `,_jsx(_components.code,{children:`DELETE`}),` requests. All requests must include a `,_jsx(_components.code,{children:`Content-Type`}),` of `,_jsx(_components.code,{children:`application/json`}),` and the body must be a valid JSON. Communication is served over HTTPS TLS v1.2+ to ensure data privacy.`]}),`\n`,_jsx(Heading,{level:`2`,id:`environments`,children:`Environments`}),`\n`,_jsx(_components.p,{children:`There are two environments to work with the DebtWise API: Sandbox and Production. The Sandbox environment is unrestricted and uses test data. All testing should be done in the Sandbox environment. When you are ready to launch into Production, reach out our support team to request Production environment access.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Environment`}),_jsx(_components.th,{children:`Base URL`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Sandbox (test data)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://staging.debt-wise.com`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Production (live data)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://app.debt-wise.com`})})]})]})]})]})}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":"Introduction","description":"How the DebtWise API is structured and which environments are available.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Environments","slug":"environments","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"debt-wise","siteName":"DebtWise","title":"Introduction - DebtWise","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-01T16:25:23.224Z","originalFileLocation":"api-reference/introduction.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=\"How the DebtWise API is structured and which environments are available.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DebtWise\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_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/debt-wise/fP_BwRCx8AXneeHY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - DebtWise\">\u003cmeta data-mint-head property=\"og:description\" content=\"How the DebtWise API is structured and which environments are available.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DebtWise\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.debt-wise.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debt-wise.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Introduction\u0026amp;description=How+the+DebtWise+API+is+structured+and+which+environments+are+available.\u0026amp;theme=75b3db34d9422d184778b1f2\u0026amp;signature=bfd627e0ad6c26b5b49fad997198559dbc7ca46e73faccabc56bd2f725fab03a\">\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=\"Introduction - DebtWise\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How the DebtWise API is structured and which environments are available.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debt-wise.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Introduction\u0026amp;description=How+the+DebtWise+API+is+structured+and+which+environments+are+available.\u0026amp;theme=75b3db34d9422d184778b1f2\u0026amp;signature=bfd627e0ad6c26b5b49fad997198559dbc7ca46e73faccabc56bd2f725fab03a\">\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/debt-wise/fP_BwRCx8AXneeHY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DebtWise\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ffa88b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.debt-wise.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.debt-wise.com/#organization\",\"name\":\"DebtWise\",\"url\":\"https://docs.debt-wise.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.debt-wise.com#website\",\"name\":\"DebtWise\",\"url\":\"https://docs.debt-wise.com\",\"publisher\":{\"@id\":\"https://docs.debt-wise.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.debt-wise.com/api-reference/introduction#webpage\",\"url\":\"https://docs.debt-wise.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"How the DebtWise API is structured and which environments are available.\",\"dateModified\":\"2026-09-01T16:25:23.224Z\",\"isPartOf\":{\"@id\":\"https://docs.debt-wise.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.debt-wise.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.debt-wise.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"DebtWise\",\"item\":\"https://docs.debt-wise.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.debt-wise.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.debt-wise.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"How the DebtWise API is structured and which environments are available.\",\"url\":\"https://docs.debt-wise.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.debt-wise.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-09-01T16:25:23.224Z\",\"publisher\":{\"@id\":\"https://docs.debt-wise.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.debt-wise.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DebtWise\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"DebtWise\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/introduction.md","siteName":"DebtWise","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","description":"Authenticate every DebtWise API request with a bearer token.","openapi":"api-reference/openapi.yaml POST /api/ping","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Trace ID","href":"/api-reference/trace-id"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"Compression","href":"/api-reference/compression"}]},{"group":"Users","pages":[{"title":"Retrieve All Users","openapi":"api-reference/openapi.yaml GET /api/users","href":"/api-reference/users/retrieve-all-users"},{"title":"Create User","openapi":"api-reference/openapi.yaml POST /api/users","href":"/api-reference/users/create-user"},{"title":"Retrieve User","openapi":"api-reference/openapi.yaml GET /api/users/{id}","href":"/api-reference/users/retrieve-user"},{"title":"Update User","openapi":"api-reference/openapi.yaml PATCH /api/users/{id}","href":"/api-reference/users/update-user"},{"title":"Delete User","openapi":"api-reference/openapi.yaml DELETE /api/users/{id}","href":"/api-reference/users/delete-user"}]},{"group":"Accounts","pages":[{"title":"Accounts","openapi":"api-reference/openapi.yaml GET /api/users/{id}/accounts","href":"/api-reference/accounts/accounts"},{"title":"Retrieve Account","openapi":"api-reference/openapi.yaml GET /api/users/{id}/accounts/{account_id}","href":"/api-reference/accounts/retrieve-account"},{"title":"Update Account","openapi":"api-reference/openapi.yaml PATCH /api/users/{id}/accounts/{account_id}","href":"/api-reference/accounts/update-account"}]},{"group":"Credit Scores","pages":[{"title":"Credit Score Factors","openapi":"api-reference/openapi.yaml GET /api/users/{id}/credit_scores","href":"/api-reference/credit-scores/credit-score-factors"}]},{"group":"Equifax","pages":[{"title":"Invoke","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/invoke","href":"/api-reference/equifax/invoke"},{"title":"Validate OTP","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/validate_otp","href":"/api-reference/equifax/validate-otp"},{"title":"Consent","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/consent","href":"/api-reference/equifax/consent"},{"title":"Identity","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/identity","href":"/api-reference/equifax/identity"},{"title":"Abort","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/abort","href":"/api-reference/equifax/abort"},{"title":"DIT","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/dit","href":"/api-reference/equifax/dit"},{"title":"Credit Report","openapi":"api-reference/openapi.yaml POST /api/users/{id}/equifax/credit_reports","href":"/api-reference/equifax/credit-report"}]},{"group":"Debt Payoff Plan","pages":[{"title":"Payoff Plan Calculation","openapi":"api-reference/openapi.yaml POST /api/users/{id}/payment_plans/pre_calculate_payments","href":"/api-reference/debt-payoff-plan/payoff-plan-calculation"},{"title":"Payment Plans","openapi":"api-reference/openapi.yaml GET /api/users/{id}/payment_plans","href":"/api-reference/debt-payoff-plan/payment-plans"},{"title":"Create Payment Plan","openapi":"api-reference/openapi.yaml POST /api/users/{id}/payment_plans","href":"/api-reference/debt-payoff-plan/create-payment-plan"},{"title":"Update Payment Plan","openapi":"api-reference/openapi.yaml PATCH /api/users/{id}/payment_plans/{payment_plan_id}","href":"/api-reference/debt-payoff-plan/update-payment-plan"},{"title":"Delete Payment Plan","openapi":"api-reference/openapi.yaml DELETE /api/users/{id}/payment_plans/{payment_plan_id}","href":"/api-reference/debt-payoff-plan/delete-payment-plan"}]},{"group":"Debt Payoff Plan Payments","pages":[{"title":"Retrieve Payment Plan Payments","openapi":"api-reference/openapi.yaml GET /api/users/{id}/payment_plans/{payment_plan_id}/payments","href":"/api-reference/debt-payoff-plan-payments/retrieve-payment-plan-payments"},{"title":"Update Payment Plan Payments","openapi":"api-reference/openapi.yaml PATCH /api/users/{id}/payment_plans/{payment_plan_id}/payments/{payment_id}","href":"/api-reference/debt-payoff-plan-payments/update-payment-plan-payments"}]},{"group":"Debt Calculator","pages":[{"title":"Debt Calculator","openapi":"api-reference/openapi.yaml POST /api/loan_calculators","href":"/api-reference/debt-calculator/debt-calculator"}]},{"group":"Learning Modules","pages":[{"title":"Get Learning Modules","openapi":"api-reference/openapi.yaml GET /api/learning_modules","href":"/api-reference/learning-modules/get-learning-modules"}]},{"group":"Schemas","pages":[{"title":"User","href":"/api-reference/schemas/user"},{"title":"CreditScore","href":"/api-reference/schemas/credit-score"},{"title":"PaymentHistory","href":"/api-reference/schemas/payment-history"},{"title":"CreditUtilization","href":"/api-reference/schemas/credit-utilization"},{"title":"DerogatoryMarks","href":"/api-reference/schemas/derogatory-marks"},{"title":"CreditAge","href":"/api-reference/schemas/credit-age"},{"title":"CreditMix","href":"/api-reference/schemas/credit-mix"},{"title":"NewCredit","href":"/api-reference/schemas/new-credit"},{"title":"EquifaxStep","href":"/api-reference/schemas/equifax-step"},{"title":"EquifaxIdentity","href":"/api-reference/schemas/equifax-identity"},{"title":"EquifaxAddress","href":"/api-reference/schemas/equifax-address"},{"title":"Account","href":"/api-reference/schemas/account"},{"title":"PaymentPlan","href":"/api-reference/schemas/payment-plan"},{"title":"PaymentPlanPayment","href":"/api-reference/schemas/payment-plan-payment"},{"title":"PreCalculatePayments","href":"/api-reference/schemas/pre-calculate-payments"},{"title":"Article","href":"/api-reference/schemas/article"},{"title":"LearningModule","href":"/api-reference/schemas/learning-module"},{"title":"LoanCalculation","href":"/api-reference/schemas/loan-calculation"},{"title":"InternalServerError","href":"/api-reference/schemas/internal-server-error"}]}]}]},"basePath":"","title":"Introduction - DebtWise","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}