Using Users API

📘

Contents:

1. Definitions
2. Overview
3. Scopes
4. User Statuses
5. Fields
6. Field IDs
7. Field Types

Definitions

• User: the end-user originating the request
• Partner: You, the Wyre integrator!
• Field: A bucket for a specific piece of user data
• Scope: A specific segment of functionality on the Wyre platform

Overview

The basic process looks like this:

1. Create User
2. Get Approved
3. Transfer!

Step 1: Creating the User

Call the create user API endpoint to create the user. This call will return a set of fields contextualized by the scopes parameter provided. User creation also may include blockchain address generation if desired.

Step 2: Get Approved

After the user is created, all user API calls require you to use masquerading on your requests. This simple pattern helps to firewall permission boundaries between users and your partner-level API credentials.

Approvals in the users system exist only in the context of scopes. The specific user requirements enforced for a given scope are determined by your partner agreement with Wyre. Because end-user requirements differ across available Wyre functionality, scopes are used to constrain the API based on the specific intent of a single user.

Broadly, to achieve user approval:

1. Filter the fields returned by either create user or get user endpoints for those which are OPEN
2. Collect data for one or more of these open fields to your end user
3. Submit this data to Wyre
4. Repeat

When there are no longer any OPEN fields, the end user is done with their turn. Our system is diligently processing their information. After this stage:

• the user status may transition to APPROVED
• or the user status may transition to CLOSED if fraud/compliance problems have been detected. Wyre customer support followup is required
• or the user status may transition back to OPEN if correctable problems were detected

Step 3: Transfer!

Now that your user is approved, you may use the transfer API on their behalf! Remember to use masquerading for requests made on behalf of your users.

Users each have their own set of custodialized balances (including all our supported fiat and crypto). This is where funds are reflected which is sent to the blockchain addresses tied to the user. Users may be used as the source or destination via the transfer API to move and exchange these funds.

Scopes

User Statuses

Fields

Field IDs

The field IDs your specific integration has to support depend on your integration type.

Field Types

The field type is hard-coded to each field ID and determines the JSON format and upfront validation rules on it.