For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Profile

Retrieves authenticated user and partner profile information, including 2FA status.

Endpoint

GET/v2/auth/profile

Link


Request

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns user and partner details in a structured JSON object.

Response Fields

1. Partner Object

Field
Type
Description
Example

id

string

Unique partner ID.

"a2813d61-51a3-487f-b5bb-3aea43dd2581"

name

string

Partner company name.

"Acme Inc."

email

string

Partner contact email.

"[email protected]"

phone

string

Partner contact phone.

"+1234567890"

2. User Object

Field
Type
Description
Example

id

string

Unique user ID.

"2e325799-392d-41d4-8dd6-6cea890c6982"

name

string

User's full name.

"John Doe"

email

string

User's email.

"[email protected]"

phone

string

User's phone number.

"+1987654321"

is2FA

boolean

2FA enabled status (true/false).

true

Example Response:

Error Responses

  1. Invalid/Missing Token:

  2. Expired Token:


Notes

  • Permissions:

    • Requires an active session (valid JWT).

    • Partner details are only included for business accounts.

  • 2FA Status:

    • is2FA: true means the user must provide OTP codes for login.

Examples

Real request

Real response

200 OK

Last updated