Skip to main content

Get User Details API

Overview​

Retrieve detailed information about a specific user by their user ID.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/user/user_detail/{user_id}

Path Parameters​

  • user_id (String, required): The unique identifier of the user to retrieve details for
    • Example: 6f1b82443e524459831de59d430a0c41

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "user_detail": {
            "id": "6f1b82443e524459831de59d430a0c41",
            "first_name": "Baba",
            "last_name": "Kane",
            "email": null,
            "dial_code": "+221",
            "phone_number": "800000000",
            "user_type": 2,
            "role_id": null,
            "updated_date": 1756551930,
            "device_info": {
                "device_id": "crVeVSOyukbqu7FZ2ZetWw:APA91bHIe6wxnH-XuioLuCWNJk-q6kG2LiPA93RHxgSgCQY-wPQxdP60kScOT58qjUKWwITzZ6p5tyfFXXBkpeuU8zY4Yv23-b7U4QD6MpYveUfLkhMFTyI",
                "device_type": "IOS",
                "device_unique_id": null
            },
            "account_number": "1756551924069",
            "verification": {
                "is_email": false,
                "is_phone": true
            },
            "status_id": 1,
            "birth_date": null,
            "image": null,
            "user_code": "CUS_RCR6EPZU",
            "country_id": null,
            "kyc_status": 1,
            "kyc_process_status": 1,
            "location_point": null,
            "rating": null,
            "login_pin": "$2a$10$XAbNifioUvzjILWLKq8x3um7yS6uZVvXVURN46GfCyZqSuMM.RdNW",
            "transaction_pin": null,
            "created_date": 1756551924,
            "created_by": "6f1b82443e524459831de59d430a0c41",
            "parent_user_id": null,
            "display_name": null,
            "display_image": null,
            "kyc_status_id": null,
            "reason_code_id": null,
            "reject_reason": null,
            "unique_device_id": "crVeVSOyukbqu7FZ2ZetWw:APA91bHIe6wxnH-XuioLuCWNJk-q6kG2LiPA93RHxgSgCQY-wPQxdP60kScOT58qjUKWwITzZ6p5tyfFXXBkpeuU8zY4Yv23-b7U4QD6MpYveUfLkhMFTyI"
        }
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • user_detail (object): Detailed user information object

User Detail Object Fields​

  • id (string): User primary ID
  • first_name (string): User's first name
  • last_name (string): User's last name
  • email (string|null): User's email address
  • dial_code (string): Country dial code
  • phone_number (string): Phone number
  • user_type (integer): Type of user (2=Customer, 3=Merchant, 5=Agent)
  • role_id (string|null): User's role ID
  • updated_date (long): Last update timestamp
  • device_info (object): Device information object
    • device_id (string): Device identifier
    • device_type (string): Type of device (e.g., "IOS", "ANDROID")
    • device_unique_id (string|null): Unique device identifier
  • account_number (string): User's account number
  • verification (object): Verification status object
    • is_email (boolean): Email verification status
    • is_phone (boolean): Phone verification status
  • status_id (integer): User status ID (see Constants for values)
  • birth_date (string|null): User's birth date
  • image (string|null): User's profile image
  • user_code (string): Unique user code
  • country_id (string|null): Country ID
  • kyc_status (integer): KYC status (see Constants for values)
  • kyc_process_status (integer): KYC process status (see Constants for values)
  • location_point (string|null): Location coordinates
  • rating (number|null): User rating
  • login_pin (string): Hashed login PIN (encrypted)
  • transaction_pin (string|null): Hashed transaction PIN (encrypted)
  • created_date (long): Creation timestamp
  • created_by (string): ID of the user who created this account
  • parent_user_id (string|null): Parent user ID
  • display_name (string|null): Display name
  • display_image (string|null): Display image URL
  • kyc_status_id (string|null): KYC status ID
  • reason_code_id (string|null): Reason code ID
  • reject_reason (string|null): Rejection reason
  • unique_device_id (string): Unique device identifier

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/user/user_detail/6f1b82443e524459831de59d430a0c41' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b'

Notes​

  • The login_pin and transaction_pin fields return hashed/encrypted values for security
  • Device information includes details about the user's registered devices
  • KYC status and process status values can be referenced from the Constants page
  • User status values can be referenced from the Constants page