> ## Documentation Index
> Fetch the complete documentation index at: https://docs.debt-wise.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

> Authenticate every DebtWise API request with a bearer token.

Every HTTP request made to the DebtWise API must be authenticated. You need to use an API key to authenticate requests. To obtain and manage your API keys, visit the dashboard in the corresponding environment.

Authentication to the API is performed via bearer: `-H "Authorization: Bearer ${TOKEN}"`

## Try it out

Use the interactive playground below to send a real `POST /api/ping` request with your token and confirm your credentials are working.


## OpenAPI

````yaml api-reference/openapi.yaml POST /api/ping
openapi: 3.0.1
info:
  title: DebtWise API
  version: '2024-07-01'
  description: >-
    The DebtWise API suite is the primary means for developers to offer debt
    management tools within their existing applications.
  contact:
    name: DebtWise Support
    url: https://debt-wise.com
    email: support@debt-wise.com
servers:
  - url: https://staging.debt-wise.com
    description: Sandbox server (uses test data)
  - url: https://app.debt-wise.com
    description: Production server (uses live data)
security:
  - bearerAuth: []
tags:
  - name: Ping
  - name: Users
  - name: Accounts
  - name: Credit Scores
  - name: Equifax
  - name: Debt Payoff Plan
  - name: Debt Payoff Plan Payments
  - name: Articles
  - name: Debt Calculator
paths:
  /api/ping:
    parameters:
      - $ref: '#/components/parameters/apiVersionParam'
    post:
      tags:
        - Ping
      summary: Ping
      description: >-
        Verify your credentials and connectivity to the DebtWise API. Returns
        the payload you send.
      operationId: ping
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - payload
              properties:
                payload:
                  type: string
                  example: Ping
      responses:
        '200':
          description: Ping successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    type: string
                    example: Ping
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: eea717bf-6fc0-488e-8f0a-babf7c8a21b0
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
components:
  parameters:
    apiVersionParam:
      name: API-Version
      in: header
      description: API API Version. See Versioning page for more details.
      required: false
      schema:
        type: string
        example: '2024-07-01'
  schemas:
    InternalServerError:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: internal_server_error
              description: An identifier of an error type inside API.
            message:
              type: string
              example: >-
                We've notified our engineers and hope to address this issue
                shortly.
              description: A human-readable error description.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````