
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.
Building your integration
An optional Integration Framework can be leveraged on top of the API to further simplify and accelerate implementation.
- 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.
- Integration Framework — provides an SDK with pre-built functionality for connectivity, authentication (including token refresh) and request throttling, as well as sample application components such as data mapping.
- Connectivity
- Authentication, including token refresh
- Request throttling
- Sample components such as data mapping
Next steps
The Product Experience team is available to support API integration and help customers make the most of the Integration Framework. The Getting started guide provides the technical details for a full API integration, followed by best practices covering key aspects of the integration.