Integration Guide

This guide walks you through integrating the CRYMBO Oracle into your existing systems. Whether you use the REST API, SDK, or webhook-based integration, this document covers the complete technical flow.

Integration Options

Method	Best For	Complexity
REST API	Full control, custom implementations	Medium
Oracle SDK (@crymbo/oracle-sdk)	Fastest integration, pre-built methods	Low
Webhooks	Event-driven systems, real-time notifications	Low
Smart Contract Hooks	On-chain native compliance enforcement	High

Prerequisites

Before integrating, ensure you have:

• ✅ Completed KYB Verification
• ✅ Registered at least one wallet
• ✅ Published your encryption keys
• ✅ Obtained API credentials from the CRYMBO Platform

Quick Start (SDK)

npm install @crymbo/oracle-sdk

const { CrymboOracle } = require('@crymbo/oracle-sdk');

const oracle = new CrymboOracle({
  apiKey: 'YOUR_API_KEY',
  environment: 'production' // or 'sandbox'
});

// Check compliance status before executing a transaction
const result = await oracle.validateTransaction({
  senderWallet: '0x...',
  receiverWallet: '0x...',
  amount: '1000',
  asset: 'USDC',
  chain: 'ethereum'
});

if (result.status === 'compliant') {
  // Proceed with transaction
} else {
  // Handle compliance failure
}

API Authentication

All API requests require authentication via API key in the header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.crymbo.link/v1/oracle/validate

Webhook Setup

Configure webhooks to receive real-time notifications:

{
  "url": "https://your-domain.com/webhooks/crymbo",
  "events": [
    "identity.request.received",
    "identity.exchange.completed",
    "compliance.check.passed",
    "compliance.check.failed",
    "transaction.validated"
  ]
}

Testing in Sandbox

The sandbox environment mirrors production but uses testnet tokens and simulated identity data. Use it to:

• Test your integration end-to-end
• Validate identity exchange flows
• Verify webhook delivery
• Test error handling

Sandbox base URL: https://sandbox-api.crymbo.link/v1/

Next Steps

• Identity Exchange → — Understand how identity data flows between parties
• API Usage → — Full API reference and usage patterns
• Compliance Flow → — End-to-end compliance enforcement walkthrough