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

# Retrieve a user

> Retrieves a user by ID. Returns the user record with status, display name, and metadata. Personal data is stored encrypted or as fingerprints and is not returned in the response.



## OpenAPI

````yaml /api-reference/v1/openapi.json get /v1/user/{user_id}
openapi: 3.0.0
info:
  title: Palm Partner API
  description: >-
    The Palm API is identity verification and compliance infrastructure for US
    businesses: onboard businesses, verify businesses and people (KYB/KYC)
    against authoritative sources, monitor them for changes in real time, and
    act on their behalf through filings, formation, and registered agent
    services.
  version: '1.0'
  contact:
    name: Palm Support
    url: https://getpalm.com
    email: support@getpalm.com
  termsOfService: https://getpalm.com/terms
  license:
    name: Proprietary
    url: https://getpalm.com/license
servers:
  - url: https://api.getpalm.com
    description: Production
security: []
tags:
  - name: Registry
    description: Search business registries
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
  - name: Business
    description: Business entity management
  - name: User
    description: User identity management
paths:
  /v1/user/{user_id}:
    get:
      tags:
        - User
      summary: Retrieve a user
      description: >-
        Retrieves a user by ID. Returns the user record with status, display
        name, and metadata. Personal data is stored encrypted or as fingerprints
        and is not returned in the response.
      operationId: getUser
      parameters:
        - name: user_id
          required: true
          in: path
          description: User ID
          schema:
            example: palm_usr_1a2b3c4d5e6f7g8h
            type: string
      responses:
        '200':
          description: User retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Rate Limited
        '500':
          description: Server Error
      security:
        - ApiKey: []
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        object:
          type: string
          description: Object type identifier, always "user"
          example: user
          enum:
            - user
        mode:
          type: string
          description: >-
            Whether this resource was created with test or live credentials.
            Test and live data are fully isolated — a test resource never
            appears in live results and vice versa.
          enum:
            - test
            - live
          example: live
        created_at:
          type: string
          description: ISO 8601 timestamp of when the resource was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the resource was last updated
          format: date-time
          example: '2025-10-24T15:45:00Z'
        metadata:
          type: object
          description: >-
            Store up to 50 custom key-value pairs for application-specific data.
            Useful for storing references to external systems, feature flags, or
            other custom attributes.
          additionalProperties:
            type: string
          example:
            external_id: user_123_in_my_system
            customer_tier: premium
            signup_source: mobile_app
        status:
          type: string
          description: Current status of the user
          enum:
            - active
            - suspended
            - deleted
          example: active
        verification:
          description: >-
            Most recent verification information. Null if user has never been
            verified.
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/UserVerification'
        display_name:
          type: string
          description: Display name for the user
          nullable: true
          example: John Doe
        email_fingerprint:
          type: string
          description: >-
            SHA-256 fingerprint of the user's email address. Used for duplicate
            detection and search without exposing the actual email.
            Automatically generated when email is stored in vault.
          nullable: true
          example: f7c3bc1d808e04732adf679965ccc34ca7ae3441
        phone_fingerprint:
          type: string
          description: >-
            SHA-256 fingerprint of the user's phone number. Used for duplicate
            detection and search without exposing the actual phone.
            Automatically generated when phone is stored in vault.
          nullable: true
          example: a8d4bc2e919f15843beg890076ddd45db8bf4552
        vault:
          type: object
          description: >-
            Cached vault field values for non-encrypted fields. Keys are full
            field IDs (e.g., "identity.first_name"). Only includes fields where
            encrypted=false in vault_field_definition.
          additionalProperties: true
          nullable: true
          example:
            identity.first_name: John
            identity.last_name: Doe
      required:
        - id
        - object
        - mode
        - created_at
        - updated_at
        - metadata
        - status
        - verification
        - display_name
        - email_fingerprint
        - phone_fingerprint
        - vault
    UserVerification:
      type: object
      properties:
        id:
          type: string
          description: ID of the verification attempt
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        risk_level:
          type: string
          description: Risk level determined by the verification
          enum:
            - low
            - medium
            - high
            - critical
          example: low
        workflow:
          description: Workflow used for this verification
          allOf:
            - $ref: '#/components/schemas/UserVerificationWorkflow'
        executed_at:
          type: string
          description: Timestamp when the verification was executed
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
      required:
        - id
        - risk_level
        - workflow
        - executed_at
    UserVerificationWorkflow:
      type: object
      properties:
        name:
          type: string
          description: Name of the workflow
          example: KYC Verification
        version:
          type: number
          description: Version of the workflow
          example: 1
      required:
        - name
        - version
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````