Access Documentation

Follow the instructions below to integrate Covie Access in minutes.

Javascript SDK

Simply copy and paste the code snippet below into your website before the closing </body> tag. Make sure you move the covie-root div element into the appropriate location as this is where the embed will render.

<div id="covie-root"></div>
<script>
	window.covieReady = function() {
		CovieAccess.init({
			elementId: "covie-root",
			integrationKey: "%YOUR_INTEGRATION_KEY%",
			linkId: "",
			width: "",
			height: "",
			onInit: function (linkId) {},
			onSuccess: function (linkId, policies) {},
			onStepChange: function (linkId, step) {},
			onLinkError: function (linkId, error) {},
			hide: []
		})
	}
</script>
<script async defer src="https://access.covie.io/sdk/covie-access.js"></script>

Parameters

elementId
string
Where the embedded iframe will render
integrationKey
string
Your integration key
width, height
number
Set the desired width and height for the iframe.

Note: If either width or height is not passed, the iframe will try to determine the best size.

onInit
function
Called once the embed has initialized properly.
onSuccess
function
Called once the user has completed the linking process and selected policies.
onStepChange
function
Called on each stage transition (e.g. provider_select, login)
onLinkError
function
Called when the operation is aborted and the link cannot be completed, as well as when a user could not find their provider in the insurance provider list, and submitted a report of the issue. For missing provider reports, the "providerName" property is set.
hide
string[]
Use to hide elements of the linking process. To hide the "My provider is not listed" link at the bottom of the provider selection screen, include "missingProviderSubmission".