Get user

Retrieves comprehensive details for a specific user account. This endpoint returns complete user information including profile data, security settings, MFA requirements, and associated client relation

Endpoint

GET/v2/user/{uuid}

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Authentication

An API key is required for authentication. Include it in the Authorization header.

• Header: Authorization
• Value: Your API key token

HTTP Method & URL

• Method: GET
• URL: https://stagep.tst-apidmndelss.com/v2/user/{uuid}

Path Parameters

Parameter	Type	Description	Required	Example
uuid	string	Unique identifier of the user to retrieve.	Yes	user_abc123def

Headers

Key	Value	Required
Authorization	Bearer <JWT>	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a complete user object with all associated data and metadata.

Response Fields

User Object (item)

Field	Type	Description	Example
id	integer	Internal numeric user ID.	12345
uuid	string	Unique user identifier.	user_abc123def
username	string	User's login name.	john.smith
status	string	Current user status.	ACCEPT
is2fa	boolean	2FA enabled status.	true
isDeleted	boolean	Soft delete status.	false
puid	string	Public user identifier.	pub_789xyz
createAt	string	Account creation timestamp.	2024-01-15T10:30:00Z
updateAt	string	Last update timestamp.	2024-03-20T14:22:00Z
name	string	User's first name.	John
lastname	string	User's last name.	Smith
comment	string	Administrative comments.	VIP customer

Status Values

• NEW - Registered user
• READY_FOR_MODERATION - Ready for review
• MODERATED - Under moderation
• VERIFY - Verification in progress
• ACCEPT - Approved user
• REJECT - Rejected user
• BANNED - Banned user

Parameters Object (parameters)

Field	Type	Description	Example
mfa	object	Multi-factor authentication settings.
→ requireOtp	boolean	OTP requirement.	true
→ requirePass	boolean	Password requirement.	true
→ requireEmail	boolean	Email verification.	false
→ requireSms	boolean	SMS verification.	true
profile	object	User profile information.
→ phone	string	Phone number.	[phone]
→ email	string	Email address.	[email protected]
→ dob	string	Date of birth.	1985-06-15T00:00:00Z
→ country	string	Country.	United States
→ city	string	City.	New York
→ postcode	string	Postal code.	10001

Clients Array (clients[])

Field	Type	Description	Example
customerId	string	Associated customer ID.	cust_789xyz
isOwner	boolean	Ownership status.	true

Example Response:

{
  "item": {
    "id": 12345,
    "uuid": "user_abc123def",
    "username": "john.smith",
    "status": "ACCEPT",
    "is2fa": true,
    "isDeleted": false,
    "puid": "pub_789xyz",
    "createAt": "2024-01-15T10:30:00Z",
    "updateAt": "2024-03-20T14:22:00Z",
    "name": "John",
    "lastname": "Smith",
    "comment": "VIP customer",
    "parameters": {
      "mfa": {
        "requireOtp": true,
        "requirePass": true,
        "requireEmail": false,
        "requireSms": true
      },
      "profile": {
        "phone": "[phone]",
        "email": "[email protected]",
        "dob": "1985-06-15T00:00:00Z",
        "country": "United States",
        "city": "New York",
        "postcode": "10001"
      }
    },
    "clients": [
      {
        "customerId": "cust_789xyz",
        "isOwner": true
      },
      {
        "customerId": "cust_456abc",
        "isOwner": false
      }
    ]
  }
}

---

Examples

Basic User Retrieval (cURL)

curl --request GET \
  --url https://stagep.tst-apidmndelss.com/v2/user/user_abc123def \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGci...wNLGA'

---

Error Responses

1. User Not Found:

   { "error": "User not found: user_invalid_id" }

2. Unauthorized:

   { "error": "Unauthorized" }

3. Access Denied:

   { "error": "Access denied to user data" }

---

Notes

Data Sensitivity

• Returns comprehensive PII (Personally Identifiable Information)
• Access should be restricted to authorized personnel only
• Some fields may be masked or omitted based on permissions

Field Explanations

• isDeleted: Indicates if user is soft-deleted (may still be recoverable)
• puid: Public-facing user ID for external references
• clients: Array of customer relationships and ownership status
• parameters.mfa: Security requirements for user authentication

Best Practices

• Use this endpoint for user administration and support purposes
• Handle PII data according to privacy regulations (GDPR, CCPA)
• Cache responses appropriately to reduce API calls
• Validate user permissions before displaying sensitive information

Common Use Cases:

• User profile management interfaces
• Customer support user lookup
• Account verification processes
• Security and compliance auditing
• User relationship management

Data Protection:

• Sensitive fields like email and phone may require additional permissions
• Consider masking certain data in user interfaces
• Ensure secure transmission and storage of PII

Request sample

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNTcyNjY1LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.-SZ9Vc_BimN9juZElxhZeMQV5Hbb1WqUY2b8xwOSZLo
userId*: 158a190e-c4a9-4e6c-bf9b-4ef74ae345eb

Response sample

200 OK

{
  "item": {
    "id": 185,
    "userId": "158a190e-c4a9-4e6c-bf9b-4ef74ae345eb",
    "username": "[email protected]",
    "status": "NEW",
    "is2fa": false,
    "isDeleted": false,
    "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4",
    "createAt": "2025-01-28T12:53:10Z",
    "updateAt": "2025-10-27T13:39:33Z",
    "name": "111",
    "lastname": "222",
    "comment": "test",
    "parameters": {
      "mfa": {
        "requireOtp": false,
        "requirePass": false,
        "requireEmail": false,
        "requireSms": false
      },
      "profile": {
        "phone": "",
        "email": "",
        "dob": "1970-01-01T00:00:00Z",
        "country": "",
        "city": "",
        "postcode": ""
      }
    },
    "customers": [
      {
        "customerId": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "isOwner": true
      }
    ]
  }
}