Integrate with Digital Banking

Use this page when you integrate Backbase Digital Banking with Banking OS. It links to the Backbase IO documentation for each integration point. The following diagram shows the two mechanisms that Digital Banking and Banking OS use to exchange data: Digital Banking encompasses Foundation Services, Identity, Banking Services, Digital Investing, Digital Onboarding, Digital Lending, Flow Foundation, and Engage Services.

​

Integration methods

Digital Banking integrates with Banking OS in two ways:

• REST API: Digital Banking services call Banking OS unified APIs directly or through an adapter.
• Sync Hub (event-based): Banking OS publishes events on Sync Hub and Digital Banking services ingest them to keep local data in sync.

Not every Backbase backend service integrates with Banking OS. Some services are standalone and don’t rely on a third-party system.

​

REST API integration scenarios

Digital Banking services that use REST APIs to integrate with third-party systems define three types of integration APIs:

• Outbound: The Digital Banking service calls this API to push changes to the external system.
• Pull: The Digital Banking service calls this API to fetch updates from an external system.
• Inbound (out of scope): The Digital Banking service exposes this API. The external system pushes changes to the Digital Banking service (often through an integration service). Inbound integrations are out of scope for Banking OS. Banking OS only uses events through Sync Hub to push changes to the Digital Banking services.

Banking OS doesn’t support the outbound and pull integration APIs. It only supports its unified APIs. To integrate with Banking OS, Digital Banking services either call the unified APIs instead of their outbound or pull APIs, or they use an adapter service to mediate between those APIs.

​

Scenario 1: Integration through an adapter

The Digital Banking service calls an adapter that implements its outbound integration API and consumes the corresponding unified API in Banking OS. A Banking OS-managed connector serves the unified API. The following diagram shows this flow: The following table lists the Digital Banking services that have an adapter:

​

Scenario 2: Direct integration

The Digital Banking service directly calls the unified API in Banking OS. A Banking OS-managed connector serves the unified API. The following diagram shows this flow: The following table lists the Digital Banking services that directly call unified APIs:

​

Scenario 3: Custom adapter

The following table lists the Digital Banking services that need a custom adapter. The adapter implements their outbound or pull API and calls the Banking OS unified API. Some of these services also ship with a connector that integrates directly with an external system and doesn’t use Banking OS.

​

Sync Hub integration

The following table lists the Digital Banking services that ingest events from Sync Hub to receive data from Banking OS. For an overview of event distribution, see Sync Hub overview.

​

Not applicable or no integrations

Some Backbase backend services don’t integrate with Banking OS because Banking OS does not have unified APIs for their purpose or because they don’t rely on a third-party system.

List of services that are not applicable to Banking OS

The following table lists the Digital Banking services that have integrations that are not covered by Banking OS unified APIs. Some ship with a connector that directly integrates with an external system without Banking OS.

Domain	Capability	Service	Direct integration connectors (no Banking OS)
Foundation Services	Document Storage	contentservices	azure-blob-storage-connector (Azure content storage), s3-storage-connector (AWS S3 content storage), clamav-antivirus-connector (ClamAV antivirus)
Foundation Services	Message Delivery	communication	engage-sms-connector (Twilio), smtp-email-connector (Amazon SES, Twilio Sendgrid)
Identity	Authentication: Auth Server	auth-server	See Message Delivery (one-time password)
Identity	Authentication: External Authorization	external-authorization	Custom
Identity	Authentication: Web Authentication service	web-authentication	See Message Delivery (one-time password)
Banking Services	Approvals	approval-service	Custom (exchange integration)
Banking Services	Direct Deposit Switch	direct-deposit-switcher	atomic-connector (Atomic)
Banking Services	Financial Advice	financial-advice	Custom
Banking Services	Forex	forex	Custom
Banking Services	Limits	limit	Custom (exchange integration)
Banking Services	Positive Pay	positive-pay-ach	Custom
Banking Services	Positive Pay	positive-pay-check	Custom
Banking Services	Product Shopping: Product Directory	product-directory	Custom
Banking Services	Real-Time Communication	rtc	rtc-twilio-integrator (Twilio)
Digital Onboarding, Digital Lending, and Flow Foundation	Trade Finance	trade-finance	Custom

List of services that have no integrations

The following table lists the Digital Banking services that have no integrations:

Domain	Capability	Service
Foundation Services	Audit	audit-service
Foundation Services	Data Protection	data-protection-manager
Foundation Services	Edge Service	edge
Foundation Services	Provisioning	provisioning
Foundation Services	Remote Config	remote-config
Foundation Services	Service Discovery	registry
Identity	Authentication	login-tracker
Identity	Authentication	infinispan-server
Identity	Authentication: Auth Server	event-bridge
Identity	Authentication: Device Management service	device-management-service
Identity	Authentication: FIDO service	fido-service
Identity	Authentication: Identity Token Converter	oidc-token-converter-service
Identity	Authentication: Mobile Authentication service	mobile-authentication
Identity	Impersonation: Orchestration service	identity-orchestration
Identity	Transaction Signing: Confirmation service	confirmation
Identity	User Management: Identity Integration service	identity-integration-service
Identity	User Management: User Lifecycle service	user-lifecycle
Banking Services	Batches	mandate-manager
Banking Services	Comments	comments
Banking Services	Dashboard	dashboard
Banking Services	Employee	employee
Banking Services	Employee	employee-actions
Banking Services	Employee	servicing-templates
Banking Services	Family Banking	household-manager
Banking Services	Financial Insights	budget-planner
Banking Services	Financial Insights	income-expense-analyzer
Banking Services	Financial Insights	pocket-tailor
Banking Services	Notifications	notifications-service
Banking Services	Open Banking	ob-consents-service
Banking Services	Payments	payment-order-bulk-processor
Banking Services	Payments	payment-order-options
Banking Services	Payments	payment-synchronizer
Banking Services	Payments: File Import	file-import
Banking Services	Relationship Assignment	relationship-assignment
Banking Services	Scheduler	scheduler
Digital Onboarding, Digital Lending, and Flow Foundation	Application Center	application-management-service
Digital Onboarding, Digital Lending, and Flow Foundation	Lending Regulatory Compliance	lending-regulatory-compliance
Engage Services	Audiences	user-segment
Engage Services	Audiences	user-segments-collector
Engage Services	Engagements: Plan Orchestrator	engagement-plan-orchestrator
Engage Services	Engagements	engagement
Engage Services	Engagements	realtime-engagement-orchestrator
Engage Services	Engagements: Content Enricher	content-enricher
Engage Services	Engagements: Overlay	content-card
Engage Services	Performance Metrics	metric
Engage Services	Signal Mesh	cih-ingestion
Engage Services	Signal Mesh	ebp-cih-integration

​

Backend service inventory

Full backend service inventory

The following table lists all Digital Banking services, grouped by domain and capability with their integration scenarios (excluding Sync Hub).

Domain	Capability	Service	Banking OS integration	Direct integration connectors (no Banking OS)
Foundation Services	Audit	audit-service	No integrations	No integrations
Foundation Services	Customer Profile	customer-profile	Directly calls unified API	Custom
Foundation Services	Data Protection	data-protection-manager	No integrations	No integrations
Foundation Services	Document Storage	contentservices	N/A	azure-blob-storage-connector (Azure content storage), s3-storage-connector (AWS S3 content storage), clamav-antivirus-connector (ClamAV antivirus)
Foundation Services	Edge Service	edge	No integrations	No integrations
Foundation Services	Engagements	See Engage Services
Foundation Services	Message Delivery	communication	N/A	engage-sms-connector (Twilio), smtp-email-connector (Amazon SES, Twilio Sendgrid)
Foundation Services	Performance Metrics	See Engage Services
Foundation Services	Provisioning	provisioning	No integrations	No integrations
Foundation Services	Push Notifications	push-integration-service	N/A	This service is a connector that directly integrates with Apple Push Notification service, Firebase Cloud Messaging, and Huawei Push Kit
Foundation Services	Remote Config	remote-config	No integrations	No integrations
Foundation Services	Service Discovery	registry	No integrations	No integrations
Identity	Authentication	login-tracker	No integrations	No integrations
Identity	Authentication	infinispan-server	No integrations	No integrations
Identity	Authentication: Auth Server	auth-server	N/A	See Message Delivery (one-time password)
Identity	Authentication: Auth Server	event-bridge	No integrations	No integrations
Identity	Authentication: Device Management service	device-management-service	No integrations	No integrations
Identity	Authentication: External Authorization	external-authorization	N/A	Custom
Identity	Authentication: FIDO service	fido-service	No integrations	No integrations
Identity	Authentication: Identity Token Converter	oidc-token-converter-service	No integrations	No integrations
Identity	Authentication: Mobile Authentication service	mobile-authentication	No integrations	No integrations
Identity	Authentication: Web Authentication service	web-authentication	N/A	See Message Delivery (one-time password)
Identity	Impersonation: Orchestration service	identity-orchestration	No integrations	No integrations
Identity	Self-Enrollment	enrollment-manager	enrollment-support-integration (Configure the Enrollment Support integration service)	Custom
Identity	Transaction Signing: Confirmation service	confirmation	No integrations	No integrations
Identity	User Management: Address Autocomplete service	address-autocomplete	N/A	This service is a connector that directly integrates with Smarty
Identity	User Management: Identity Integration service	identity-integration-service	No integrations	No integrations
Identity	User Management: User Lifecycle service	user-lifecycle	No integrations	No integrations
Identity	User Management: User Manager service	user-manager	user-profile-integration (Configure the User Profile integration service)	Custom
Identity	User Management: User Profile Manager service	user-profile-manager	Custom	Custom
Banking Services	Access Control	access-control	legalentity-integration (Develop the legal entity outbound integration service)	Custom
Banking Services	Account Statements	account-statement	Custom	Custom
Banking Services	Accounts and Transactions: Accounts	arrangement-manager	arrangement-integration (Accounts reference)	Custom
Banking Services	Accounts and Transactions: External Account Aggregation	external-account-aggregator	N/A	This service is a connector that directly integrates with Yodlee and it can use payveris for integration with Paymentus
Banking Services	Accounts and Transactions: External Account Aggregation	financial-institution-manager	N/A	This service is a connector that directly integrates with Yodlee
Banking Services	Accounts and Transactions: Transactions	transaction-manager	transaction-integration (core banking system, Transactions reference), custom (enrichment)	Custom (core banking system), transaction-enricher (enrichment with MX, SaltEdge, or Yodlee)
Banking Services	Appointments	appointment	Custom	appointment-jrni-integrator (JRNI)
Banking Services	Approvals	approval-service	N/A	Custom (exchange integration)
Banking Services	Batches	mandate-manager	No integrations	No integrations
Banking Services	Batches	payment-batch	Custom	Custom
Banking Services	Bill Pay	billpay-integrator	Custom	billpay-integration-payveris-service, payveris (Paymentus)
Banking Services	Calendar	bank-calendar	Custom	Custom
Banking Services	Card Management	card-manager	Custom	entrust-card-connector (Entrust)
Banking Services	Certificates of Deposit	term-deposit-manager (part of Local Bundles)	Directly calls unified API	Custom
Banking Services	Comments	comments	No integrations	No integrations
Banking Services	Contacts	beneficiary-validation-service	N/A	This service is a connector that directly integrates with Mambu or with a custom integration service
Banking Services	Contacts	contact-manager	Custom (contact store), directly calls unified API (verification of payee)	Custom (contact store)
Banking Services	Credit Cards	credit-cards	No integrations through API, only through events	No integrations
Banking Services	Credit Score	savvy-money-credit-scorer	N/A	This service is a connector that directly integrates with SavvyMoney
Banking Services	Dashboard	dashboard	No integrations	No integrations
Banking Services	Direct Deposit Switch	direct-deposit-switcher	N/A	atomic-connector (Atomic)
Banking Services	Employee	employee	No integrations	No integrations
Banking Services	Employee	employee-actions	No integrations	No integrations
Banking Services	Employee	servicing-templates	No integrations	No integrations
Banking Services	Family Banking	household-manager	No integrations	No integrations
Banking Services	Family Banking: Deposit Account Management	deposit-account-management	Directly calls unified API	Custom
Banking Services	Financial Advice	financial-advice	N/A	Custom
Banking Services	Financial Insights	budget-planner	No integrations	No integrations
Banking Services	Financial Insights	financial-picture	Custom	Custom
Banking Services	Financial Insights	income-expense-analyzer	No integrations	No integrations
Banking Services	Financial Insights	pocket-tailor	No integrations	No integrations
Banking Services	Financial Insights	transaction-category-collector	Custom (inbound only)	Custom (inbound only)
Banking Services	Forex	forex	N/A	Custom
Banking Services	Information Reporting	information-reporting	N/A	Relies on PowerBI, Databricks, and Azure Data Lake
Banking Services	Limits	limit	N/A	Custom (exchange integration)
Banking Services	Loans	loan	loan-integration (Loans setup (integration mode))	Custom
Banking Services	Messages	messages-service	Custom (inbound only)	Custom (inbound only)
Banking Services	Notifications	notifications-service	No integrations	No integrations
Banking Services	Open Banking	ob-consents-service	No integrations	No integrations
Banking Services	Payments	payment-order-a2a	N/A	payveris (Paymentus)
Banking Services	Payments	payment-order-bulk-processor	No integrations	No integrations
Banking Services	Payments	payment-order-options	No integrations	No integrations
Banking Services	Payments	payment-order-service	payment-integration (Payments reference)	payveris-p2p-integrator, payveris (Paymentus)
Banking Services	Payments	payment-synchronizer	No integrations	No integrations
Banking Services	Payments: Vendor	customer-provider-integrator	Custom	payveris (Paymentus)
Banking Services	Payments: File Import	file-import	No integrations	No integrations
Banking Services	Positive Pay	positive-pay-ach	N/A	Custom
Banking Services	Positive Pay	positive-pay-check	N/A	Custom
Banking Services	Product Shopping: Product Directory	product-directory	N/A	Custom
Banking Services	Product Shopping: Product Matching	product-matching	Custom	Custom
Banking Services	Real-Time Communication	rtc	N/A	rtc-twilio-integrator (Twilio)
Banking Services	Relationship Assignment	relationship-assignment	No integrations	No integrations
Banking Services	Remote Deposit Capture	remote-deposit-capturer	N/A	This service is a connector that directly integrates with Ensenta
Banking Services	Scheduler	scheduler	No integrations	No integrations
Banking Services	Tailored Value Proposition	plan-manager	Custom (inbound only)	Custom (inbound only)
Digital Investing	Investment	investment	Custom	Custom
Digital Onboarding, Digital Lending, and Flow Foundation	Application Center	application-management-service	No integrations	No integrations
Digital Onboarding, Digital Lending, and Flow Foundation	Integrated Account Opening	party-profile-service	Directly calls unified API	Custom
Digital Onboarding, Digital Lending, and Flow Foundation	Lending Regulatory Compliance	lending-regulatory-compliance	No integrations	No integrations
Digital Onboarding, Digital Lending, and Flow Foundation	Trade Finance	trade-finance	N/A	Custom
Engage Services	Audiences	user-segment	No integrations	No integrations
Engage Services	Audiences	user-segments-collector	No integrations	No integrations
Engage Services	Engagements: Plan Orchestrator	engagement-plan-orchestrator	No integrations	No integrations
Engage Services	Engagements	engagement	No integrations	No integrations
Engage Services	Engagements	realtime-engagement-orchestrator	No integrations	No integrations
Engage Services	Engagements: Content Enricher	content-enricher	No integrations	No integrations
Engage Services	Engagements: Overlay	content-card	No integrations	No integrations
Engage Services	Performance Metrics	metric	No integrations	No integrations
Engage Services	Performance Metrics: WhatsApp Connector	whatsapp-connector	N/A	This service is a connector that integrates with WhatsApp through Twilio
Engage Services	Signal Mesh	cih-ingestion	No integrations	No integrations
Engage Services	Signal Mesh	cih-segmentation	N/A	Relies on ElasticSearch or OpenSearch
Engage Services	Signal Mesh	customer-intelligence-hub	N/A	Relies on ElasticSearch or OpenSearch
Engage Services	Signal Mesh	ebp-cih-integration	No integrations	No integrations

​

Related topics

• Banking OS: platform overview and connector catalog
• Architecture: how Engagement Banking Platform services connect to Banking OS
• Sync Hub overview: event distribution between Banking OS and Digital Banking
• API playground: vendor-neutral API contracts for connectors
• HTTP Grand Central communication: synchronous HTTP calls from Engagement Banking Platform services to Banking OS (Backbase IO, login required)