Skip to main content
GET
Get Detailed User Information

Get Detailed User Information

This endpoint retrieves more sensitive and detailed profile information for the user associated with the provided access token. Access to this endpoint is restricted and requires specific permissions beyond basic user authentication.

Authorization Headers

string
required
The Bearer token for authentication. Example: Bearer {YOUR_ACCESS_TOKEN}
string
default:"application/json"
Specifies the desired response format.

Required Scope & Special Approval

  • Scope: detail-user
  • Admin Approval: Access to the detail-user scope (and thus this endpoint) requires explicit administrative approval for your client application. Requesting the detail-user scope during the OAuth flow is not sufficient on its own.
Administrative Approval Required: Attempting to access this endpoint with an access token that includes the detail-user scope will still result in a 403 Forbidden error if your application has not been granted administrative approval for this level of data access. Please refer to the Scopes and Permissions documentation for details on the approval process.

Request Examples

JavaScript/Node.js

Python

PHP

cURL

Successful Response (200 OK)

A successful request returns a JSON object containing the user’s detailed profile information. This includes all fields from the Basic User Information endpoint, plus the additional sensitive fields listed below. Additional Response Fields:
string
A short biography or description from the user. May be null.
string
The user’s verified phone number. This is the primary identifier for WhatsApp-registered users. May be null if not provided.
string
The user’s place of birth. May be null.
string
The user’s date of birth in YYYY-MM-DD format. May be null.
string
The user’s physical address. May be null.
The availability of these fields depends on what information the user has provided to Mubarokah ID and the specific permissions granted. For WhatsApp-only registration, email in basic info will be null, while phone_number here will be populated.

Example Successful Response

Error Responses

Common Error Responses

Cause: Access token is missing, invalid, or expired.
Or for expired tokens:
Resolution: Refresh the access token or re-authenticate the user.

Rate Limiting

This endpoint has stricter rate limiting due to the sensitive nature of the data:
  • Limit: 50 requests per minute per access token (lower than basic endpoints)
  • Reset: Rate limit resets every minute
  • Headers: Check X-RateLimit-Remaining and X-RateLimit-Reset response headers

Testing and Development

Development Checklist

Before testing this endpoint, ensure:
1

Basic Integration Working

Your application can successfully authenticate users and access the basic /api/user endpoint
2

Scope Request

Your OAuth authorization URL includes detail-user in the scope parameter:
3

Admin Approval

Your application has been approved for the detail-user scope through the administrative process
4

Error Handling

Your application gracefully handles unapproved_scope errors and provides appropriate user feedback

Integration Testing Script

Production Monitoring

Refer to the general Error Codes section for more details on other possible errors.