Quick Start

Getting Started with SphereNet

Step 1: Institution Registration

Register your financial institution at dashboard.sphere.net. Our team will guide you through the onboarding process, including necessary compliance documentation.

Step 2: API Access

After registration approval:

1. Access your institution dashboard
2. Visit the "Security & Access" section
3. Generate production API credentials
4. Store your credentials securely - they cannot be retrieved later

GET v1/spherenet/network/status

# Verify API access
curl -G https://api.sphere.net/v1/network/status \
     -H 'Authorization: Bearer <API_KEY>'

Step 3: Customer Registration

Register your customers through our API:

POST v1/customers

curl https://api.sphere.net/v1/customers \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Idempotency-Key: <Unique Idempotency Key>' \
  -d '{
    "type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "phone": "+12223334444",
    "address": {
      "line1": "123 Market Street",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "USA"
    },
    "birth_date": "1990-01-01",
    "taxIdentificationNumber": "111-11-1111"
  }'

Step 4: Initiate a Network Transactions

Execute your first on-network transaction after customer verification:

POST v1/transactions

curl https://api.sphere.net/v1/transactions \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Idempotency-Key: <Unique Idempotency Key>' \
  -d '{
    "amount": "100.00",
    "customer": "cust_alice",
    "source": {
      "paymentRail": "spherenet",
      "currency": "usd",
      "account": "sphere1abc..."
    },
    "destination": {
      "paymentRail": "spherenet",
      "currency": "usd",
      "account": "sphere1xyz..."
    }
  }'

Response

{
  "ok": true,
  "object": "object",
  "statusCode": 200,
  "error": null,
  "message": "success",
  "data": {
    "id": "txn_123",
    "state": "processing",
    "customer": "cust_alice",
    "amount": "100.00",
    "source": {
      "paymentRail": "spherenet",
      "currency": "usd",
      "account": "sphere1abc..."
    },
    "destination": {
      "paymentRail": "spherenet",
      "currency": "usd",
      "account": "sphere1xyz..."
    },
    "networkData": {
      "signature": "2id3YC2jK9G5Wo2phDx4gJVAew8DcY5NAojnVuao8aCxBwKE7k4PoHiH1ViQX8KgB9CKBY2RcKF8PSbBqhqFQXXX",
      "slot": 430,
      "confirmations": 1,
      "commitment": "processed",
      "error": null
    },
    "createdAt": "2024-01-20T19:39:14.316Z",
    "updatedAt": "2024-01-20T19:39:14.316Z"
  },
  "ts": "2024-08-22T16:15:42.707Z",
  "request": "request_cdde26b2c0534183a1aaba6baebaec1f"
}

You've now completed your first SphereNet transaction. Explore our documentation to learn more about advanced features, compliance capabilities, and integration options.