Getting Started

Follow these steps to begin using RoxCustody, register your corporate account, complete onboarding in your corporate portal, generate your API key, and find your API base URL.

ℹ

Before you start. To begin using RoxCustody, you must first register a corporate account. Your account will be reviewed and approved before you receive access to your corporate portal.

Setup Steps

Register a corporate account

Sign up at roxcustody.com/auth/register and complete the corporate registration form. After your corporate account is reviewed and approved, you will receive an email containing your corporate URL, one for each environment.

Your corporate URL
BASH
# After your corporate account is reviewed and approved, you'll
# receive an email containing your corporate URL:
 
# Production
https://YOUR-SUBDOMAIN.roxcustody.io
 
# Sandbox
https://YOUR-SUBDOMAIN.sandbox.roxcustody.io

Log in to your corporate portal

Open your corporate URL and log in using the credentials you created during signup. All remaining onboarding steps happen inside the corporate portal.

Create at least two SCMS instances

Create at least two SCMS (Self Custody Manager) instances in your corporate portal.

⚠

A minimum of two SCMS (Self Custody Manager) instances is required before you can create your first vault.

Create your first Vault

With your SCMS instances in place, create your first Vault from the corporate portal. The vault is where your API credentials are configured in the next step.

Generate your API Key

From the Vault actions menu (⋯), open Configure API to generate your API Key.

Important: the API key generated from Configure API is used only once, to generate an access token and a refresh token. After that, all API requests must use the access token, and expired access tokens must be renewed using the rotating refresh token. See Authentication for the full flow.

Base URL

The base URL for all API requests depends on your environment:

Environment	Base URL
Production	`https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration`
Sandbox	`https://YOUR-SUBDOMAIN.api-sandbox.roxcustody.com/api/integration`

Production

BASH

# Production base URL for all API requests

https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration

Sandbox

BASH

# Sandbox base URL for all API requests

https://YOUR-SUBDOMAIN.api-sandbox.roxcustody.com/api/integration

Replace YOUR-SUBDOMAIN with your assigned corporate subdomain.

What's next?

Authentication →

Exchange your API key for tokens and sign requests

Auth API Reference →

Full reference for the authentication endpoints