Mobile User

Profile

Read and update the authenticated mobile user profile.

Get Current Profile

GET /api/v2/mobile_user/profile

Returns the profile of the authenticated mobile user.

Compared with v1, the v2 profile response adds provider-level cardholder status information so the app can tell whether the user is verified for UQPAY.

Required headers

HeaderRequiredNotes
Authorization: Bearer <access_token>YesAccess token from register or login.
Accept-LanguageOptionalLocalized response messages.

Success response

{
  "status_code": 200,
  "message": "Profile retrieved successfully",
  "data": {
    "uid": 120045,
    "uuid": "ea9b679c-6d42-4dcb-a10d-f46c0e0f8fb1",
    "phone": "91234567",
    "email": "user@example.com",
    "phone_code": "65",
    "country_code": "SG",
    "first_name": "Wei",
    "last_name": "Chen",
    "display_name": "Wei Chen",
    "full_name": "Wei Chen",
    "bio": "Mobile wallet user",
    "address": "1 Raffles Place",
    "date_of_birth": "1998-01-10",
    "gender": "male",
    "profile_picture": "https://cdn.example.com/users/120045.png",
    "is_active": true,
    "is_email_verified": true,
    "is_phone_verified": true,
    "is_kyc_verified": false,
    "kyc_status": "NOT_VERIFY",
    "kyc_expire_date": null,
    "is_pin_set": true,
    "is_pin_set_str": "true",
    "status": "active",
    "top_up_rate": 1.5,
    "physical_card_commission": "10.00",
    "virtual_card_commission": "5.00",
    "card_holders": {
      "UQPAY": {
        "status": "SUCCESS",
        "failed_reason": ""
      }
    },
    "created_at": "2026-02-28T10:30:00Z",
    "updated_at": "2026-02-28T10:30:00Z",
    "last_login_at": "2026-03-01T08:00:00Z",
    "agent_referral_code": "SGP12345"
  }
}

Response field notes

  • is_active: whether the mobile user account is currently active
  • kyc_status: summarized KYC state used by the app, such as NOT_VERIFY, VERIFYING, VERIFIED, or VERIFY_FAIL
  • kyc_expire_date: latest KYC expiry date when available; may be null
  • physical_card_commission and virtual_card_commission: current commission values returned for the user/agent relationship
  • card_holders: v2-only provider map keyed by cardholder provider such as UQPAY
  • card_holders.*.status: provider-level cardholder/KYC result, for example SUCCESS, PENDING, FAILED, or INACTIVE
  • card_holders.*.failed_reason: localized rejection reason when a provider-specific KYC flow failed
  • last_login_at: timestamp of the user's latest successful login when available
  • agent_referral_code: referral code associated with the agent linked to this mobile user

Update Current Profile

PUT /api/v2/mobile_user/profile

Updates editable profile fields for the authenticated mobile user.

This route accepts plain JSON or the encrypted wrapper described in Overview.

Request

{
  "first_name": "Wei",
  "last_name": "Chen",
  "display_name": "Wei C.",
  "bio": "Mobile wallet user",
  "address": "1 Raffles Place",
  "date_of_birth": "1998-01-10",
  "gender": "male",
  "profile_picture": "https://cdn.example.com/users/120045.png"
}

Editable fields

FieldNotes
first_nameMax 100 chars
last_nameMax 100 chars
display_nameMax 200 chars
bioMax 1000 chars
addressMax 500 chars
date_of_birthOptional string
genderOne of male, female, other, prefer_not_to_say
profile_pictureMax 500 chars

Success response

The API returns the updated profile in the same shape as GET /api/v2/mobile_user/profile.

Important v2 note

  • The main v2-specific difference on this page is the richer GET /profile response, especially the provider-level card_holders map

Common Failures

  • 401: missing or invalid bearer token.
  • 404: mobile user not found.
  • 400: validation failure on one or more fields.
Copyright © 2026