# Get User Details

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/partner/enKashCard/search:
    post:
      summary: Get User Details
      deprecated: false
      description: >-
        :::highlight orange 📌

        This API retrieves a list of users associated with a specific
        organization, platform, or system. It returns key user profile
        information, optionally filtered by user role, status, or other
        criteria. Useful for admin dashboards, user management modules, or
        reporting interfaces

        :::
      tags:
        - Rewards & Incentives/APIs - Reward/Incentive Allocation
      parameters:
        - name: partnerId
          in: header
          description: ''
          required: true
          example: CRMXWB3ZM
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: Bearer SuzhOaF6K64ztA4rSmDOgl9yMlI
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: Cookie
          in: header
          description: ''
          required: true
          example: >-
            JSESSIONID=526FAFE391FEC276549D84FEF5FC5BE7;
            JSESSIONID=B01764303CD3DEFC3C0699B3EF351505
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cardAccountId:
                  type: string
                companyId:
                  type: string
                enKashCardId:
                  type: string
              required:
                - cardAccountId
                - companyId
                - enKashCardId
              x-apidog-orders:
                - cardAccountId
                - companyId
                - enKashCardId
            example:
              cardAccountId: CAQL8YCV3
              companyId: CEK1PU9AOO
              enKashCardId: EKC9MKS5RM
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  payload:
                    type: object
                    properties:
                      recordsCount:
                        type: integer
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            enKashCardId:
                              type: string
                            userId:
                              type: string
                            cardAccountId:
                              type: string
                            token:
                              type: string
                            maskedNumber:
                              type: string
                            expiryMonth:
                              type: string
                            expiryYear:
                              type: string
                            email:
                              type: string
                            mobile:
                              type: string
                            title:
                              type: string
                            firstName:
                              type: string
                            lastName:
                              type: string
                            gender:
                              type: string
                            otbBalance:
                              type: integer
                            companyId:
                              type: string
                          x-apidog-orders:
                            - enKashCardId
                            - userId
                            - cardAccountId
                            - token
                            - maskedNumber
                            - expiryMonth
                            - expiryYear
                            - email
                            - mobile
                            - title
                            - firstName
                            - lastName
                            - gender
                            - otbBalance
                            - companyId
                    required:
                      - recordsCount
                      - data
                    x-apidog-orders:
                      - recordsCount
                      - data
                required:
                  - code
                  - message
                  - payload
                x-apidog-orders:
                  - code
                  - message
                  - payload
              example:
                code: 0
                message: Success
                payload:
                  recordsCount: 1
                  data:
                    - enKashCardId: EKC9MKS5RM
                      userId: EKPDC37K
                      cardAccountId: CAQL8YCV3
                      token: 152aaef7e91c6abfc7fb
                      maskedNumber: 2004 00XX XXXX XX89
                      expiryMonth: ''
                      expiryYear: ''
                      email: test@hrms.com
                      mobile: '6667778889'
                      title: Mr
                      firstName: Test
                      lastName: Company
                      gender: M
                      usedMtd: 0
                      usedDtd: 0
                      usedYtd: 0
                      otbBalance: 321
                      primaryCard: true
                      prepaidCard: true
                      physicalCard: false
                      deleted: false
                      closedLoopCard: false
                      createdOn: Feb 1, 2024 2:28:18 PM
                      modifiedOn: Mar 14, 2024 3:07:11 PM
                      cardStatus:
                        name: UL
                        label: UnLocked
                      kycStatus:
                        name: VERIFIED
                        label: Verified
                      cardProgramme: SBM
                      useAccountFunds: false
                      blockCode: A
                      partnerLogo: https://image.enkash.in/IMAGES/sbm-logo.png
                      physicalDeliveryAddressFlag: false
                      cardActivated: true
                      binType:
                        name: REWARD
                        label: Reward Card
                      loadAmount: 10
                      companyId: CEK1PU9AOO
                      middleName: ''
                      extEntityId: EXTBP0IBHV0H2
                      physicalCardAllowed: false
                      surchargeAmt: 0
                      panValidated: false
                      usedLtd: 0
                      latestTnCVersionAccepted: true
                      latestKeyFactAccepted: true
                      latestTnCVersionAcceptedForPrimaryCard: true
                      latestKeyFactAcceptedCardForPrimaryCard: true
                      primaryEnKashCardId: EKC9MKS5RM
                      primaryEnKashCardUserId: EKPDC37K
                      limitAllocatedLtd: 311
                      posAllowed: true
                      posAllowedAdmin: true
                      atmAllowed: false
                      atmAllowedAdmin: false
                      onlineAllowed: true
                      onlineAllowedAdmin: true
                      liveImage: false
                      cKycEnabled: false
                      unallocateFundAllowed: false
                      useParentFundAllowed: false
                      minKycOtpVerified: false
                      vKycAllowed: false
                      accountType:
                        name: EMPLOYEE_REWARDS
                        label: Employee Rewards
                        description: Reward
                      lastAllocatedAmount: 188
                      holdBalance: 0
                      enableHoldAmount: false
                      unAllocateHoldBalance: 0
                      tncUnAllocateAllowed: false
                      tncUnAllocateAccepted: false
                      minTransactionAmount: 10
                      totalRewardsReceived: 3
                      rewardPointsReceived: 321
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Rewards & Incentives/APIs - Reward/Incentive Allocation
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-9796913-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```