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

# Get user details

> Returns full details of a specific user including identity information (masked), CIP verification status, blocked status, and activity statistics (total links, completed operations, last activity).



## OpenAPI

````yaml /raas-widgets/openapi.json get /partner/users/{userId}
openapi: 3.0.0
info:
  title: RaaS Widgets Partner API
  description: >
    REST API for RaaS Widgets partner integrations. Create magic links for
    embeddable flows, manage end users, track transfer operations, handle CIP
    verification, and configure webhooks for real-time event notifications.


    This specification covers the **Partner-accessible API** only (`X-API-Key`
    against `/partner/*`). Widget and Superadmin APIs are out of scope.


    ## Authentication


    All endpoints require an API key passed in the `X-API-Key` header. Use
    `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for
    production.


    ## Environments


    | Environment | Base URL |

    |---|---|

    | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` |
  version: 1.18.0
  contact: {}
servers:
  - url: https://raas-widgets-backend-sandbox.up.railway.app
    description: Sandbox
security: []
tags:
  - name: Partner - Magic Links
    description: Create, list, and manage magic links for flows
  - name: Partner - Flows
    description: List enabled flows and the full flow catalog
  - name: Partner - Users
    description: View and manage end users associated with your partner account
  - name: Partner - Operations
    description: Track money transfer operations and their statuses
  - name: Partner - Requests
    description: List and inspect money-request records
  - name: Partner - Deferred Payouts
    description: List, inspect, and cancel deferred payout remittances
  - name: Partner - CIP
    description: Customer Identification Program (CIP) verification management
  - name: Partner - Data Requests
    description: Fulfill data requests for additional user information
  - name: Partner - Settings
    description: Configure partner-level settings (redirect URLs, logo, etc.)
  - name: Partner - Webhooks
    description: Configure webhook endpoints and inspect delivery history
  - name: Partner - Pricing
    description: >-
      Indicative pre-quote summaries (best / worst / averages) for partner
      integrations
paths:
  /partner/users/{userId}:
    get:
      tags:
        - Partner - Users
      summary: Get user details
      description: >-
        Returns full details of a specific user including identity information
        (masked), CIP verification status, blocked status, and activity
        statistics (total links, completed operations, last activity).
      operationId: UsersController_getUser
      parameters:
        - name: userId
          required: true
          in: path
          description: M2M user identifier
          schema:
            example: user_acme_x1y2z3
            type: string
      responses:
        '200':
          description: User details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailResponseDto'
        '401':
          description: Unauthorized — invalid or missing API key / bearer token
        '404':
          description: User not found
      security:
        - api-key: []
components:
  schemas:
    UserDetailResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/UserDetailDataDto'
      required:
        - success
        - data
    UserDetailDataDto:
      type: object
      properties:
        userId:
          type: string
          description: M2M user ID
          example: user_acme_x1y2z3
        referenceId:
          type: string
          description: Partner reference ID
          example: user-12345
        name:
          description: User name
          allOf:
            - $ref: '#/components/schemas/UserNameDto'
        idType:
          type: string
          description: ID document type
          example: INE
        idNumber:
          type: string
          description: Masked ID number (last 4 digits visible)
          example: '****6789'
        dob:
          type: string
          description: Date of birth (YYYY-MM-DD)
          example: '1990-05-15'
        cipStatus:
          type: string
          description: CIP verification status
          example: verified
          enum:
            - pending
            - verified
            - failed
        cipVerifiedAt:
          type: string
          description: When CIP was verified (ISO 8601)
          example: '2026-02-10T14:00:00.000Z'
        blocked:
          type: boolean
          description: Whether the user is blocked
          example: false
        blockedAt:
          type: string
          description: When the user was blocked (ISO 8601)
        blockedReason:
          type: string
          description: Reason for blocking the user
        suspended:
          type: boolean
          description: Whether the user is suspended (view-only, cannot create operations)
          example: false
        suspendedAt:
          type: string
          description: When the user was suspended (ISO 8601)
        suspendedReason:
          type: string
          description: Reason for suspending the user
        createdAt:
          type: string
          description: User creation timestamp (ISO 8601)
          example: '2026-02-10T12:00:00.000Z'
        updatedAt:
          type: string
          description: Last update timestamp (ISO 8601)
          example: '2026-02-10T12:05:00.000Z'
        userDataSources:
          type: object
          description: >-
            Map of field names to data sources indicating where each piece of
            user data originated
          example:
            name.firstName: link
            idNumber: data_request
        cipResult:
          description: CIP verification result including outcome data from Kentucky
          allOf:
            - $ref: '#/components/schemas/CipResultDto'
        livenessImageUrl:
          type: string
          description: Relative URL to liveness photo (requires partner auth)
          example: /partner/users/user_acme_x1y2z3/liveness-image
        idImageUrl:
          type: string
          description: Relative URL to ID document image (requires partner auth)
          example: /partner/users/user_acme_x1y2z3/id-document-image
        stats:
          description: User activity statistics
          allOf:
            - $ref: '#/components/schemas/UserStatsDto'
      required:
        - userId
        - referenceId
        - name
        - cipStatus
        - blocked
        - suspended
        - createdAt
        - updatedAt
        - stats
    UserNameDto:
      type: object
      properties:
        firstName:
          type: string
          description: First name
          example: Juan
        secondName:
          type: string
          description: Second name
          example: Carlos
        lastName:
          type: string
          description: Last name
          example: Pérez
        secondLastName:
          type: string
          description: Second last name
          example: García
    CipResultDto:
      type: object
      properties:
        ticketId:
          type: string
          description: Kentucky ticket ID
          example: tkt_abc123
        dictamenId:
          type: string
          description: Kentucky dictamen ID
          example: dict_abc123
        outcomeId:
          type: string
          description: Kentucky outcome ID
          example: out_abc123
        status:
          type: string
          description: CIP verification result from Kentucky
          example: approved
          enum:
            - approved
            - rejected
            - manual_review
        receivedAt:
          type: string
          description: When the CIP result was received (ISO 8601)
          example: '2026-02-10T14:00:00.000Z'
        outcomeFetchError:
          type: string
          description: Error message if outcome fetch failed
        outcome:
          description: Full CIP outcome with extracted data
          allOf:
            - $ref: '#/components/schemas/CipOutcomeDto'
      required:
        - ticketId
        - dictamenId
        - status
        - receivedAt
    UserStatsDto:
      type: object
      properties:
        totalLinks:
          type: number
          description: Total number of magic links created for this user
          example: 5
        completedOperations:
          type: number
          description: Number of completed operations (transfers)
          example: 3
        lastActivityAt:
          type: string
          description: Timestamp of the most recent link (ISO 8601)
          example: '2026-02-10T12:00:00.000Z'
      required:
        - totalLinks
        - completedOperations
    CipOutcomeDto:
      type: object
      properties:
        id:
          type: string
          description: Outcome ID
          example: out_abc123
        data:
          description: Extracted data from CIP verification
          allOf:
            - $ref: '#/components/schemas/CipOutcomeDataDto'
        reasoning:
          type: string
          description: AI reasoning for the decision
        processingTimeMs:
          type: number
          description: Processing time in milliseconds
          example: 3500
        createdAt:
          type: string
          description: When the outcome was created (ISO 8601)
      required:
        - id
        - data
    CipOutcomeDataDto:
      type: object
      properties:
        firstName:
          type: string
          example: Juan
        secondName:
          type: string
          example: Carlos
        lastName:
          type: string
          example: Pérez
        secondLastName:
          type: string
          example: García
        fullName:
          type: string
          example: Juan Carlos Pérez García
        idNumber:
          type: string
          example: ABCD123456HDFXYZ00
        dob:
          type: string
          example: '1990-05-15'
        expDate:
          type: string
          example: '2030-12-31'
        gender:
          type: string
          example: M
        docIssuerCountryISO2:
          type: string
          example: MX
        docIssuerCountryISO3:
          type: string
          example: MEX
        docIssuingAuthority:
          type: object
        docExtraInfo:
          type: object
        documentType:
          type: string
          example: INE
        documentSubType:
          type: string
        homeAddressRaw:
          type: string
          example: Calle Reforma 123, Col Centro, CDMX
        homeAddressStreet:
          type: string
          example: Calle Reforma 123
        homeAddressCity:
          type: string
          example: Ciudad de México
        homeAddressState:
          type: string
          example: CDMX
        homeAddressZip:
          type: string
          example: '06000'
        homeAddressCountryISO3:
          type: string
          example: MEX
        homeAddressCountryISO2:
          type: string
          example: MX
        homeAddressCountryName:
          type: string
          example: Mexico
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your partner API key. Use `raas_sandbox_*` keys for the sandbox
        environment and `raas_live_*` keys for production.

````