Skip to main content
Follow the steps in Get started with connectors before proceeding. Microsoft Dataverse access: An active Dataverse environment with the API permissions the integration needs. Network connectivity: Verify that your network routes traffic between the Dataverse environment and Banking OS Connectivity. For supported options, see Network connectivity. Environment details: You need the Dataverse service URL, including the API version, and the OAuth credentials for that environment.

​
Prepare the connector

Backbase deploys this connector. To share connectivity details and provide the environment details, follow these steps:
  1. Share connectivity details. Share connectivity details between Banking OS and Microsoft Dataverse as described in Network connectivity.
  2. Send environment details to Backbase. Send the Dataverse service URL and OAuth credentials to your Backbase support team.
  3. Register the webhook in Dataverse. Ask your Backbase support team for the callback URL, then register that URL in your Dataverse webhook configuration. Filter the events to the tables and columns you need.
For property names and defaults, see Reference.

​
Testing the connector

To use the Unified API, include your Banking OS subscription key in the request header. If you don’t have a key, contact your Backbase support team to request one. Test the API using the Postman collection.
Webhook registration: To process asynchronous updates, register your environment callback URL in your Dataverse webhook configuration.

​
Troubleshooting

If your connector isn’t responding as expected, check these common scenarios.
Cause: The Banking OS gateway cannot establish a handshake with the Microsoft Dataverse endpoint. This typically indicates an upstream service outage at Microsoft or a network routing failure.Solution: Verify the operational status of the Dataverse environment. Check the Microsoft status page or contact Microsoft support.
Cause: The request to Microsoft Dataverse exceeded the configured timeout period. This may indicate performance issues at Microsoft or network latency problems.Solution: Verify the operational status of the Dataverse environment and check for any performance degradation.
Cause: The OAuth app credentials provided during setup are incorrect, expired, or you lack the required permissions in Dataverse.Solution: Re-verify your Dataverse app registration credentials with your Microsoft administrator, and ensure you have the required permissions. Contact your Backbase support team to update the connection credentials if needed.
Cause: The party ID (Dataverse contact ID) provided in the request is invalid or does not exist in Dataverse.Solution: Verify that the party ID is a valid Dataverse contact ID. Check that the contact exists in your Dataverse environment, and that the ID format is correct.
Cause: The number of incoming requests exceeds the defined threshold for your subscription tier. This “429 Too Many Requests” response protects the stability of the Banking OS and Microsoft Dataverse infrastructure.Solution: Review your app’s request patterns to identify unexpected spikes. If you need higher throughput, contact your Backbase support team to request a higher rate limit.