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

# Update a user's details

> Sets or changes a user's personal details, such as their name, date of birth, SSN, email, phone and address. Send only the fields to change: fields left out stay as they are, and a field set to `null` is removed. Details are stored encrypted, and the response lists which fields are set, never their values. To verify a user against corrected details, update them here first, then verify the user.



## OpenAPI

````yaml /api-reference/v1/openapi.json patch /v1/user/{user_id}/vault
openapi: 3.1.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: Business
    description: Manage the businesses in your portfolio
  - name: User
    description: Manage the people in your portfolio
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
  - name: Filing
    description: Form a business, apply for an EIN, and register in additional states
  - name: Case
    description: Answer a request for information that a filing is waiting on
  - name: Registered Agent
    description: Registered agent service for a business
  - name: Documents
    description: Retrieve and download any document held for a business or a person
  - name: Webhooks
    description: Events Palm delivers to your webhook endpoints
paths:
  /v1/user/{user_id}/vault:
    patch:
      tags:
        - User
      summary: Update a user's details
      description: >-
        Sets or changes a user's personal details, such as their name, date of
        birth, SSN, email, phone and address. Send only the fields to change:
        fields left out stay as they are, and a field set to `null` is removed.
        Details are stored encrypted, and the response lists which fields are
        set, never their values. To verify a user against corrected details,
        update them here first, then verify the user.
      operationId: updateUserVault
      parameters:
        - name: user_id
          required: true
          in: path
          description: User ID
          schema:
            format: uuid
            example: 123e4567-e89b-12d3-a456-426614174000
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserVaultFields'
      responses:
        '200':
          description: The fields now set for the user
          content:
            application/json:
              schema:
                type: object
                description: Every field now set, each mapped to `true`.
                additionalProperties:
                  type: boolean
                example:
                  identity.first_name: true
                  identity.last_name: true
                  identity.date_of_birth: true
                  identity.ssn: true
        '404':
          description: User not found
      security:
        - ApiKey: []
components:
  schemas:
    UserVaultFields:
      type: object
      properties:
        identity.first_name:
          type: string
          description: Legal first name
          example: John
        identity.middle_name:
          type: string
          description: Middle name or initial
          example: William
        identity.last_name:
          type: string
          description: Legal last name
          example: Doe
        identity.date_of_birth:
          type: string
          description: Date of birth in YYYY-MM-DD format
          example: '1990-01-15'
        identity.email:
          type: string
          description: Primary email address
          example: john.doe@example.com
        identity.phone_number:
          type: string
          description: Phone number (E.164 format recommended)
          example: '+15551234567'
        identity.ssn:
          type: string
          description: 'Social Security Number (format: XXX-XX-XXXX or 9 digits)'
          example: 123-45-6789
        identity.passport_number:
          type: string
          description: Passport number
          example: '123456789'
        identity.drivers_license:
          type: string
          description: Driver's license number
          example: D1234567
        identity.address_line_1:
          type: string
          description: Street address line 1
          example: 123 Main Street
        identity.address_line_2:
          type: string
          description: Street address line 2 (apt, suite, etc.)
          example: Apt 4B
        identity.city:
          type: string
          description: City
          example: San Francisco
        identity.region:
          type: string
          description: State, province, or region code
          example: CA
        identity.postal_code:
          type: string
          description: Postal or ZIP code
          example: '94102'
        identity.country:
          type: string
          description: Country (ISO 3166-1 alpha-2 code)
          example: US
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.