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

# User

> Returns the authenticated user.



## OpenAPI

````yaml GET /v1/user
openapi: 3.1.0
info:
  title: urlDNA API
  description: >-
    urlDNA API documentation. This API allows you to scan, analyze, and retrieve
    insights about URLs, helping to detect potential threats such as phishing,
    malware, and scams.
  version: 1.0.0
servers:
  - url: https://api.urldna.io
security: []
paths:
  /v1/user:
    get:
      tags:
        - User Account
      summary: Get user
      description: Returns the authenticated user.
      operationId: get_usage_v1_user_get
      parameters:
        - name: authorization
          in: header
          required: true
          schema:
            type: string
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: 'Unauthorized: API Key is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '405':
          description: >-
            Method Not Allowed: The requested HTTP method is not supported for
            this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: 'Too Many Requests: Rate limit exceeded.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '500':
          description: 'Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
components:
  schemas:
    User:
      properties:
        id:
          type: string
          title: Id
          description: User ID.
        email:
          type: string
          title: Email
          description: Primary email address associated with the account.
        email_verified:
          type: boolean
          title: Email Verified
          description: Indicates if the user has confirmed their email address.
        create_date:
          type: string
          format: date-time
          title: Create Date
          description: ISO 8601 timestamp of when the account was created.
        last_update_date:
          type: string
          format: date-time
          title: Last Update Date
          description: ISO 8601 timestamp of the last profile modification.
        submitter_tags:
          items:
            type: string
          type: array
          title: Submitter Tags
          description: Global tags automatically appended to all scans by this user.
        subscription_type:
          $ref: '#/components/schemas/SubscriptionType'
          description: The current billing tier of the user (FREE or PREMIUM).
        monitored_brand_ids:
          items:
            type: string
          type: array
          title: Monitored Brand Ids
          description: >-
            List of internal brand IDs the user is currently monitoring for
            phishing.
      type: object
      required:
        - id
        - email
        - email_verified
        - create_date
        - last_update_date
        - subscription_type
      title: User
    APIError:
      properties:
        detail:
          type: string
          title: Detail
          example: Error description message
      type: object
      required:
        - detail
      title: APIError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SubscriptionType:
      type: string
      enum:
        - FREE
        - PREMIUM
      title: SubscriptionType
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````