Get User Profile

Fetch the profile of the currently authenticated user. Returns identity details such as name, contact info, status, and associated store IDs.

When to Use

▾

Use this endpoint when you:

• Display the logged-in user's profile in your UI
• Need the user's contact details for support or notifications
• Want to verify the authenticated user's active status or store assignments

How to Use

▾

Endpoint

GET/v3/user

Step 1: Authenticate

▾

Obtain a valid accessToken via the Client Credentials or Authorization Code flow.

Step 2: Send the GET Request

▾

No request body or query parameters required. Signed headers (signature, nonce, timestamp) are sufficient.

Step 3: Read the Response

▾

The item object contains the user's profile fields. A "SUCCESS" code confirms the call worked.

---

Request Parameters

▾

No request body. Authenticated headers only.

---

Response Parameters

▾

itemOBJECT

Authenticated user profile.

idSTRING

Unique user ID.

Example: "8190656045166232716"

firstNameSTRING

User's first name.

Example: "MOHAMED"

lastNameSTRING

User's last name.

Example: "YUSSUF"

countryCodeSTRING

Country code for contact number.

Example: "60"

phoneNumberSTRING

User's phone number.

Example: "377334080"

emailSTRING

User's email address.

Example: "[email protected]"

avatarUrlSTRING

Public URL of the user's avatar image.

Example: "https://storage.googleapis.com/rm-prod-asset/img/avatar.png"

roleOBJECT

User's assigned role and permission scopes

keySTRING

Role key (internal usage)

Example: "Eg0KBFJvbGUaBU9XTkVS"

nameSTRING

Role name

Example: "OWNER"

scopesARRAY

List of permission scopes granted to this role

Example: ["merchant.profile.get"]

createdAtDATETIME

Role creation timestamp

Example: "0001-01-01T00:00:00Z"

updatedAtDATETIME

Role last update timestamp

Example: "0001-01-01T00:00:00Z"

statusSTRING

Account status (`"ACTIVE"`, `"INACTIVE"`).

Example: "ACTIVE"

settlementAccountIdARRAY

Settlement account IDs linked to the user

Example: []

storeIdARRAY

List of store IDs the user belongs to.

Example: ["6170506694335521334"]

isActiveBOOLEAN

Whether the user account is active.

Example: true

currentStoreIdSTRING

Currently selected store ID

Example: ""

merchantIdSTRING

Merchant ID the user belongs to

Example: "4118165203679668885"

createdAtDATETIME

Account creation timestamp.

Example: "2018-02-12T08:53:13Z"

updatedAtDATETIME

Last update timestamp.

Example: "2018-02-12T08:53:13Z"

extraInfoOBJECT

Extra user preferences

receivePaymentNotificationBOOLEAN

Whether the user receives payment notifications

Example: true

codeSTRING

`"SUCCESS"` if the call succeeded. Otherwise returns an error code. See [Error Codes](../error-codes).

Example: "SUCCESS"