Skip to main content
Base URL: https://your-domain.com/api
All endpoints on this page require Authorization: Bearer {token}.

​
GET /get-user-profile

Returns full profile details for the authenticated user, including address, timezone, wallet list, and available countries.

​
Request parameters

​
user_id
number
required
The authenticated user’s ID.

​
Response fields

​
success
object
curl --request GET \
  --url 'https://your-domain.com/api/get-user-profile?user_id=42' \
  --header 'Authorization: Bearer {token}'

​
POST /update-user-profile

Updates profile details including name, email, phone, address, timezone, and default wallet.

​
Request parameters

​
user_id
number
required
The authenticated user’s ID.
​
first_name
string
required
First name.
​
last_name
string
required
Last name.
​
email
string
required
Email address.
​
phone
string
Phone number. Spaces and hyphens are normalized.
​
formattedPhone
string
Phone in international format (e.g. +11234567890).
​
user_defaultCountry
string
ISO country code for the phone number.
​
user_carrierCode
string
Dial code prefix (e.g. +1).
​
country
number
Country ID from /get-user-profile countries list.
​
address
string
Street address.
​
city
string
City.
​
state
string
State or province.
​
timezone
string
PHP timezone string.
​
defaultWallet
number
Wallet ID to set as default.

​
Response fields

​
success
object
curl --request POST \
  --url https://your-domain.com/api/update-user-profile \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": 42,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "[email protected]",
    "timezone": "America/New_York"
  }'

​
POST /profile-image-upload

Uploads a profile picture. Accepted formats: png, jpg, jpeg, gif, bmp. The image is resized to 98×98 px (full) and 70×70 px (thumbnail).

​
Request parameters

​
user_id
number
required
The authenticated user’s ID.
​
file
file
required
Image file (multipart/form-data).

​
Response fields

​
success
object
​
filename
string
The generated filename stored on the server.
curl --request POST \
  --url https://your-domain.com/api/profile-image-upload \
  --header 'Authorization: Bearer {token}' \
  --form 'user_id=42' \
  --form 'file=@/path/to/photo.jpg'

​
POST /update-password

Changes the authenticated user’s password.

​
Request parameters

​
user_id
number
required
The authenticated user’s ID.
​
oldPassword
string
required
Current password.
​
password
string
required
New password.
​
passwordConfirmation
string
required
New password confirmation. Must match password.

​
Response fields

​
success
object
curl --request POST \
  --url https://your-domain.com/api/update-password \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": 42,
    "oldPassword": "current-secret",
    "password": "new-secret",
    "passwordConfirmation": "new-secret"
  }'

​
POST /profile/duplicate-email-check

Checks whether an email is already taken by another user, excluding the current user.

​
Request parameters

​
user_id
number
required
The current user’s ID (excluded from the check).
​
email
string
required
Email address to check.

​
Response fields

​
status
boolean
true if the email is already taken by another user.
​
fail
string
Error message when status is true.
​
success
string
Success message when status is false.
curl --request POST \
  --url https://your-domain.com/api/profile/duplicate-email-check \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{"user_id": 42, "email": "[email protected]"}'

​
GET /get-user-specific-details

Returns receiver or requester details based on a transaction reference. Used to show recipient info after a send or request-money action.

​
Request parameters

​
user_id
number
required
The authenticated user’s ID.
​
type
string
required
Context type. One of sendMoney, requestMoneyCreate, requestMoneyAccept.
​
tr_ref_id
number
Transaction or request payment ID. Required when type is sendMoney, requestMoneyCreate, or requestMoneyAccept.
​
email
string
Email address lookup. Used when type is not one of the above.

​
Response fields

​
success
object
curl --request GET \
  --url 'https://your-domain.com/api/get-user-specific-details?user_id=42&type=sendMoney&tr_ref_id=101' \
  --header 'Authorization: Bearer {token}'

Build docs developers (and LLMs) love

Get started for freeTalk to us