v1

latestOpenAPI 3.0.32026-07-2485236250.4 KB

User Management

[V2] Get user

Retrieves extended user account information including verification status, documents, external provider integrations, and available capabilities.

get/api/v2/user

Response

chain_idinteger

Chain ID where the user account was registered

idstring

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.

ownerstring

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.

user_addressstring

EOA of the user that owns this account. Preferred field; owner mirrors the same value for backward compatibility.

user_idstring

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

Example response

{
  "capabilities": [
    {
      "status_reason": "Activation in progress, please wait for confirmation",
      "verification_requirements": [
        {
          "order": 1
        }
      ]
    }
  ],
  "chain_id": 8453,
  "external_providers": [
    {
      "account_id": "ext_123",
      "cpn": {
        "country": "US",
        "country_of_residence": "US",
        "date_of_birth": "1990-01-15",
        "originator_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Main Street",
          "line2": "Apt 4B",
          "post_code": "94105",
          "region": "CA"
        }
      },
      "wirex_app": {
        "sumsub_id": "5f9b3b3b3b3b3b3b3b3b3b3b",
        "user_id": "00000000-0000-0000-0000-000000000001"
      }
    }
  ],
  "id": "00000000-0000-0000-0000-000000000001",
  "owner": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "profile": {
    "date_of_birth": "1990-01-15",
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "nationality": "US",
    "phone_number": "+14155551234"
  },
  "residence_address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "post_code": "94105",
    "state": "CA"
  },
  "user_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "user_id": "00000000-0000-0000-0000-000000000001",
  "verification": {
    "documents": [
      {
        "added_date": "2024-01-15T10:30:00Z",
        "file_type": "pdf",
        "id": "doc_123",
        "type": "passport"
      }
    ],
    "levels": [
      {
        "name": "Basic KYC"
      }
    ]
  }
}