Files
dbis_core/docs/IRU_QUICK_START.md
2026-03-02 12:14:07 -08:00

2.8 KiB

IRU Quick Start Guide

Get Started with DBIS IRU in 5 Minutes

For Central Banks & Financial Institutions

Step 1: Browse Marketplace

Visit the Sankofa Phoenix Marketplace:

https://marketplace.sankofaphoenix.com

Browse IRU offerings by capacity tier:

  • Tier 1: Central Banks
  • Tier 2: Settlement Banks
  • Tier 3: Commercial Banks
  • Tier 4: Development Finance Institutions
  • Tier 5: Special Entities

Step 2: Submit Inquiry

  1. Select your IRU offering
  2. Click "Request Information"
  3. Fill out inquiry form:
    • Organization name
    • Institutional type
    • Jurisdiction
    • Contact information
    • Estimated transaction volume

Step 3: Complete Qualification

  1. Receive acknowledgment (within 24 hours)
  2. Provide preliminary information
  3. Automated qualification assessment
  4. Receive qualification result

Step 4: Execute Agreement

  1. Review IRU Participation Agreement
  2. E-signature via DocuSign/HelloSign
  3. Agreement executed

Step 5: Deploy Infrastructure

  1. One-click deployment from portal
  2. Automated container provisioning
  3. Network configuration
  4. Service activation
  5. Health verification

Step 6: Integrate

  1. Choose integration method:

    • Pre-built connector (if available)
    • Custom connector (using SDK)
    • Direct API integration
  2. Configure connection:

    import { IRUClient } from '@dbis/iru-sdk';
    
    const client = new IRUClient({
      apiBaseUrl: 'https://api.dbis.org',
      apiKey: 'your-api-key',
    });
    
  3. Test integration:

    const health = await client.getServiceHealth(subscriptionId);
    console.log('Service health:', health);
    

For Developers

Install SDK

TypeScript/JavaScript:

npm install @dbis/iru-sdk

Python:

pip install dbis-iru-sdk

Java:

<dependency>
  <groupId>org.dbis</groupId>
  <artifactId>iru-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

.NET:

dotnet add package DBIS.IRU.SDK

Use SDK

import { IRUClient } from '@dbis/iru-sdk';

const client = new IRUClient({
  apiBaseUrl: 'https://api.dbis.org',
  apiKey: process.env.DBIS_API_KEY,
});

// Get offerings
const offerings = await client.getOfferings({
  capacityTier: 1,
  institutionalType: 'CentralBank',
});

// Submit inquiry
const inquiry = await client.submitInquiry({
  offeringId: 'IRU-OFF-001',
  organizationName: 'Central Bank of Example',
  institutionalType: 'CentralBank',
  jurisdiction: 'US',
  contactEmail: 'contact@centralbank.gov',
  contactName: 'John Doe',
});

// Get dashboard
const dashboard = await client.getDashboard();

// Monitor services
const health = await client.getServiceHealth(subscriptionId);

Support

  • Documentation: https://docs.dbis.org/iru
  • Support Portal: Phoenix Portal
  • Email: iru-support@dbis.org