# DebtWise

> The DebtWise API suite is the primary means for developers to offer debt management tools within their existing applications.

- [Welcome to the DebtWise API](https://docs.debt-wise.com/index.md): Guides, resources, and references to build apps with DebtWise.
- [🔌 Getting Started](https://docs.debt-wise.com/guides/getting-started.md): Learn how to make your first API requests using the DebtWise API.
- [🤝 Equifax Authentication](https://docs.debt-wise.com/guides/equifax-authentication.md): Implement the Equifax identity verification and authentication flow, then retrieve a user's credit report.
- [Introduction](https://docs.debt-wise.com/api-reference/introduction.md): How the DebtWise API is structured and which environments are available.
- [Authentication](https://docs.debt-wise.com/api-reference/authentication.md): Authenticate every DebtWise API request with a bearer token.
- [Errors](https://docs.debt-wise.com/api-reference/errors.md): HTTP status codes returned by the DebtWise API and the shape of the error object.
- [Trace ID](https://docs.debt-wise.com/api-reference/trace-id.md): Correlate requests with the X-TRACE-ID header.
- [Versioning](https://docs.debt-wise.com/api-reference/versioning.md): How DebtWise API versions work and what counts as a backward-compatible change.
- [Compression](https://docs.debt-wise.com/api-reference/compression.md): Request gzip-compressed responses.
- [Retrieve All Users](https://docs.debt-wise.com/api-reference/users/retrieve-all-users.md): Retrieve all company users
- [Create User](https://docs.debt-wise.com/api-reference/users/create-user.md): Create a user from given parameters
- [Retrieve User](https://docs.debt-wise.com/api-reference/users/retrieve-user.md): Retrieve user by id
- [Update User](https://docs.debt-wise.com/api-reference/users/update-user.md): Update user by id
- [Delete User](https://docs.debt-wise.com/api-reference/users/delete-user.md): Delete user by id
- [Accounts](https://docs.debt-wise.com/api-reference/accounts/accounts.md): Retrieve all of a user's accounts
- [Retrieve Account](https://docs.debt-wise.com/api-reference/accounts/retrieve-account.md): Retrieve information about a single account
- [Update Account](https://docs.debt-wise.com/api-reference/accounts/update-account.md): Update information about a single account
- [Credit Score Factors](https://docs.debt-wise.com/api-reference/credit-scores/credit-score-factors.md): Retrieve a user's credit score and how various factors are impacting it
- [Invoke](https://docs.debt-wise.com/api-reference/equifax/invoke.md): Start Equifax Authentication for the user
- [Validate OTP](https://docs.debt-wise.com/api-reference/equifax/validate-otp.md): Validate the user with a OTP which the user receives on their mobile device.
- [Consent](https://docs.debt-wise.com/api-reference/equifax/consent.md): User agrees and consents to pull credit report
- [Identity](https://docs.debt-wise.com/api-reference/equifax/identity.md): Returns user's identity to validate all information.
- [Abort](https://docs.debt-wise.com/api-reference/equifax/abort.md): Rollback auth flow to initial state for the user.
- [DIT](https://docs.debt-wise.com/api-reference/equifax/dit.md): DIT - is a digital identity trust flow. It is required for use in 2 cases: 1. When standard flow returns an error and cannot be finished. 2. When user mark some of the data as invalid after receiving the Identity response.
- [Credit Report](https://docs.debt-wise.com/api-reference/equifax/credit-report.md): Pull credit report for valid Identity
- [Payoff Plan Calculation](https://docs.debt-wise.com/api-reference/debt-payoff-plan/payoff-plan-calculation.md): Calculate payments for payment plan based extra payment amount
- [Payment Plans](https://docs.debt-wise.com/api-reference/debt-payoff-plan/payment-plans.md): Retrieve a user's payment plan
- [Create Payment Plan](https://docs.debt-wise.com/api-reference/debt-payoff-plan/create-payment-plan.md): Create a new payment plan
- [Update Payment Plan](https://docs.debt-wise.com/api-reference/debt-payoff-plan/update-payment-plan.md): Returns an updated payment plan
- [Delete Payment Plan](https://docs.debt-wise.com/api-reference/debt-payoff-plan/delete-payment-plan.md): Delete a user's payment plan
- [Retrieve Payment Plan Payments](https://docs.debt-wise.com/api-reference/debt-payoff-plan-payments/retrieve-payment-plan-payments.md): Retrieve users's payment plan payments
- [Update Payment Plan Payments](https://docs.debt-wise.com/api-reference/debt-payoff-plan-payments/update-payment-plan-payments.md): Update a payment plan payment's status
- [Debt Calculator](https://docs.debt-wise.com/api-reference/debt-calculator/debt-calculator.md): Calculate debt-free date when additional payments are made towards a loan.
- [Get Learning Modules](https://docs.debt-wise.com/api-reference/learning-modules/get-learning-modules.md): Retrieve a list of learning modules, optionally filtered by category.
- [User](https://docs.debt-wise.com/api-reference/schemas/user.md)
- [CreditScore](https://docs.debt-wise.com/api-reference/schemas/credit-score.md)
- [PaymentHistory](https://docs.debt-wise.com/api-reference/schemas/payment-history.md)
- [CreditUtilization](https://docs.debt-wise.com/api-reference/schemas/credit-utilization.md)
- [DerogatoryMarks](https://docs.debt-wise.com/api-reference/schemas/derogatory-marks.md)
- [CreditAge](https://docs.debt-wise.com/api-reference/schemas/credit-age.md)
- [CreditMix](https://docs.debt-wise.com/api-reference/schemas/credit-mix.md)
- [NewCredit](https://docs.debt-wise.com/api-reference/schemas/new-credit.md)
- [EquifaxStep](https://docs.debt-wise.com/api-reference/schemas/equifax-step.md)
- [EquifaxIdentity](https://docs.debt-wise.com/api-reference/schemas/equifax-identity.md)
- [EquifaxAddress](https://docs.debt-wise.com/api-reference/schemas/equifax-address.md)
- [Account](https://docs.debt-wise.com/api-reference/schemas/account.md)
- [PaymentPlan](https://docs.debt-wise.com/api-reference/schemas/payment-plan.md)
- [PaymentPlanPayment](https://docs.debt-wise.com/api-reference/schemas/payment-plan-payment.md)
- [PreCalculatePayments](https://docs.debt-wise.com/api-reference/schemas/pre-calculate-payments.md)
- [Article](https://docs.debt-wise.com/api-reference/schemas/article.md)
- [LearningModule](https://docs.debt-wise.com/api-reference/schemas/learning-module.md)
- [LoanCalculation](https://docs.debt-wise.com/api-reference/schemas/loan-calculation.md)
- [InternalServerError](https://docs.debt-wise.com/api-reference/schemas/internal-server-error.md)

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)