Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Alejandrin08/Hackathon-SPEI/llms.txt

Use this file to discover all available pages before exploring further.

Both endpoints require a valid JWT Bearer token. See Login to obtain one.

​
Endpoints

MethodPathDescription
GET/api/profile/meRetrieve the authenticated user’s profile
PUT/api/profile/meUpdate the authenticated user’s profile

​
GET /api/profile/me

Returns profile data for the currently authenticated user.

​
Response

​
200 OK

​
id
string
required
UUID of the authenticated user.
​
alias
string
required
Display name for the user (set during registration as userName).
​
email
string
User’s registered email address.
​
phoneNumber
string
User’s phone number, if set.
​
preferredLanguage
string
required
Preferred UI language, e.g., "es-MX".
​
demoMode
boolean
required
Whether the account is in demo/sandbox mode.

​
Example

curl -X GET http://localhost:5000/api/profile/me \
  -H "Authorization: Bearer <token>"

​
PUT /api/profile/me

Updates the profile of the currently authenticated user. Only provided fields are updated.

​
Request body

​
email
string
Updated email address. Must be a valid email format.
​
phoneNumber
string
Updated phone number. Must be a valid phone format.
​
preferredLanguage
string
Updated preferred UI language, e.g., "es-MX" or "en-US".

​
Response

​
200 OK

Returns the updated user profile with the same structure as GET /api/profile/me.

​
Error responses

StatusDescription
400 Bad RequestValidation error — invalid email or phone format.
401 UnauthorizedInvalid or expired token.

​
Example

curl -X PUT http://localhost:5000/api/profile/me \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "maria.lopez@example.com",
    "phoneNumber": "+52 55 1234 5678",
    "preferredLanguage": "es-MX"
  }'

Build docs developers (and LLMs) love

Get started for freeTalk to us