DCI Integration#

This guide is for developers integrating OpenSPP with Digital Convergence Initiative (DCI)-compliant social protection systems.

What is DCI?#

The Digital Convergence Initiative (DCI) provides API standards for interoperability between social protection systems, enabling seamless data exchange between registries, program management systems, and payment platforms.

OpenSPP implements DCI standards to enable:

Bidirectional Integration - Act as both server (exposing data) and client (consuming data)
Government Interoperability - Connect with CRVS, IBR, and other national registries
Standardized Data Exchange - Use common schemas and protocols
Asynchronous Operations - Handle high-volume data transfers efficiently

Documentation Structure#

Getting Started#

DCI Overview - Understand DCI architecture and use cases
OpenSPP as DCI Server - Expose OpenSPP registry data to external systems
OpenSPP as DCI Client - Consume data from external DCI-compliant registries
DCI Protocol Details - Deep dive into message structure, endpoints, and authentication

OpenSPP DCI Modules#

Module	Purpose	Role
`spp_dci`	Core DCI infrastructure (message envelope, signing, JWKS)	Foundation
`spp_dci_server`	Base DCI server with search/subscribe endpoints	Server
`spp_dci_server_social`	Social Registry server implementation	Server
`spp_dci_client`	Base DCI client with authentication	Client
`spp_dci_client_crvs`	CRVS client for birth/death imports	Client
`spp_dci_client_ibr`	IBR client for enrollment duplication checks	Client
`spp_dci_client_dr`	Disability Registry client	Client
`spp_dci_indicators`	DCI data integration with eligibility system	Both

Common Integration Scenarios#

As a DCI Server#

Use Case: National MIS needs to query beneficiary data from OpenSPP Social Registry.

        graph LR
    A[External MIS] -->|DCI Search Request| B[OpenSPP DCI Server]
    B -->|Query Registry| C[res.partner]
    C -->|Results| B
    B -->|DCI Response| A

See OpenSPP as DCI Server for implementation details.

As a DCI Client#

Use Case: Import birth registrations from national CRVS to create new registrants.

        graph LR
    A[OpenSPP DCI Client] -->|DCI Search Request| B[National CRVS]
    B -->|Birth Records| A
    A -->|Import| C[res.partner]

See OpenSPP as DCI Client for implementation details.

Quick Examples#

Server: Sync Search Endpoint#

# spp_dci_server/routers/registry.py
from fastapi import APIRouter, Depends
from ..schemas.search import DCISearchRequest, DCISearchResponse
from ..services.search_service import SearchService

router = APIRouter(prefix="/registry", tags=["Registry"])

@router.post("/sync/search", response_model=DCISearchResponse)
async def sync_search(
    request: DCISearchRequest,
    token: dict = Depends(verify_token),
    env = Depends(get_env)
):
    """Synchronous registry search"""
    service = SearchService(env)
    response = await service.execute_search(request)
    return response

Client: Search by Identifier#

# Using the DCI client
from odoo.addons.spp_dci_client.services.dci_client import DCIClient

# Configure data source
data_source = env['spp.dci.data.source'].browse(1)
client = DCIClient(data_source)

# Search by national ID
response = await client.search_by_identifier(
    identifier_type="urn:gov:national-id",
    identifier_value="12345678"
)

# Results in DCI Person format
persons = response.message.search_response[0].data['reg_records']

Prerequisites#

Before implementing DCI integration:

Understanding of Odoo model patterns and FastAPI
Familiarity with OAuth 2.0 and API authentication
Knowledge of async operations with queue_job
Understanding of OpenSPP registry structure (res.partner, spp.registry.id)

References#

DCI API Standards - Official DCI specifications
G2P Connect - Protocol documentation
ADR-015 - OpenSPP DCI architecture decision

OpenSPP Documentation v2.0

DCI Integration

Contents