Integration journey · Step 2 of 5
Integrating with the Neterium API
The shape of a Neterium integration before going into implementation detail.
The previous step explained what screening is and how Jetscan and Jetflow work. This step covers the next question: how to connect to them. It introduces the shape of a Neterium integration before the Getting started guide and the API reference go into implementation detail.
Integration covers more than the core screening flow
A Neterium integration is often scoped around a single flow: sending payment or customer data to the API and receiving a screening decision back. That core flow is necessary, but it is not sufficient. A production integration also touches five supporting flows.
- Payment / customer dataThe core screening flow: customer records or transactions are sent to the API, a screening decision comes back.
- Alert / case management dataScreening results and audit information feeding an Alert Management or Case Management system.
- Configuration managementRules, thresholds, and screening parameters.
- List managementPrivate list uploads and updates.
- Analytics / reportingScreening volumes, hit rates, and operational metrics.
- MonitoringSystem health and availability checks.
Projects that scope only the core flow tend to rediscover the other five later, once onboarding, list updates, or reporting requirements surface. Naming all six upfront sets integration scope correctly from the start.
Four ways to build the integration
The Neterium API is the constant across every integration. Three optional building blocks sit on top of it, each taking on a different share of the supporting flows:
- Full API — direct calls to the Neterium API. Maximum flexibility; all integration work — connectivity, authentication, mapping, batching, configuration, list management, and reporting — sits with the customer or partner.
- SDK — adds connectivity, authentication (including token refresh), and throttling as pre-built functionality.
- Neterium Integration Hub — adds file/message integration, mapping, and batching on top of the SDK layer.
- Neterium Portal — adds configuration management, list management, and reporting as a managed interface.
- Configuration management
- List management
- Reporting
- File / message integration
- Mapping
- Batching
- Connectivity
- Authentication, including token refresh
- Throttling
These building blocks are not mutually exclusive: a given integration can combine them, for instance using the Integration Hub for the core data flow while relying on the Portal for configuration and reporting. The Product Experience team helps evaluate and set up any combination.
Choosing the right trade-off
Each building block shifts a share of the six flows from customer/partner effort to Neterium effort. Full API keeps every flow with the customer — highest flexibility, highest integration effort. Integration Hub + Portal shifts most flows to Neterium — lowest integration effort, less direct control.
| Data flow | Full API | SDK | Integration Hub | Integration Hub + Portal |
|---|---|---|---|---|
| Payment / customer data | Customer | Mostly customer | Mostly Neterium | Mostly Neterium |
| Alert / case management data | Customer | Mostly customer | Mostly customer | Mostly customer |
| Configuration management | Customer | Mostly customer | Mostly customer | Neterium |
| List management | Customer | Mostly customer | Mostly customer | Mostly Neterium |
| Analytics / reporting | Customer | Mostly customer | Mostly customer | Mostly Neterium |
| Monitoring | Customer | Mostly customer | Mostly customer | Mostly customer |
- Customer / partner
- Mostly customer / partner
- Mostly Neterium
- Neterium
There is no universally correct choice. The right building block combination depends on the integrator's priorities — control and customization versus speed of deployment and reduced maintenance burden.
A progressive approach is also possible: start with the lowest-effort option (Integration Hub + Portal) and shift toward direct API calls over time as more control and flexibility are needed. This reduces initial project risk without committing to a final architecture upfront.
Next steps
The Product Experience team is available to help choose between these options and to support setup of whichever combination is selected. From here, the Getting started guide covers the technical detail of a Full API integration, and the Integration tools step points to the SDK, Integration Hub, and Portal documentation for each building block.