Integration journey · Step 5 of 5
Integration tools
Reference documentation and ready-to-use components for every building block.
Everything you need to go from this guide to an implementation: the reference documentation for the API, the open-source SDK and sample applications, the Integration Hub and the Neterium Portal.
Reference documentation
API
Complete API reference, release notes, integration examples and a sandbox against real sanctions lists. Available after registration on the Portal.
SDK
The Integration Framework: reusable Java components and sample applications, open source under the Apache License.
Integration Hub
File and message integration, mapping and batching on top of the SDK, for the lowest integration effort on the core data flow.
Portal
Configuration management, list management and reporting as a managed interface, plus your credentials and the documentation.
The Integration Framework
The Neterium Integration Framework is a structured toolkit that simplifies and accelerates the integration of the Screening API into Java applications. It removes infrastructure complexity so your team can focus on building business value instead of the technical plumbing, and it embodies the best practices described in the previous step.
The framework includes two categories of components:
- A Software Development Kit (SDK): a set of modular, reusable, production-ready components built on the Spring Framework. They implement both core technical functionality (authentication, throttling, instrumentation) and business functionality (data mapping, screening orchestration, hit handling).
- Sample applications: ready-to-run applications, available for Jetscan and Jetflow, demonstrating real-world usage of the SDK components and implementation best practices: a screening application, a throttling dashboard and an L1 alert manager.
All components, together with comprehensive documentation, are available as open source under the permissive Apache License and can be freely downloaded from GitHub. The SDK relies on the Spring Framework (Spring Boot) for configuration, dependency injection and lifecycle management, but the source code can be reused or adapted in any Java application, with or without Spring Boot.
SDK components
The components are grouped into business components, specific to Jetscan or Jetflow, and operational components shared by both.
| Business components | Jetscan | Jetflow |
|---|---|---|
| Mapping component | Maps a CSV file of name records (individuals or entities) into a JSON screening request. The number of records per request is configurable. | Maps a file of credit transfers (ISO 20022 pacs.008 or FIN MT 103) into a JSON screening request; other formats can be mapped through a configuration file. The number of transactions per request is configurable. |
| Screening component | Takes a Jetscan screening request as input, orchestrates its sending to the screener and returns the API screening response. | Takes a Jetflow screening request as input, orchestrates its sending to the screener and returns the API screening response. |
| Hit handler component | Determines whether a hit has already been encountered by comparing a checksum of the watchlist profile (included in the API response) with the checksums previously stored. New hit: the response is returned and the checksum stored. Known hit: the decision previously made is returned. | – |
| Private lists component | Maps private list data provided in CSV format into the XML OFAC SDN format required by Jetscan and Jetflow, then uploads the file. | |
| Operational components | Jetscan and Jetflow | |
| Throttling | Optimises the rate at which API requests are sent to the screening platform, ensuring controlled, stable and compliant usage of the API. | |
| Instrumentation | Collects operational data such as performance metrics, ready to be displayed for monitoring. The throttling component uses these metrics to adapt the request rate. | |
| Authentication | Manages the generation and renewal of bearer tokens, with proactive renewal (just before expiry) or lazy renewal (only when required). Authentication is fully automated. | |
Sample applications
To demonstrate how quickly the SDK components can be put to work, the framework ships with ready-to-run sample applications, available separately for Jetscan and Jetflow.
Screening application
Generates a random dataset of customer records or transactions and sends it to the screening engine, end to end through the SDK components.
Throttling dashboard
Shows the throttling component operating in real time: how the volume of screening requests is managed, controlled and limited according to predefined metrics.
L1 Alert Manager
Shows how the SDK components can be combined to implement first-level alert management, with a simple user interface to review hits.
Prerequisites
To get the most out of the framework, start with the first steps of this journey, then make sure your team is comfortable with:
- Runtime and build: Java 21, Maven 3.9 and Git installed to compile the SDK and run the sample applications.
- Frameworks and protocols: Spring 6 and Spring Boot 3, the OAuth2 protocol, OpenAPI (HTTP and JSON) and basic multi-threading principles.
- For the sample applications: basic HTML and JavaScript, and basic knowledge of MongoDB.
SDK and Integration Hub: covered functionality
The Integration Hub packages the SDK functionality into a deployable component and extends it. The table shows which capability each building block covers.
| Functionality | SDK | Integration Hub |
|---|---|---|
| Authentication and token renewal | ✓ | ✓ |
| Throttling | ✓ | ✓ |
| Mapping for Jetscan | ✓ | ✓ |
| Mapping for Jetflow | – | ✓ |
| Batching | ✓ | ✓ |
| Screening (send to API) | ✓ | ✓ |
| Delta screening (client monitoring) | – | ✓ |
| Decision re-application | ✓ | ✓ |
| Private list mapping | ✓ | – |
| API proxy | – | ✓ |
Deploying on your own infrastructure: points to consider
The Integration Hub runs as a local footprint inside your environment, unlike the API and the Portal which are fully hosted by Neterium. Before choosing it, review these topics with your infrastructure, security and compliance teams. The Product Experience team goes through them with you.
Network and infrastructure
Deployment model and zone, egress and ingress rules.
Security
Certificate management, secrets management, data handling proof, least-privilege access.
Failure behaviour
Downtime handling, network failure, on-call ownership.
Support and operations model
Install and upgrade process, monitoring scope, documentation.
Compliance and audit
Lead time to obtain sign-off, traceability of the flows.
Change management
Internal stakeholder sign-off list, rollback plan and capabilities.
Key benefits
- Faster time to production
- Reduced integration complexity
- Consistent, reliable implementations
- Simplified maintenance and scaling
Not sure which combination fits your project? Go back to the trade-off overview or talk to the Product Experience team.