Riskify
Docs/Integration & APIs
On this page

Integration Guide

← Risk Management | Technical Reference →

Overview

This guide explains how to integrate with the Riskify system, connecting pools, risk engines, oracles, and external data sources for seamless, automated risk management. Integration in Riskify means enabling your contracts, pools, or external systems to interact with the platform's risk, pool, and oracle modules—ensuring data flows, risk scoring, and automation work together for robust, real-time insurance and reinsurance operations.

Table of Contents

Getting Started

This section provides a high-level view of the integration process, from initial contract setup to monitoring and reporting. The diagram below shows the three main phases: setup, integration, and monitoring.

Integration Flow

System diagram
Diagram source
graph TB
    %% Styling
    classDef setup fill:#2ecc71,stroke:#27ae60,color:white,stroke-width:2px,font-weight:bold
    classDef integration fill:#3498db,stroke:#2980b9,color:white,stroke-width:2px,font-weight:bold
    classDef monitoring fill:#e74c3c,stroke:#c0392b,color:white,stroke-width:2px,font-weight:bold
    classDef node fill:#f8f9fa,stroke:#6c757d,color:#212529,stroke-width:1px
    
    %% Setup Components
    subgraph Setup["Setup Phase"]
        direction TB
        CON["Contract Setup"]
        AUTH["Authorization"]
        VAL["Validation"]
    end

    %% Integration Components
    subgraph Integration["Integration Phase"]
        POOL["Pool Integration"]
        RISK["Risk Integration"]
        ORACLE["Oracle Integration"]
    end

    %% Monitoring Components
    subgraph Monitoring["Monitoring Phase"]
        METRICS["Metrics"]
        ALERTS["Alerts"]
        REPORTS["Reports"]
    end

    %% Relationships
    Setup --> Integration
    Integration --> Monitoring
    
    %% Apply styles
    class Setup setup
    class Integration integration
    class Monitoring monitoring
    class CON,AUTH,VAL,POOL,RISK,ORACLE,METRICS,ALERTS,REPORTS node

Diagram: The integration process in Riskify, from contract setup and validation, through pool/risk/oracle integration, to ongoing monitoring and reporting.

Pool Integration

Pool integration connects your contracts or applications to Riskify's pool management system. This enables automated pool creation, configuration, and interaction with risk and market modules.

Pool Creation Flow

This sequence diagram shows the step-by-step process of creating a new pool, from client request to oracle setup and registration.

System diagram
Diagram source
sequenceDiagram
    participant Client
    participant Factory
    participant Pool
    participant Oracle
    
    Note over Client,Oracle: Pool Creation Process
    
    Client->>Factory: Create Pool
    Factory->>Pool: Initialize
    Pool->>Oracle: Setup Risk Oracle
    Oracle->>Pool: Confirm Setup
    Pool->>Factory: Register Pool
    Factory->>Client: Return Pool ID
    
    Note over Client,Oracle: Pool Creation Complete
    
    %% Styling
    rect rgb(46, 204, 113, 0.1)
        Note over Client,Oracle: Pool Creation Process
    end
    rect rgb(52, 152, 219, 0.1)
        Note over Client,Oracle: Pool Creation Complete
    end

Diagram: Pool creation flow, showing how a new pool is initialized, connected to an oracle, and registered in the system.

Pool Architecture

This diagram shows the main components of a pool in Riskify and how they interact with risk and market modules.

System diagram
Diagram source
graph TB
    %% Styling
    classDef core fill:#2ecc71,stroke:#27ae60,color:white,stroke-width:2px,font-weight:bold
    classDef risk fill:#e74c3c,stroke:#c0392b,color:white,stroke-width:2px,font-weight:bold
    classDef market fill:#3498db,stroke:#2980b9,color:white,stroke-width:2px,font-weight:bold
    classDef node fill:#f8f9fa,stroke:#6c757d,color:#212529,stroke-width:1px
    
    %% Core Components
    subgraph Core["Pool Core"]
        PS["Pool State"]
        PM["Pool Manager"]
        PC["Pool Config"]
    end

    %% Risk Components
    subgraph Risk["Risk Management"]
        RM["Risk Monitor"]
        RV["Risk Validator"]
        RA["Risk Adjuster"]
    end

    %% Market Components
    subgraph Market["Market Interface"]
        MI["Market Integration"]
        MT["Market Tracker"]
        MP["Market Processor"]
    end

    %% Relationships
    Core --> Risk
    Core --> Market
    Risk --> Market
    
    %% Apply styles
    class Core core
    class Risk risk
    class Market market
    class PS,PM,PC,RM,RV,RA,MI,MT,MP node

Diagram: Pool architecture, showing how the pool core connects to risk management and market modules for full lifecycle management.

Risk Integration

Risk integration enables your system to leverage Riskify's risk scoring, monitoring, and validation tools. This ensures that pools and contracts are continuously assessed and managed for risk.

Risk Flow

This diagram illustrates the flow of risk data and actions, from setup and scoring to monitoring, validation, and risk-based decisions.

System diagram
Diagram source
graph TB
    %% Styling
    classDef setup fill:#2ecc71,stroke:#27ae60,color:white,stroke-width:2px,font-weight:bold
    classDef flow fill:#3498db,stroke:#2980b9,color:white,stroke-width:2px,font-weight:bold
    classDef actions fill:#e74c3c,stroke:#c0392b,color:white,stroke-width:2px,font-weight:bold
    classDef node fill:#f8f9fa,stroke:#6c757d,color:#212529,stroke-width:1px
    
    %% Risk Setup
    subgraph RiskSetup["Risk Setup"]
        RS["Risk Scoring"]
        RM["Risk Monitoring"]
        RV["Risk Validation"]
    end

    %% Risk Flow
    subgraph RiskFlow["Risk Flow"]
        IN["Input Data"]
        PROC["Processing"]
        OUT["Output"]
    end

    %% Actions
    subgraph Actions["Risk Actions"]
        ACC["Accept Risk"]
        REJ["Reject Risk"]
        MOD["Modify Risk"]
    end

    %% Relationships
    RiskSetup --> RiskFlow
    RiskFlow --> Actions
    
    %% Apply styles
    class RiskSetup setup
    class RiskFlow flow
    class Actions actions
    class RS,RM,RV,IN,PROC,OUT,ACC,REJ,MOD node

Diagram: Risk integration flow, showing how risk is scored, monitored, validated, and acted upon in the system.

Oracle Integration

Oracle integration connects Riskify to external data sources (e.g., weather, market, industry) and enables on-chain contracts to access real-world data for risk assessment and automation.

Oracle Architecture

This diagram shows how external data is ingested, processed by the oracle system, and integrated into the Riskify platform.

System diagram
Diagram source
graph LR
    %% Styling
    classDef external fill:#2ecc71,stroke:#27ae60,color:white,stroke-width:2px,font-weight:bold
    classDef oracle fill:#3498db,stroke:#2980b9,color:white,stroke-width:2px,font-weight:bold
    classDef integration fill:#e74c3c,stroke:#c0392b,color:white,stroke-width:2px,font-weight:bold
    classDef node fill:#f8f9fa,stroke:#6c757d,color:#212529,stroke-width:1px
    
    %% External Data
    subgraph External["External Data Sources"]
        WD["Weather Data"]
        MD["Market Data"]
        ID["Industry Data"]
    end

    %% Oracle System
    subgraph OracleSystem["Oracle System"]
        GNN["GNN Oracle"]
        VAL["Validators"]
        AGG["Aggregator"]
    end

    %% Integration
    subgraph Integration["Integration Layer"]
        FEED["Data Feeds"]
        PROC["Processors"]
        OUT["Output"]
    end

    %% Relationships
    External --> OracleSystem
    OracleSystem --> Integration
    
    %% Apply styles
    class External external
    class OracleSystem oracle
    class Integration integration
    class WD,MD,ID,GNN,VAL,AGG,FEED,PROC,OUT node

Diagram: Oracle architecture, showing how external data is validated, aggregated, and fed into the Riskify integration layer for use by pools and risk modules.

Advanced Features

Advanced integration features include cross-chain transfers and bundle management, enabling more complex and scalable risk and capital flows.

Cross-Chain Integration

This sequence diagram shows how assets or risk positions are transferred across blockchains using bridges and validators.

System diagram
Diagram source
sequenceDiagram
    participant Source
    participant Bridge
    participant Target
    participant Validator

    Note over Source,Validator: Cross-Chain Transfer Process
    
    Source->>Bridge: Initiate Transfer
    Bridge->>Validator: Validate Request
    Validator->>Bridge: Confirm Validation
    Bridge->>Target: Execute Transfer
    Target->>Source: Confirm Receipt
    
    Note over Source,Validator: Transfer Complete
    
    %% Styling
    rect rgb(46, 204, 113, 0.1)
        Note over Source,Validator: Cross-Chain Transfer Process
    end
    rect rgb(52, 152, 219, 0.1)
        Note over Source,Validator: Transfer Complete
    end

Diagram: Cross-chain integration, showing the process of transferring assets or risk positions between blockchains with validation and confirmation.

Bundle Integration

This diagram shows the process of creating, optimizing, and transferring bundles of assets or risk positions in Riskify.

System diagram
Diagram source
graph TB
    %% Styling
    classDef creation fill:#2ecc71,stroke:#27ae60,color:white,stroke-width:2px,font-weight:bold
    classDef optimization fill:#3498db,stroke:#2980b9,color:white,stroke-width:2px,font-weight:bold
    classDef transfer fill:#e74c3c,stroke:#c0392b,color:white,stroke-width:2px,font-weight:bold
    classDef node fill:#f8f9fa,stroke:#6c757d,color:#212529,stroke-width:1px
    
    %% Bundle Creation
    subgraph BundleCreation["Bundle Creation"]
        BC["Create Bundle"]
        BA["Add Assets"]
        BV["Validate"]
    end

    %% Optimization
    subgraph Optimization["Optimization"]
        RO["Risk Optimization"]
        YO["Yield Optimization"]
        DO["Diversification"]
    end

    %% Transfer
    subgraph Transfer["Transfer Process"]
        BT["Bundle Transfer"]
        BP["Process Transfer"]
        BS["Settlement"]
    end

    %% Relationships
    BundleCreation --> Optimization
    Optimization --> Transfer
    
    %% Apply styles
    class BundleCreation creation
    class Optimization optimization
    class Transfer transfer
    class BC,BA,BV,RO,YO,DO,BT,BP,BS node

Diagram: Bundle integration, showing how bundles are created, optimized for risk/yield/diversification, and transferred or settled in the system.

Integration Checklist

The checklist below summarizes the key steps for integrating with Riskify. Use it to track your progress and ensure all required components are set up and tested.

Step Description Required Status
1 Contract Setup ✅ Required
2 Pool Creation ✅ Required
3 Risk Integration ✅ Required
4 Oracle Setup ✅ Required
5 Monitoring ✅ Required
6 Testing ✅ Required
7 Validation ✅ Required
8 Production Deploy ✅ Required

For more details on specific modules, see the following documentation:

Core Components

Visual Guides

Integration

Next Steps

← Risk Management Technical Reference →

Need help? Join our Discord | Read our Documentation

Search concepts, APIs, pools, and integration guides.