Working with User Profile
Retrieve user information, verification status, and capabilities.
Before You Start
Read the following guides before proceeding:
| Guide | Why |
|---|---|
| Getting Started | Platform overview and setup |
| Api Basics | Required headers and request configuration |
| Authentication | How to obtain access tokens |
| Webhooks | Receive status notifications |
| Onboarding | User and wallet registration |
The User Profile section provides access to account information, verification status, and capabilities. Each user has a profile containing personal information submitted during KYC, a verification status indicating their identity verification progress, and a set of capabilities that determine which features they can access.
Capabilities are the core mechanism for feature gating. Each capability represents a specific action (e.g., sending SEPA transfers, issuing cards) and has a status indicating whether the user can perform that action. Capabilities have prerequisites (other capabilities that must be active first) and verification requirements (KYC levels that must be completed). Your application should query capabilities to determine which features to expose to each user.
User Profile Flow (Simplified)
Detailed documentation available in User Information and Capabilities.
sequenceDiagram
participant User
participant App as Your App
participant BaaS as Wirex BaaS
Note over User,BaaS: Get User Profile
User->>App: Open profile
App->>BaaS: GET /api/v2/user
BaaS-->>App: profile, verification, capabilities[]
App-->>User: Display info
Note over User,App: Check Capabilities
User->>App: Want to send SEPA
Note right of App: Check SepaOut1stParty<br/>capability status
Note right of App: If Active: allow<br/>If NotFulfilled: show requirements
App-->>User: Action or prompt
| Step | Action | Description |
|---|---|---|
| 1 | GET /api/v2/user | Retrieve full user profile with capabilities |
| 2 | Check capability | Determine feature availability from capabilities array |
Updated 8 days ago
