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

# Get details of a single user

> This endpoint returns comprehensive information about a user including:
- Basic user information (name, email, address)
- Verification status
- Associated accounts details



## OpenAPI

````yaml /api-reference/openapi-integrator.json get /v1/query/get-user-details
openapi: 3.0.3
info:
  title: Byzantine Integrator API
  description: Byzantine REST API for integrators.
  license:
    name: ''
  version: 0.2.0
servers:
  - url: https://sandbox.api.byzantine.fi
    description: Sandbox
security: []
tags:
  - name: API health
    description: Check API status.
  - name: Customer management
    description: Endpoints to create, update, and retrieve customer information.
  - name: Account management
    description: Endpoints to manage accounts, bank accounts, invitations, and user roles.
  - name: Products
    description: Endpoints to get data about products and vaults.
  - name: Transactions
    description: Endpoints to create and manage transactions.
  - name: OTP authentication
    description: Endpoints to initialize and manage user authentication with OTP.
  - name: Webhooks
    description: Integrator-managed outbound webhook subscriptions and delivery history.
paths:
  /v1/query/get-user-details:
    get:
      tags:
        - Customer management
      summary: Get details of a single user
      description: |-
        This endpoint returns comprehensive information about a user including:
        - Basic user information (name, email, address)
        - Verification status
        - Associated accounts details
      operationId: get_user_details
      parameters:
        - name: X-Pubkey
          in: header
          description: >-
            Integrator's ECDSA public key (P-256 curve, compressed SEC1 format).
            Example:
            0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd
          required: true
          schema:
            type: string
        - name: X-Timestamp
          in: header
          description: >-
            Unix timestamp in seconds (UTC). Must be within tolerance window (1
            minute) to prevent replay attacks. Example: 1760375826
          required: true
          schema:
            type: string
        - name: X-Signature
          in: header
          description: >-
            ECDSA signature (DER-encoded, hex with 0x prefix). Signs the
            message: {timestamp}{METHOD}{path_and_query}{json_body}. Example:
            0x3045022100...
          required: true
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/Uuid'
            nullable: true
        - name: email
          in: query
          required: false
          schema:
            type: string
            nullable: true
      responses:
        '200':
          description: User details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserResponse'
        '400':
          description: Bad request - Invalid user_id or email
        '404':
          description: User not found
        '500':
          description: Internal server error
      security:
        - integrator_auth: []
components:
  schemas:
    Uuid:
      type: string
      format: uuid
      description: A UUID string
      example: 550e8400-e29b-41d4-a716-446655440000
    GetUserResponse:
      type: object
      description: Response body for user details
      required:
        - userId
        - verificationStatus
        - userInfo
        - accounts
        - createdAt
      properties:
        userId:
          $ref: '#/components/schemas/Uuid'
        verificationStatus:
          $ref: '#/components/schemas/VerificationStatus'
        userInfo:
          $ref: '#/components/schemas/GetUserInfo'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/GetAccountResponse'
        createdAt:
          type: string
          format: date-time
    VerificationStatus:
      type: string
      description: The identity verification status of the user.
      enum:
        - not_started
        - init
        - under_review
        - awaiting_associated_person_information
        - awaiting_information
        - resubmission_requested
        - active
        - rejected
        - inactive
      example: active
    GetUserInfo:
      type: object
      description: Response body for user information
      required:
        - firstName
        - lastName
        - email
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        nationality:
          allOf:
            - $ref: '#/components/schemas/CountryCode'
          nullable: true
        residentialAddress:
          allOf:
            - $ref: '#/components/schemas/Address'
          nullable: true
        countryOfBirth:
          allOf:
            - $ref: '#/components/schemas/CountryCode'
          nullable: true
    GetAccountResponse:
      type: object
      description: Response body for account information
      required:
        - accountId
        - accountName
        - accountType
        - userRole
        - walletAddress
        - isSelfCustodial
        - createdAt
      properties:
        accountId:
          $ref: '#/components/schemas/Uuid'
        accountName:
          type: string
        accountType:
          $ref: '#/components/schemas/ApplicantType'
        entityInfo:
          allOf:
            - $ref: '#/components/schemas/GetEntityMinimalInfo'
          nullable: true
        userRole:
          $ref: '#/components/schemas/AccountUserRole'
        walletAddress:
          type: string
        isSelfCustodial:
          type: boolean
        bridgeAccountId:
          type: string
          nullable: true
        profilePictureUrl:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    CountryCode:
      type: string
      description: >-
        The ISO 3166-1 (three-character) country code of the relevant country.
        See the full list of
        [countries](https://docs.byzantine.fi/api-reference/lists/countries).
      enum:
        - ABW
        - AFG
        - AGO
        - ALB
        - AND
        - ARG
        - ARM
        - AUS
        - AUT
        - AZE
        - BEL
        - BGD
        - BGR
        - BHR
        - BHS
        - BIH
        - BLZ
        - BMU
        - BOL
        - BRA
        - BRB
        - BWA
        - CAN
        - CHL
        - CHN
        - CIV
        - CMR
        - COL
        - COM
        - CRI
        - CUW
        - CXR
        - CYM
        - CYP
        - CZE
        - DEU
        - DMA
        - DNK
        - DOM
        - DZA
        - ECU
        - EGY
        - ESP
        - EST
        - ETH
        - FIN
        - FJI
        - FRA
        - GBR
        - GEO
        - GHA
        - GIB
        - GRC
        - GTM
        - HKG
        - HND
        - HRV
        - HTI
        - HUN
        - IDN
        - IMN
        - IND
        - IRL
        - IRQ
        - ISL
        - ISR
        - ITA
        - JAM
        - JOR
        - JPN
        - KAZ
        - KEN
        - KGZ
        - KHM
        - KNA
        - KOR
        - KWT
        - LAO
        - LBN
        - LBR
        - LCA
        - LKA
        - LTU
        - LUX
        - LVA
        - MAR
        - MCO
        - MDA
        - MDG
        - MEX
        - MHL
        - MKD
        - MLT
        - MNE
        - MOZ
        - MRT
        - MUS
        - MWI
        - MYS
        - NAM
        - NGA
        - NIC
        - NLD
        - NOR
        - NPL
        - NZL
        - OMN
        - PAN
        - PER
        - PHL
        - PAK
        - POL
        - PRT
        - QAT
        - ROU
        - RUS
        - SAU
        - SEN
        - SGP
        - SVK
        - SVN
        - ZAF
        - SWE
        - CHE
        - THA
        - TUN
        - TUR
        - UGA
        - UKR
        - ARE
        - USA
        - URY
        - UZB
        - VEN
        - VNM
        - YEM
        - ZMB
        - ZWE
        - SMR
      example: FRA
    Address:
      type: object
      description: Address information. Must be a valid address in the relevant country.
      required:
        - streetLine1
        - city
        - postalCode
        - country
      properties:
        streetLine1:
          type: string
          example: 33 Rue La Fayette
        streetLine2:
          type: string
          description: Optional additional details to the street name and number.
          example: WeWork
          nullable: true
        city:
          type: string
          example: Paris
        state:
          type: string
          description: >-
            Required for US addresses. Should be a valid ISO 3166-2 subdivision
            code.
          example: IDF
          nullable: true
        postalCode:
          type: string
          description: Postal code.
          example: '75009'
        country:
          $ref: '#/components/schemas/CountryCode'
    ApplicantType:
      type: string
      description: Type of applicant for Sumsub verification
      enum:
        - individual
        - company
    GetEntityMinimalInfo:
      type: object
      description: Response body for entity information
      required:
        - entityId
        - entityName
      properties:
        entityId:
          $ref: '#/components/schemas/Uuid'
        entityName:
          type: string
    AccountUserRole:
      type: string
      description: Role of a user in an account.
      enum:
        - root
        - admin
        - view
        - self_custodial
        - beneficiary
      example: root
  securitySchemes:
    integrator_auth:
      type: apiKey
      in: header
      name: X-Pubkey, X-Timestamp, X-Signature

````