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

# Get User Details

> Retrieve detailed information about a user including their KYC status, verification state, and any requirements due. For comprehensive guides on handling user statuses and rejection reasons, see our [User Status Documentation](/documentation/developer-platform/users/compliance/user-status) and [Rejection Reasons Guide](/documentation/developer-platform/users/compliance/rejection-reasons).



## OpenAPI

````yaml /api-reference/openapi.json get /onboarding/api/v1/users/{user_id}
openapi: 3.0.0
info:
  title: Carbn Connect API
  version: 1.0.0
  description: >-
    API documentation for Carbn Connect services including user onboarding, KYC,
    wallet management, and transfers.
servers:
  - url: https://api.carbnconnect.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /onboarding/api/v1/users/{user_id}:
    get:
      tags:
        - User Management
      summary: Get User Details
      description: >-
        Retrieve detailed information about a user including their KYC status,
        verification state, and any requirements due. For comprehensive guides
        on handling user statuses and rejection reasons, see our [User Status
        Documentation](/documentation/developer-platform/users/compliance/user-status)
        and [Rejection Reasons
        Guide](/documentation/developer-platform/users/compliance/rejection-reasons).
      operationId: getUserDetails
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          description: The unique identifier of the user
      responses:
        '200':
          description: User details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailsResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized - API key is missing or invalid
        '404':
          description: User not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    UserDetailsResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          description: Unique user identifier
        status:
          type: string
          enum:
            - under_review
            - active
            - rejected
            - offboarded
            - incomplete
          example: under_review
          description: >-
            Current user status. under_review: Initial status when user is
            created (default). active: User has been approved and verified.
            paused: User account is temporarily paused. rejected: User has been
            rejected during KYC process. offboarded: User has been
            removed/offboarded from the system. incomplete: User profile is
            missing required information.
        documents:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: national_id
                description: Document name/type
              type:
                type: string
                example: identity_front
                description: Document type
          description: List of uploaded documents (both identity and supporting documents)
          example:
            - name: national_id
              type: identity_front
            - name: national_id
              type: identity_back
            - name: steuer_id
              type: tax_document
        address:
          type: object
          properties:
            line1:
              type: string
              example: 123 Main Street
              description: Address line 1
            line2:
              type: string
              nullable: true
              example: null
              description: Address line 2 (optional)
            city:
              type: string
              example: City Name
              description: City
            country:
              type: string
              example: DEU
              description: Country code (ISO 3166-1 alpha-3)
            region:
              type: string
              nullable: true
              example: null
              description: Region (optional)
            sub_division:
              type: string
              example: ST
              description: Sub-division/state code
            postal_code:
              type: string
              example: '12345'
              description: Postal code
        first_name:
          type: string
          example: John
          description: User's first name
        last_name:
          type: string
          example: Doe
          description: User's last name
        email_address:
          type: string
          format: email
          example: user@example.com
          description: User's email address
        phone_number:
          type: string
          example: +1XXXXXXXXXX
          description: User's phone number
        date_of_birth:
          type: string
          format: date
          example: YYYY-MM-DD
          description: User's date of birth
        rejection_reasons:
          type: array
          items:
            type: object
            properties:
              reason:
                type: string
                example: Your information could not be verified
                description: >-
                  Customer-facing rejection reason that can be safely shared
                  with users
              created_at:
                type: string
                format: date-time
                example: '2025-09-09T11:46:22.037Z'
                description: Timestamp when the rejection reason was recorded
              developer_reason:
                type: string
                example: ID cannot be verified against third-party databases
                description: >-
                  Internal reason for developers only (may contain sensitive
                  information)
          nullable: true
          example: null
          description: >-
            Array of rejection reason objects (only populated for rejected
            users, null otherwise). Each object contains customer-facing reason,
            timestamp, and internal developer reason.
        requirements:
          type: array
          items:
            type: string
          nullable: true
          example: null
          description: >-
            List of missing requirements for incomplete users (null when no
            requirements are missing)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Must be included in the x-api-key header.

````