User Account Information API
Retrieve the current user’s account details using an access token.
Check key attributes such as subscription plan, verification status, and regional settings to drive your application logic.
This API is available on the Personal plan or higher.
/api/user/v1/get
X-Access-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
No Request Parameters
{
"code": 0,
"message": "",
"result": {
"eml": "your@gmail.com",
"nm": "Tester",
"planNm": "BUSINESS",
"planExpires": "2025-12-31",
"locale": "en_US",
"timeZone": "America/New_York",
"emlVerifiedYn": "Y",
"twoAuthYn": "N",
"sinYmdt": "2025-10-08 03:36:28",
"regYmdt": "2019-08-13 12:13:01"
}
}
Response Parameters
- codeinteger
- Response code: 0 = Success, any other value = Error
- messagestring
- Response message. If the response code is not 0, an error-related message is returned.
- resultobject
- eml string
- User email.
- nm string
- User name.
- planNm string
- Current subscription plan.
- planExpires date
-
Plan expiration date.
Expires at 00:00 based on Korea Standard Time (UTC +09:00). - locale string
- Language and region of the user account.
- timeZone string
-
Time zone.
Language, region, and time zone can be changed on the [Settings → Profile] page. - emlVerifiedYn string
- Default:N
-
Enum:
YN
-
Email verification status.
Y: Verified, N: Not verified. - twoAuthYn string
- Default:N
-
Enum:
YN
-
Two-factor authentication usage.
Y: Enabled, N: Disabled. - sinYmdt datetime
- Last login date and time.
- regYmdt datetime
- Account creation date and time.
When to Use This API
Use this API when you need to display user details such as name or subscription tier in your service dashboard.
It is particularly useful for checking the plan expiration (planExpires) and whether two-factor authentication is enabled (twoAuthYn), enabling you to control access to features or guide users to strengthen security.
Use cases
The response data can be applied across multiple areas of your application logic.
- Apply feature restrictions based on subscription tier
- Control access based on authentication status
- Customize UI based on user region or language
- Require additional verification based on 2FA settings
In short, this API acts as a core input that drives application behavior.
Relationship with Authentication API
This API can only be used after calling the Authentication API.
Typical flow:
- Call Authentication API → receive token
- Include token → retrieve user information
In short:
- Authentication API → obtain access authorization
- Lookup API → use user data
Key Points for Production Use
This API is not just a simple lookup. It is a core API that connects service policies with user state.
- Plan-based billing logic
- Security policy enforcement
- User experience optimization
- Feature access control
It serves as a foundational data source for all service logic.
Things to consider
- Requests will fail if the token is expired.
- Do not expose sensitive data directly on the client.
- When caching is used, user state changes may not be reflected immediately.
- Always handle logic based on the verification status (
emlVerifiedYn).