BringYour (2023.12.19)

Get network statistics for the last 90 days. The statistics are updated approximately every 60s.

Get statistics for all providers in the caller network for the last 90 days. This is meant to answer the top level question of how the providers in a network are performing.

Get all providers in the caller network. Each provider includes stats from the last 24 hours.

Get detailed stats on a single provider in the caller network. This is meant to give the user complete visibility over usage.

Start a login for a user authority. The user authority may be:

• email
• phone number
• Apple JWT
• Google JWT

Password login for email and phone number.

Verify ownership of email or phone number.

Send verification code to email or phone number.

Send password reset code to email or phone number.

Change password.

Check if the network name is available. A new network name must satisfy:

• at least 3 characters different from an existing network name
• at least 8 characters
• domain name compatible (see RFC 5890)
• not contain the dash (-) character (BringYour subdomains are reverse-flattened to a single level using dashes)

Create a new network. A user authority can be associated with at most one network.

Create a limited use code (auth code) to share authentication with connected apps and tools. The code is tied to the caller session, and will be expired with any of the caller's sessions. Currently a code cannot be created for a client JWT (from /network/auth-client). This is a subset of an OAuth flow.

Authenticate with an auth code. The returned session is tied to the session that created the auth code, and will be expired with any of the creator's sessions. This is a subset of an OAuth flow.

Gain permission to use the connect protocol as the requested clientId, or assign a new clientId. Each network can have at most 128 clientIds. Above that number, new clientId requests will error until one or more existing clientIds are removed.

Remove a client from the network.

Get the latest status of all clients on this network.

Includes:

• Resident status, which is the platform counterpart for the client that handles control commands.
• Connections, which are transports from the client to the platform. Note there can be multiple active connections for a single client.
• Provide status

Set account preferences.

Feedback.

A list of locations and groups where there are at least one active provider in good health. Note that a location or group will need to be mapped to an actual provider using /network/find-providers.

Search for locations and groups that match a query, where there are at least one active provider in good health. The match algorithm accounts for typos and misspelling, and the tolerance can be tuned in the input. Note that a location or group will need to be mapped to an actual provider using /network/find-providers.

Search for locations, groups, and devices that match a query, regardless of whether an providers are active.

Randomly sample providers that for a location or group, which are active and in good health. This allows random iteration by using the exclude input to mark visited providers.

Randomly sample providers for locations, groups, or devices, which are active and in good health. This allows random iteration by using the exclude input to mark visited providers.

Create a spec object for find-providers2 using a description of the intended use of the network.

Get the balance for the USDC user custody wallet. The user custody wallet allows BringYour to query the balance, but the user must take actions against the wallet.

Validate a USDC wallet address on the user custody wallet chain. This can be used to check whether an address can receive a transfer out from the user custody wallet. Please use this before initiating any transfer out to avoid lost funds.

Initialize the Circle USDC user self custody wallet. This starts a process that must be completed by the user.

Set up a transfer from the Circle USDC user self custody wallet to an address. This starts a process that must be completed by the user.

Get the current subscription status and transfer balance.

Check if the balance code is valid.

Redeem the balance code and add the transfer balance to the caller network.

Creates an anonymous payment identifier to be used with purchases. This keeps network information out of the payment processor system. For example in Google Play this is called the "obfuscated account id".

Add a device, which can either be owned by the network or shared with the network. The code provided can be either adoption code or a share code. Once a code is added, the device becomes an associated device until confirmation. If the device is a shared device, it will remain an associated device after confirmation.

Creates a code to share a device.

A QR code that maps to a URL to add the shared device. Send it to someone to scan to add the device.

The status of the shared device. The status can be one of:

• unassociated
• associated pending confirmation
• associated

Confirm the share of a device. This must be called from the side that initiates the share.

Creates a code to adopt a device. The adopt code is valid for a limited time.

A QR code that maps to a URL to adopt the device. Send it to someone to scan to adopt the device.

The status of the adopt-code device. The status can be one of:

• unassociated
• associated pending confirmation
• associated

Confirm the adoption of a device. This must be called from the side that initiates the adoption.

Remove an adopt code. This must be called from the side that initiates the adoption.

The devices associated with the caller network. Associated devices are:

• pending adoption devices
• incoming shared devices (not owned by the caller network)
• outgoing shared devices (owned by the caller network)

Remove a device association. The association can be any of:

• pending adoption device
• incoming shared device (not owned by the caller network)
• outgoing shared device (owned by the caller network)

Set the name of the association. To set the name of devices owned by the network, use /device/set-name.

Sets the name of a device owned by the network. To set the name of devices shared with the network, use /device/set-association-name.

Set the provide mode for a device.

Out-of-band control messages for the connect protocol. Blocking request-response control messages need to be handled out-of-band to resolve the possibility of dedlocks in the client sequence.