> ## 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.

# Identity

> Returns user's identity to validate all information.



## OpenAPI

````yaml api-reference/openapi.yaml POST /api/users/{id}/equifax/auth/identity
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/users/{id}/equifax/auth/identity:
    parameters:
      - $ref: '#/components/parameters/userIdParam'
      - $ref: '#/components/parameters/acceptEncodingParam'
      - $ref: '#/components/parameters/apiVersionParam'
    post:
      tags:
        - Equifax
      summary: Identity
      description: Returns user's identity to validate all information.
      operationId: EquifaxAuthIdentity
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - postal_code
              properties:
                postal_code:
                  type: string
                  example: '03023'
                  minLength: 4
                  description: User's postal code
                date_of_birth:
                  type: string
                  example: '1993-03-03'
                  description: >-
                    User's date of birth. Optional. Can be sent if it differs
                    from the one specified during creation.
            examples:
              Success:
                summary: Identity
                value:
                  postal_code: '30030'
              Failure:
                summary: Identity
                value:
                  postal_code: '30030'
                  date_of_birth: '2031-06-01'
        required: true
      responses:
        '200':
          description: Returns Identity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquifaxIdentity'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: validation_error
                        description: An identifier of an error type inside API.
                      message:
                        type: string
                        example: Date of Birth is invalid
                        description: A human-readable error description.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
components:
  parameters:
    userIdParam:
      name: id
      in: path
      schema:
        type: integer
        example: 1
      description: An userId.
      required: true
    acceptEncodingParam:
      name: Accept-Encoding
      in: header
      description: We can compress a response with gzip.
      required: false
      schema:
        type: string
        example: gzip deflate
    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:
    EquifaxIdentity:
      type: object
      required:
        - equifax_id
        - first_name
        - last_name
        - date_of_birth
        - email
        - mobile_phone
      properties:
        equifax_id:
          type: string
          example: '6308009234534'
          description: Equifax internal ID of the user identity
        first_name:
          type: string
          example: John
          description: Equifax user's first name
        last_name:
          type: string
          example: Smith
          description: Equifax user's last name
        masked_ssn:
          type: string
          example: '***-**-0909'
          description: Equifax user's masked SSN. Only last 4 digits are provided.
        date_of_birth:
          type: string
          example: '1990-10-10'
          description: Equifax user's date of birth in /Month/Day/Year format
        email:
          type: string
          example: john_smith@email.com
          description: Equifax user's email
        mobile_phone:
          type: string
          example: '990909000'
          description: Equifax user's mobile phone
        home_phone:
          type: string
          example: '990909000'
          description: Equifax user's home phone
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/EquifaxAddress'
    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.
    EquifaxAddress:
      type: object
      properties:
        type:
          type: string
          example: CURRENT
          description: Equifax user's address type
        address_line:
          type: string
          example: 3 Avenue
          description: Equifax user's address line
        city:
          type: string
          example: New York
          description: Equifax user's city
        state:
          type: string
          example: NY
          description: Equifax user's state
        postal_code:
          type: string
          example: '30030'
          description: Equifax user's postal code
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````