These docs are for v3. Click to read the latest docs for v4.

Retrieve a contextualized user

This endpoint retrieves user data within a specific context, controlled by the scopes. All identified fields returned on the object reflect fields which are presently required to achieve access to the requested scopes.

The balances reflects the current custodialized ledger balances for this user. These are accessible for transfer and exchange by using the transfers API with a user SRN (user:US_111222) as the source or destination. Balances may be held in any Wyre-supported currency.

The depositAddresses shows the addresses (by blockchain) that this user is connected to. Sending currency to the declared addresses will (once confirmed) increase the custodial balances reflected on the user object.

As with the rest of the User APIs, this endpoint requires masquerading.

Language
Credentials
Header
Click Try It! to start a request and see the response here!