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

Upload User Data

Submit user-provided KYC data

This endpoint is used to upload user data to Wyre on behalf of the end user. This includes name, address, email, or any other personal information required. User data only needs to be provided for those field IDs that are shown on the API in a given context.

The scopes parameter is used to control the context for the view of the user returned by this endpoint after the update has been submitted. It does not limit the fields that may be updated, nor affect any permanent attribute of the user.

By default, this endpoint waits up to 5 seconds for processing on the account to complete. You may disable this by using the immediate parameter. In cases where processing has not yet completed, the status on the returned user will appear as PENDING. In these cases you should rely on webhooks for notification of state changes (or, less desirably, you can poll).

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

Path Params
string
required

Identifier of the user to update

Body Params
blockchains
array of strings
Defaults to []

List of blockchains to connect the user to. Supported: BTC, ETH, ALL. Defaults to none (empty list).

blockchains
boolean
Defaults to false

If true, returns immediately. This skips the default behavior of waiting up to 5 seconds for processing to complete, and so will always result in a PENDING user.

scopes
array of strings

Array of scopes to bias the view returned after the user is created. Only valid scope is currently TRANSFER

scopes
Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json