Get User Details - Enkash Developer Portal

📌

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "cardAccountId": "CAQL8YCV3",
    "companyId" : "CEK1PU9AOO"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "Success",
    "payload": {
        "enKashCardId": "EKCE54IDPE",
        "userId": "EKHCPB7W",
        "cardAccountId": "CAVBMRFE8",
        "token": "1cfc6f4d558064eb6a20",
        "maskedNumber": "XXXX XXXX XXXX 2209",
        "expiryMonth": "08",
        "expiryYear": "2026",
        "email": "[email protected]",
        "mobile": "6230912209",
        "title": "Mr",
        "firstName": "Api",
        "lastName": "Test",
        "gender": "M",
        "usedMtd": 0,
        "usedDtd": 0,
        "usedYtd": 0,
        "otbBalance": 0,
        "primaryCard": false,
        "prepaidCard": true,
        "physicalCard": false,
        "deleted": false,
        "closedLoopCard": false,
        "createdOn": "2024-08-05 16:51:36",
        "modifiedOn": "2024-08-05 16:51:36",
        "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": 0,
        "companyId": "CEK7T1WMC6",
        "cardKitMasterId": 11,
        "extEntityId": "EXT3B40FKFZGJ",
        "switchProvider": "EK_CLOSEDLOOP_CREDIT",
        "accountBalance": 898138,
        "physicalCardAllowed": false,
        "kitType": {
            "name": "VISA",
            "label": "Visa"
        },
        "surchargeAmt": 0,
        "panValidated": false,
        "usedLtd": 0,
        "latestTnCVersionAccepted": true,
        "latestKeyFactAccepted": true,
        "latestTnCVersionAcceptedForPrimaryCard": true,
        "latestKeyFactAcceptedCardForPrimaryCard": true,
        "virtualAccountNumber": "ENKASHEDENKEKCE54IDPE",
        "limitAllocatedLtd": 0,
        "posAllowed": false,
        "posAllowedAdmin": false,
        "atmAllowed": false,
        "atmAllowedAdmin": false,
        "onlineAllowed": false,
        "onlineAllowedAdmin": false,
        "liveImage": false,
        "unallocateFundAllowed": true,
        "useParentFundAllowed": false,
        "minKycOtpVerified": false,
        "enKashSupportEmail": "[email protected]",
        "enKashSupportMobile": "1234567890",
        "companyName": "Vikram Singh",
        "accountType": {
            "name": "EMPLOYEE_REWARDS",
            "label": "Employee Rewards",
            "description": "Reward"
        },
        "lastAllocatedAmount": 0,
        "holdBalance": 0,
        "unAllocateHoldBalance": 0,
        "tncUnAllocateAllowed": false,
        "tncUnAllocateAccepted": false,
        "totalRewardsReceived": 0,
        "rewardPointsReceived": 0,
        "ckycEnabled": false,
        "vkycAllowed": false
    }
}