WakaPay Docs

API Reference

Users

← All tags

Purpose

This group contains endpoints tagged together in the OpenAPI spec. Use the summaries below to understand what each endpoint does.

When to use

  • Prefer calling APIs from your backend to avoid exposing secrets.
  • Handle errors consistently and log request IDs for support.

Endpoints (10)

Click an endpoint to jump to its details.

post/users/{userId}/admin-restore-activities
Auth

Admin: restore activities for a user (e.g. after lock from 2 token suspends in 5 mins)

post/users/add-fiat-account
Auth

Add fiat account to user

get/users/me
Auth

Get current user

patch/users/me
Auth

Update current user

post/users/me/become-merchant
Auth

Become a merchant

post/users/me/change-password
Auth

Change password (passkey or 2FA always required)

get/users/me/phone-history
Auth

Historic list of phone numbers for the current user

post/users/me/restore-activities
Auth

Restore withdrawals and transfers (step-up: passkey, 2FA, or PIN). Use after suspending via alert link or POST /users/me/suspend-activities.

post/users/me/suspend-activities
Auth

Suspend withdrawals and transfers (step-up required). Restore later via POST /users/me/restore-activities.

get/users/search
Auth

Search users

post/users/{userId}/admin-restore-activities

Admin: restore activities for a user (e.g. after lock from 2 token suspends in 5 mins)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_adminRestoreActivitiestag: Userspermalink
post/users/add-fiat-account

Add fiat account to user

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_addFiatAccounttag: Userspermalink
get/users/me

Get current user

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_getMetag: Userspermalink
patch/users/me

Update current user

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_updateMetag: Userspermalink
post/users/me/become-merchant

Become a merchant

Auth

Adds the merchant role to the current user. Idempotent if already a merchant. Optional body for business info.

operationId: UsersController_becomeMerchanttag: Userspermalink
post/users/me/change-password

Change password (passkey or 2FA always required)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_changePasswordtag: Userspermalink
get/users/me/phone-history

Historic list of phone numbers for the current user

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_getMyPhoneHistorytag: Userspermalink
post/users/me/restore-activities

Restore withdrawals and transfers (step-up: passkey, 2FA, or PIN). Use after suspending via alert link or POST /users/me/suspend-activities.

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_restoreActivitiestag: Userspermalink
post/users/me/suspend-activities

Suspend withdrawals and transfers (step-up required). Restore later via POST /users/me/restore-activities.

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_suspendActivitiestag: Userspermalink
get/users/search

Search users

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: UsersController_searchUserstag: Userspermalink