WIwirexapp
User Management

Get user

Retrieves the user data stored in Wirex system

get/api/v1/user

Request

  • Base URL
    https://api-baas.wirexapp.com
  • URL
    https://api-baas.wirexapp.com/api/v1/user
  • Auth
    • API key in header Authorization
    • or API key in header X-Chain-Id and API key in header X-User-Wallet and API key in header Authorization

Request body */*

RequestEmptyRequest required

Response

OK

emailstring required
freshdesk_idstring
idstring required

Deprecated: still populated for backward compatibility, but consumers should read user_id — this field carries the user's UUID, which is now exposed as user_id.

user_addressstring

EOA of the user. Preferred field; wallet_address mirrors the same value for backward compatibility.

user_idstring required

UserId is the UUID identifier of the user. Preferred field; id mirrors the same value for backward compatibility.

user_status'Active' | 'Blocked' | 'Deleted' | 'Pending' required
verification_status'None' | 'Pending' | 'Approved' | 'Rejected' | 'Canceled' | 'Applied' | 'InReview' required
wallet_addressstring

Deprecated: still populated for backward compatibility, but consumers should read user_address — this field carries the user's EOA, which is now exposed as user_address.

Example response

{
  "capabilities": [
    {
      "status_reason": "Activation in progress, please wait for confirmation",
      "verification_requirements": [
        {
          "order": 1
        }
      ]
    }
  ],
  "email": "a.grey@wirexpay.com",
  "freshdesk_id": "1234567890",
  "id": "00000000-0000-0000-0000-000000000001",
  "personal_info": {
    "first_name": "Alex",
    "last_name": "Grey",
    "nationality": "FR"
  },
  "phone_number_data": {
    "is_confirmed": true,
    "phone_number": "+61412345678"
  },
  "residence_address": {
    "city": "Paris",
    "country": "FR",
    "line1": "Rue di Pisa",
    "line2": "Apt 123",
    "state": "Ile de France",
    "zip_code": "75001"
  },
  "user_actions": [
    {
      "relative_path": "/api/v1/user/phone-number/confirm"
    }
  ],
  "user_address": "0xA72737465737465642048617368204279746573",
  "user_id": "00000000-0000-0000-0000-000000000001",
  "wallet_address": "0xA72737465737465642048617368204279746573"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.