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

# Verify existing user



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/user/{user_id}/verification
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}/verification:
    post:
      tags:
        - User
      summary: Verify existing user
      operationId: verifyExistingUser
      parameters:
        - name: user_id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReverificationRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserVerificationResponse'
      security:
        - ApiKey: []
components:
  schemas:
    ReverificationRequest:
      type: object
      properties:
        workflow_key:
          type: string
          description: >-
            Workflow key to use for verification. If not provided, uses
            organization default.
          example: business_verification_default
        reference_id:
          type: string
          description: Your reference ID for tracking this verification
          example: reverify_12345
        metadata:
          type: object
          description: Additional metadata to attach to this verification
          example:
            reason: annual_review
    UserVerificationResponse:
      type: object
      properties:
        user_id:
          type: string
          description: ID of the user entity created or verified
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        verification_id:
          type: string
          description: Unique verification ID
          format: uuid
          example: 660f9511-f30c-52e5-b827-557766551111
        reference_id:
          type: string
          description: Your reference ID (if provided in request)
          example: user_12345
        status:
          type: string
          description: Current status of the verification
          enum:
            - pending
            - in_progress
            - completed
            - failed
          example: completed
        mode:
          type: string
          enum:
            - test
            - live
          example: live
          description: >-
            Test/live partition the verification was created under. Determined
            by the API key used.
        risk:
          description: Risk assessment with level and detailed reasons
          allOf:
            - $ref: '#/components/schemas/UserVerificationRisk'
        match:
          description: >-
            Field-level match results (only fields included in verification
            request)
          allOf:
            - $ref: '#/components/schemas/UserVerificationMatch'
        synthetic:
          description: Synthetic identity detection results
          allOf:
            - $ref: '#/components/schemas/Synthetic'
        velocity:
          description: >-
            Velocity checks showing frequency of identity attributes across
            recent requests
          allOf:
            - $ref: '#/components/schemas/Velocity'
        device:
          description: Device intelligence (available for session-based verifications)
          allOf:
            - $ref: '#/components/schemas/Device'
        watchlist:
          description: Watchlist screening results (sanctions, PEP, adverse media)
          allOf:
            - $ref: '#/components/schemas/Watchlist'
        created_at:
          type: string
          description: ISO 8601 timestamp of when the verification was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the verification was last updated
          format: date-time
          example: '2025-10-24T10:35:00Z'
      required:
        - user_id
        - verification_id
        - status
        - mode
        - risk
        - match
        - created_at
    UserVerificationRisk:
      type: object
      properties:
        level:
          type: string
          description: Overall risk assessment level
          enum:
            - low
            - medium
            - high
            - critical
          example: low
        reasons:
          description: Risk reasons and signals detected during verification
          example:
            - SSN first seen recently in bureau data
            - Address mismatch detected
            - High velocity on phone number (5 applications in 24 hours)
            - Device fingerprint associated with known fraud
            - Synthetic identity indicators detected with 85% confidence
          type: array
          items:
            type: string
      required:
        - level
        - reasons
    UserVerificationMatch:
      type: object
      properties:
        first_name:
          type: string
          description: First name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        last_name:
          type: string
          description: Last name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        middle_name:
          type: string
          description: Middle name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        date_of_birth:
          type: string
          description: Date of birth match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        ssn:
          type: string
          description: SSN match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        email:
          type: string
          description: Email match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        phone_number:
          type: string
          description: Phone number match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_1:
          type: string
          description: Address line 1 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_2:
          type: string
          description: Address line 2 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        city:
          type: string
          description: City match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        region:
          type: string
          description: Region match result (state/province/county)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        postal_code:
          type: string
          description: Postal code match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
    Synthetic:
      type: object
      properties:
        is_synthetic:
          type: boolean
          description: Whether identity is likely synthetic (fabricated)
          example: false
        confidence_score:
          type: number
          description: Confidence score that identity is synthetic (0-100)
          example: 15
        indicators:
          description: Specific synthetic identity indicators detected
          example:
            - SSN issued after applicant date of birth
            - Credit file recently established
          type: array
          items:
            type: string
      required:
        - is_synthetic
    Velocity:
      type: object
      properties:
        email:
          type: number
          description: Number of recent verifications using this email
          example: 1
        phone:
          type: number
          description: Number of recent verifications using this phone
          example: 2
        ssn:
          type: number
          description: Number of recent verifications using this SSN
          example: 1
        address:
          type: number
          description: Number of recent verifications using this address
          example: 3
    Device:
      type: object
      properties:
        risk_score:
          type: number
          description: Device-based risk score (0-100)
          example: 10
        is_emulator:
          type: boolean
          description: Whether device is an emulator
          example: false
        is_vpn:
          type: boolean
          description: Whether connection is through VPN
          example: false
        is_proxy:
          type: boolean
          description: Whether connection is through proxy
          example: false
    Watchlist:
      type: object
      properties:
        status:
          type: string
          description: Overall screening result
          enum:
            - clear
            - potential_match
            - confirmed_match
            - not_screened
          example: clear
        matches:
          description: Specific watchlist hits
          type: array
          items:
            $ref: '#/components/schemas/WatchlistMatch'
      required:
        - status
    WatchlistMatch:
      type: object
      properties:
        type:
          type: string
          description: Category of watchlist match
          example: sanctions
          enum:
            - sanctions
            - pep
            - adverse_media
        name:
          type: string
          description: Specific watchlist that produced the match (e.g., ofac_sdn, tauxbe)
          example: ofac_sdn
        confidence_score:
          type: number
          description: Match confidence score (0-100)
          example: 85
      required:
        - type
        - name
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````